a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The contents of this file are subject to the terms
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * of the Common Development and Distribution License
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * (the License). You may not use this file except in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * compliance with the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * You can obtain a copy of the License at
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * See the License for the specific language governing
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * permission and limitations under the License.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * When distributing Covered Code, include this CDDL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Header Notice in each file and include the License file
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * If applicable, add the following below the CDDL Header,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * with the fields enclosed by brackets [] replaced by
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * your own identifying information:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $Id: SubjectConfirmationData.java,v 1.4 2008/06/25 05:47:42 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The <code>SubjectConfirmationData</code> specifies additional data
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * that allows the subject to be confirmed or constrains the circumstances
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * under which the act of subject confirmation can take place. Subject
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * confirmation takes place when a relying party seeks to verify the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * relationship between an entity presenting the assertion and the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * subject of the assertion's claims.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the time instant at which the subject can no longer be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the time instant at which the subject can no longer be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the time instant at which the subject can no longer be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the time instant at which the subject can no longer be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setNotOnOrAfter(Date value) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the ID of a SAML protocol message in response to which
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * an attesting entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the ID of a SAML protocol message in response to which
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * an attesting entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the ID of a SAML protocol message in response to which
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * an attesting entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the ID of a SAML protocol message in response to which
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * an attesting entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setInResponseTo(String value) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a list of arbitrary XML elements to be added to this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>SubjectConfirmationData</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return a list of arbitrary XML elements to be added to this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>SubjectConfirmationData</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets a list of arbitrary XML elements to be added to this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>SubjectConfirmationData</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param content a list of arbitrary XML elements to be added to this
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>SubjectConfirmationData</code> object.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setContent(List content) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the URI specifying the entity or location to which an
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attesting entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the URI specifying the entity or location to which an
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attesting entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the URI specifying the entity or location to which an
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attesting entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the URI specifying the entity or location to which an
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * attesting entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setRecipient(String value) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the time instant before which the subject cannot be confirmed
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the time instant before which the subject cannot be confirmed
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the time instant before which the subject cannot be confirmed
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the time instant before which the subject cannot be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setNotBefore(Date value) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the network address/location from which an attesting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the network address/location from which an attesting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the network address/location from which an attesting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the network address/location from which an attesting
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * entity can present the assertion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setAddress(String value) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the content type attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the content type attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setContentType(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the content type attribute
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param attribute attribute type value for the content that will be
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getContentType()
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setContentType(String attribute) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNSPrefix Determines whether or not the namespace
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * qualifier is
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * prepended to the Element when converted
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param declareNS Determines whether or not the namespace is declared
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * within the Element.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return A String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if something is wrong during conversion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString(boolean includeNSPrefix, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns a String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return A String representation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @exception SAML2Exception if something is wrong during conversion
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Makes the object immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns true if the object is mutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if the object is mutable