View Javadoc

1   /*
2    * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.saml2.core;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.joda.time.DateTime;
22  import org.opensaml.common.SAMLObject;
23  import org.opensaml.common.xml.SAMLConstants;
24  import org.opensaml.xml.AttributeExtensibleXMLObject;
25  import org.opensaml.xml.ElementExtensibleXMLObject;
26  
27  /**
28   * SAML 2.0 Core SubjectConfirmationData.
29   */
30  public interface SubjectConfirmationData extends SAMLObject, ElementExtensibleXMLObject, AttributeExtensibleXMLObject {
31  
32      /** Element local name. */
33      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "SubjectConfirmationData";
34  
35      /** Default element name. */
36      public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20_NS, DEFAULT_ELEMENT_LOCAL_NAME,
37              SAMLConstants.SAML20_PREFIX);
38  
39      /** Local name of the XSI type. */
40      public static final String TYPE_LOCAL_NAME = "SubjectConfirmationDataType";
41  
42      /** QName of the XSI type. */
43      public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20_NS, TYPE_LOCAL_NAME,
44              SAMLConstants.SAML20_PREFIX);
45  
46      /** NotBefore attribute name. */
47      public static final String NOT_BEFORE_ATTRIB_NAME = "NotBefore";
48  
49      /** NotOnOrAfter attribute name. */
50      public static final String NOT_ON_OR_AFTER_ATTRIB_NAME = "NotOnOrAfter";
51  
52      /** Recipient attribute name. */
53      public static final String RECIPIENT_ATTRIB_NAME = "Recipient";
54  
55      /** InResponseTo attribute name. */
56      public static final String IN_RESPONSE_TO_ATTRIB_NAME = "InResponseTo";
57  
58      /** Address attribute name. */
59      public static final String ADDRESS_ATTRIB_NAME = "Address";
60  
61      /**
62       * Gets the time before which this subject is not valid.
63       * 
64       * @return the time before which this subject is not valid
65       */
66      public DateTime getNotBefore();
67  
68      /**
69       * Sets the time before which this subject is not valid.
70       * 
71       * @param newNotBefore the time before which this subject is not valid
72       */
73      public void setNotBefore(DateTime newNotBefore);
74  
75      /**
76       * Gets the time at, or after, which this subject is not valid.
77       * 
78       * @return the time at, or after, which this subject is not valid
79       */
80      public DateTime getNotOnOrAfter();
81  
82      /**
83       * Sets the time at, or after, which this subject is not valid.
84       * 
85       * @param newNotOnOrAfter the time at, or after, which this subject is not valid
86       */
87      public void setNotOnOrAfter(DateTime newNotOnOrAfter);
88  
89      /**
90       * Gets the recipient of this subject.
91       * 
92       * @return the recipient of this subject
93       */
94      public String getRecipient();
95  
96      /**
97       * Sets the recipient of this subject.
98       * 
99       * @param newRecipient the recipient of this subject
100      */
101     public void setRecipient(String newRecipient);
102 
103     /**
104      * Gets the message ID this is in response to.
105      * 
106      * @return the message ID this is in response to
107      */
108     public String getInResponseTo();
109 
110     /**
111      * Sets the message ID this is in response to.
112      * 
113      * @param newInResponseTo the message ID this is in response to
114      */
115     public void setInResponseTo(String newInResponseTo);
116 
117     /**
118      * Gets the IP address to which this information may be pressented.
119      * 
120      * @return the IP address to which this information may be pressented
121      */
122     public String getAddress();
123 
124     /**
125      * Sets the IP address to which this information may be pressented.
126      * 
127      * @param newAddress the IP address to which this information may be pressented
128      */
129     public void setAddress(String newAddress);
130 }