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: LogoutRequest.java,v 1.2 2008/06/25 05:47:56 qcheng Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class represents the <code>LogoutRequest</code> element in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * SAML protocol schema.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * A session participant or session authority sends a <code>LogoutRequest</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * message to indicate that a session has been terminated.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element name="LogoutRequest" type="{urn:oasis:names:tc:SAML:2.0:protocol}LogoutRequestType"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexType name="LogoutRequestType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <choice>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}BaseID"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}NameID"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedID"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </choice>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}SessionIndex" maxOccurs="unbounded" minOccurs="0"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <attribute name="NotOnOrAfter" type="{http://www.w3.org/2001/XMLSchema}dateTime" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <attribute name="Reason" type="{http://www.w3.org/2001/XMLSchema}string" />
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </extension>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextends com.sun.identity.saml2.protocol.RequestAbstract {
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the notOnOrAfter property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return <code>java.util.Date</code> value of the notOnOrAfter property
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setNotOnOrAfter(Date)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the notOnOrAfter property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value <code>java.util.Date</code> value of the notOnOrAfter
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * property to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getNotOnOrAfter
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setNotOnOrAfter(java.util.Date value) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the reason property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return <code>String</code> value of the reason property
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setReason(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the reason property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value <code>String</code> value of the reason property to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getReason
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setReason(java.lang.String value) throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the encryptedID property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of the encryptedID property
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setEncryptedID(EncryptedID)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public com.sun.identity.saml2.assertion.EncryptedID getEncryptedID();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the encryptedID property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the value of the encryptedID property to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getEncryptedID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster com.sun.identity.saml2.assertion.EncryptedID value)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the nameID property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of the nameID property
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setNameID(NameID)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public com.sun.identity.saml2.assertion.NameID getNameID();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the nameID property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the value of the nameID property to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getNameID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setNameID(com.sun.identity.saml2.assertion.NameID value)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the baseID property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of the baseID property
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setBaseID(BaseID)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public com.sun.identity.saml2.assertion.BaseID getBaseID();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the baseID property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the value of the baseID property to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getBaseID
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setBaseID(com.sun.identity.saml2.assertion.BaseID value)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the SessionIndex property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return list containing objects of type <code>java.lang.String</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setSessionIndex(List)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the SessionIndex property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param sessionIndexList list containing objects of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * type <code>java.lang.String</code>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getSessionIndex