001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: SubjectConfirmation.java,v 1.2 2008/06/25 05:47:42 qcheng Exp $
026 *
027 */
028package com.sun.identity.saml2.assertion;
029
030import com.sun.identity.saml2.common.SAML2Exception;
031
032/**
033 *  The <code>SubjectConfirmation</code> provides the means for a relying 
034 *  party to verify the correspondence of the subject of the assertion
035 *  with the party with whom the relying party is communicating.
036 *
037 *  @supported.all.api
038 */
039public interface SubjectConfirmation {
040
041    /**
042     * Returns the encrypted ID
043     *
044     * @return the encrypted ID 
045     */
046    public EncryptedID getEncryptedID();
047
048    /**
049     * Sets the encrypted ID
050     *
051     * @param value the encrypted ID 
052     * @exception SAML2Exception if the object is immutable
053     */
054    public void setEncryptedID(EncryptedID value) throws SAML2Exception;
055
056    /**
057     * Returns the subject confirmation data
058     *
059     * @return the subject confirmation data 
060     */
061    public SubjectConfirmationData getSubjectConfirmationData();
062
063    /**
064     * Sets the subject confirmation data
065     *
066     * @param value the subject confirmation data 
067     * @exception SAML2Exception if the object is immutable
068     */
069    public void setSubjectConfirmationData(SubjectConfirmationData value)
070        throws SAML2Exception;
071
072    /**
073     * Returns the name identifier 
074     *
075     * @return the name identifier 
076     */
077    public NameID getNameID();
078
079    /**
080     * Sets the name identifier 
081     *
082     * @param value the name identifier 
083     * @exception SAML2Exception if the object is immutable
084     */
085    public void setNameID(NameID value) throws SAML2Exception;
086
087    /**
088     * Returns the base ID 
089     *
090     * @return the base ID 
091     */
092    public BaseID getBaseID();
093
094    /**
095     * Sets the base ID 
096     *
097     * @param value the base ID 
098     * @exception SAML2Exception if the object is immutable
099     */
100    public void setBaseID(BaseID value) throws SAML2Exception;
101
102    /**
103     * Returns the confirmation method 
104     *
105     * @return the confirmation method 
106     */
107    public String getMethod();
108
109    /**
110     * Sets the confirmation method 
111     *
112     * @param value the confirmation method 
113     * @exception SAML2Exception if the object is immutable
114     */
115    public void setMethod(String value) throws SAML2Exception;
116
117   /**
118    * Returns a String representation
119    * @param includeNSPrefix Determines whether or not the namespace
120    *        qualifier is
121    *        prepended to the Element when converted
122    * @param declareNS Determines whether or not the namespace is declared
123    *        within the Element.
124    * @return A String representation
125    * @exception SAML2Exception if something is wrong during conversion
126     */
127    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
128     throws SAML2Exception;
129
130   /**
131    * Returns a String representation
132    *
133    * @return A String representation
134    * @exception SAML2Exception if something is wrong during conversion
135    */
136    public String toXMLString() throws SAML2Exception;
137
138   /**
139    * Makes the object immutable
140    */
141    public void makeImmutable();
142
143   /**
144    * Returns true if the object is mutable
145    *
146    * @return true if the object is mutable
147    */
148    public boolean isMutable();
149
150}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.