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.saml1.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  import org.opensaml.xml.XMLObject;
30  import org.opensaml.xml.signature.KeyInfo;
31  
32  /**
33   * Interface to define how a SubjectConfirmation element behaves
34   */
35  public interface SubjectConfirmation extends SAMLObject {
36  
37      /** Element name, no namespace. */
38      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "SubjectConfirmation";
39      
40      /** Default element name */
41      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML1_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML1_PREFIX);
42      
43      /** Local name of the XSI type */
44      public final static String TYPE_LOCAL_NAME = "SubjectConfirmationType"; 
45          
46      /** QName of the XSI type */
47      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML1_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML1_PREFIX);
48  
49      /** Get the list with all the ConfirmationMethods.  This suitable for calls to add() */
50      public List<ConfirmationMethod> getConfirmationMethods();
51  
52      /** Set the SubjectConfirmationData */
53      public void setSubjectConfirmationData(XMLObject subjectConfirmationData) throws IllegalArgumentException;
54  
55      /** Return the SubjectConfirmationData */
56      public XMLObject getSubjectConfirmationData();
57      
58      /**
59       * Gets the key information for the subject.
60       * 
61       * @return the key information for the subject
62       */
63      public KeyInfo getKeyInfo();
64  
65      /**
66       * Sets the key information for the subject.
67       * 
68       * @param keyInfo the key information for the subject
69       */
70      public void setKeyInfo(KeyInfo keyInfo);
71  }