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 java.util.List;
24  
25  import javax.xml.namespace.QName;
26  
27  import org.opensaml.common.SAMLObject;
28  import org.opensaml.common.xml.SAMLConstants;
29  
30  /**
31   * SAML 2.0 Core RequestedAuthnContext.
32   */
33  public interface RequestedAuthnContext extends SAMLObject {
34  
35      /** Element local name. */
36      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "RequestedAuthnContext";
37  
38      /** Default element name. */
39      public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20P_NS, DEFAULT_ELEMENT_LOCAL_NAME,
40              SAMLConstants.SAML20P_PREFIX);
41  
42      /** Local name of the XSI type. */
43      public static final String TYPE_LOCAL_NAME = "ActionType";
44  
45      /** QName of the XSI type. */
46      public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME,
47              SAMLConstants.SAML20P_PREFIX);
48  
49      /** SessionIndex attribute name. */
50      public static final String COMPARISON_ATTRIB_NAME = "Comparison";
51  
52      /**
53       * Gets the Comparison attribute value of the requested authn context.
54       * 
55       * @return the Comparison attribute value of the requested authn context
56       */
57      public AuthnContextComparisonTypeEnumeration getComparison();
58  
59      /**
60       * Sets the Comparison attribute value of the requested authn context.
61       * 
62       * @param newComparison the SessionIndex of this request
63       */
64      public void setComparison(AuthnContextComparisonTypeEnumeration newComparison);
65  
66      /**
67       * Gets the AuthnContextClassRefs of this request.
68       * 
69       * @return the AuthnContextClassRefs of this request
70       */
71      public List<AuthnContextClassRef> getAuthnContextClassRefs();
72  
73      /**
74       * Gets the AuthnContextDeclRefs of this request.
75       * 
76       * @return the AuthnContextDeclRef of this request
77       */
78      public List<AuthnContextDeclRef> getAuthnContextDeclRefs();
79  
80  }