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.saml1.core;
18  
19  import org.joda.time.DateTime;
20  import org.opensaml.common.SAMLVersion;
21  import org.opensaml.common.SignableSAMLObject;
22  
23  /**
24   * This interface defines the base class for type derived from the SAML1 <code> ResponseAbstractType </code> .
25   */
26  public interface ResponseAbstractType extends SignableSAMLObject {
27  
28      /** Name for the attribute which defines InResponseTo. */
29      public final static String INRESPONSETO_ATTRIB_NAME = "InResponseTo";
30  
31      /** Name for the attribute which defines the Major Version (which must be "1". */
32      public final static String MAJORVERSION_ATTRIB_NAME = "MajorVersion";
33  
34      /** Name for the attribute which defines the Minor Version. */
35      public final static String MINORVERSION_ATTRIB_NAME = "MinorVersion";
36  
37      /** Name for the attribute which defines the Issue Instant. */
38      public final static String ISSUEINSTANT_ATTRIB_NAME = "IssueInstant";
39  
40      /** Name for the attribute which defines the Recipient. */
41      public final static String RECIPIENT_ATTRIB_NAME = "Recipient";
42  
43      /** Name for the attribute which defines the Issue Instant. */
44      public final static String ID_ATTRIB_NAME = "ResponseID";
45  
46     /** Return the InResponseTo (attribute). */
47      String getInResponseTo();
48  
49      /** Set the InResponseTo (attribute). */
50      void setInResponseTo(String who);
51  
52      /** Get the ID */
53      public String getID();
54      
55      /** Set the ID */
56      public void setID(String id);
57      
58      /** Return the Minor Version (attribute). */
59      public int getMinorVersion();
60      
61      /**
62       * Gets the major version of this SAML message.
63       * 
64       * @return the major version of this SAML message
65       */
66      public int getMajorVersion();
67      
68      /**
69       * Sets the SAML version for this message.
70       * 
71       * @param version the SAML version for this message
72       */
73      public void setVersion(SAMLVersion version);
74  
75      /** Return the Issue Instant (attribute). */
76      public DateTime getIssueInstant();
77  
78      /** Set the Issue Instant (attribute). */
79      public void setIssueInstant(DateTime date);
80  
81      /** Return the Recipient (attribute). */
82      public String getRecipient();
83  
84      /** Set the Recipient (attribute). */
85      public void setRecipient(String recipient);
86  }