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 java.util.List;
20  
21  import javax.xml.namespace.QName;
22  
23  import org.joda.time.DateTime;
24  import org.opensaml.common.SAMLObject;
25  import org.opensaml.common.xml.SAMLConstants;
26  
27  /**
28   * This interface defines how the object representing a SAML1 <code> AuthenticationStatment </code> element behaves.
29   */
30  public interface AuthenticationStatement extends SAMLObject, SubjectStatement {
31  
32      /** Element name, no namespace. */
33      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "AuthenticationStatement";
34      
35      /** Default element name */
36      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML1_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML1_PREFIX);
37      
38      /** Local name of the XSI type */
39      public final static String TYPE_LOCAL_NAME = "AuthenticationStatementType"; 
40          
41      /** QName of the XSI type */
42      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML1_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML1_PREFIX);
43  
44      /** Name of the AuthenticationMethod attribute */
45      public final static String AUTHENTICATIONMETHOD_ATTRIB_NAME = "AuthenticationMethod";
46  
47      /** Name of the AuthenticationInstant attribute */
48      public final static String AUTHENTICATIONINSTANT_ATTRIB_NAME = "AuthenticationInstant";
49  
50      /** Return the contents of the AuthenticationMethod attribute */
51      public String getAuthenticationMethod();
52  
53      /** Set the contents of the AuthenticationMethod attribute */
54      public void setAuthenticationMethod(String authenticationMethod);
55  
56      /** Return the contents of the AuthenticationInstant attribute */
57      public DateTime getAuthenticationInstant();
58  
59      /** Set the contents of the AuthenticationInstant attribute */
60      public void setAuthenticationInstant(DateTime authenticationInstant);
61  
62      /** Set the (single) SubjectLocality child element */
63      public SubjectLocality getSubjectLocality();
64  
65      /** Get the (single) SubjectLocality child element 
66       * @throws IllegalArgumentException */
67      public void setSubjectLocality(SubjectLocality subjectLocality) throws IllegalArgumentException;
68  
69      /** return all the AuthorityBinding subelement */
70      public List<AuthorityBinding> getAuthorityBindings();
71  
72  }