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: Status.java,v 1.2 2008/06/25 05:47:58 qcheng Exp $
09a5cc2cbb7b3481ab44acfc09d86e9e97bea88aDavid Luna * Portions Copyrighted 2016 ForgeRock AS.
09a5cc2cbb7b3481ab44acfc09d86e9e97bea88aDavid Lunaimport com.fasterxml.jackson.annotation.JsonTypeInfo;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterimport com.sun.identity.saml2.common.SAML2Exception;
09a5cc2cbb7b3481ab44acfc09d86e9e97bea88aDavid Lunaimport com.sun.identity.saml2.protocol.impl.StatusImpl;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This class represents the <code>StatusType</code> complex type in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * SAML protocol schema.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexType name="StatusType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusCode"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusMessage" minOccurs="0"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusDetail" minOccurs="0"/>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </sequence>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </restriction>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexContent>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * </complexType>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @supported.all.api
09a5cc2cbb7b3481ab44acfc09d86e9e97bea88aDavid Luna@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the statusCode property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of the statusCode property
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setStatusCode(StatusCode)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public com.sun.identity.saml2.protocol.StatusCode getStatusCode();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the statusCode property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the value of the statusCode property to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getStatusCode
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setStatusCode(com.sun.identity.saml2.protocol.StatusCode value)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the statusMessage property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of the statusMessage property
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setStatusMessage(String)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the statusMessage property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the value of the statusMessage property to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getStatusMessage
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public void setStatusMessage(java.lang.String value)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the value of the statusDetail property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return the value of the statusDetail property
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #setStatusDetail(StatusDetail)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public com.sun.identity.saml2.protocol.StatusDetail getStatusDetail();
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Sets the value of the statusDetail property.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param value the value of the statusDetail property to be set
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if the object is immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @see #getStatusDetail
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster com.sun.identity.saml2.protocol.StatusDetail value)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>Status</code> in an XML document String format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * based on the <code>Status</code> schema described above.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return An XML String representing the <code>Status</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if some error occurs during conversion to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>String</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString() throws SAML2Exception;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns the <code>Status</code> in an XML document String format
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * based on the <code>Status</code> schema described above.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @param includeNSPrefix Determines whether or not the namespace qualifier
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * is 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 XML String representing the <code>Status</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @throws SAML2Exception if some error occurs during conversion to
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * <code>String</code>.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster public String toXMLString(boolean includeNSPrefix, boolean declareNS)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Makes the obejct immutable
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Returns true if the object is mutable, false otherwise
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * @return true if the object is mutable, false otherwise