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.opensaml.common.xml.SAMLConstants;
22  
23  /**
24   * SAML 2.0 AuthnQuery.
25   */
26  public interface AuthnQuery extends SubjectQuery {
27      
28      /** Element local name. */
29      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "AuthnQuery";
30      
31      /** Default element name. */
32      public static final QName DEFAULT_ELEMENT_NAME = 
33          new QName(SAMLConstants.SAML20P_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20P_PREFIX);
34      
35      /** Local name of the XSI type. */
36      public static final String TYPE_LOCAL_NAME = "AuthnQueryType"; 
37          
38      /** QName of the XSI type. */
39      public static final QName TYPE_NAME = 
40          new QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20P_PREFIX);
41      
42      /** SessionIndex attribute name. */
43      public static final String SESSION_INDEX_ATTRIB_NAME = "SessionIndex";
44      
45      /**
46       * Gets the SessionIndex of this request.
47       * 
48       * @return the SessionIndex of this request
49       */
50      public String getSessionIndex();
51      
52      /**
53       * Sets the SessionIndex of this request.
54       * 
55       * @param newSessionIndex the SessionIndex of this request
56       */
57      public void setSessionIndex(String newSessionIndex);
58      
59      /**
60       * Gets the RequestedAuthnContext of this request.
61       * 
62       * @return the RequestedAuthnContext of this request
63       */
64      public RequestedAuthnContext getRequestedAuthnContext();
65      
66      /**
67       * Sets the RequestedAuthnContext of this request.
68       * 
69       * @param newRequestedAuthnContext the RequestedAuthnContext of this request
70       */
71      public void setRequestedAuthnContext(RequestedAuthnContext newRequestedAuthnContext);
72  
73  }