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  
21  package org.opensaml.saml2.core;
22  
23  import javax.xml.namespace.QName;
24  
25  import org.opensaml.common.SAMLObject;
26  import org.opensaml.common.xml.SAMLConstants;
27  
28  /**
29   * SAML 2.0 Core SessionIndex.
30   */
31  public interface SessionIndex extends SAMLObject {
32  
33      /** Element local name. */
34      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "SessionIndex";
35  
36      /** Default element name. */
37      public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20P_NS, DEFAULT_ELEMENT_LOCAL_NAME,
38              SAMLConstants.SAML20P_PREFIX);
39  
40      /**
41       * Gets the session index value of the request.
42       * 
43       * @return the session index value of the request
44       */
45      public String getSessionIndex();
46  
47      /**
48       * Sets the session index value of the request.
49       * 
50       * @param newSessionIndex the new session index value of the request
51       */
52      public void setSessionIndex(String newSessionIndex);
53  
54  }