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  /**
18   * 
19   */
20  package org.opensaml.saml1.core;
21  
22  import java.util.List;
23  
24  import org.joda.time.DateTime;
25  import org.opensaml.common.SAMLVersion;
26  import org.opensaml.common.SignableSAMLObject;
27  
28  /**
29   * This interface describes the base class for types derived from
30   * <code> RequestAbstractType </code>
31   */
32  public interface RequestAbstractType extends SignableSAMLObject {
33  
34      /** Name for the attribute which defines the Major Version (which must be "1". */
35      public final static String MAJORVERSION_ATTRIB_NAME = "MajorVersion";
36  
37      /** Name for the attribute which defines the Minor Version. */
38      public final static String MINORVERSION_ATTRIB_NAME = "MinorVersion";
39  
40      /** Name for the attribute which defines the Issue Instant. */
41      public final static String ISSUEINSTANT_ATTRIB_NAME = "IssueInstant";
42  
43      /** Name for the attribute which defines the Issue Instant. */
44      public final static String ID_ATTRIB_NAME = "RequestID";
45  
46      /**
47       * Gets the major version of this SAML message.
48       * 
49       * @return the major version of this SAML message
50       */
51      public int getMajorVersion();
52      
53      /**
54       * Gets the minor version of this SAML message.
55       * 
56       * @return the minor version of this SAML message
57       */
58      public int getMinorVersion();
59      
60      public void setVersion(SAMLVersion version);
61        
62      /** Get the issue instant */
63      public DateTime getIssueInstant();
64   
65      /** Get the ID */
66      public String getID();
67      
68      /** Set the ID */
69      public void setID(String id);
70      
71      /** Set the issue instant */
72      public void setIssueInstant(DateTime date);
73   
74      /** Return the list of RespondWith elements */
75      public List <RespondWith> getRespondWiths();
76  }