com.sun.identity.saml2.protocol

Interface Status

All Known Implementing Classes:

StatusImpl

public interface Status

This class represents the StatusType complex type in SAML protocol schema.

 <complexType name="StatusType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusCode"/>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusMessage" minOccurs="0"/>
         <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}StatusDetail" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Method Summary

Modifier and Type	Method and Description
StatusCode	getStatusCode() Returns the value of the statusCode property.
StatusDetail	getStatusDetail() Returns the value of the statusDetail property.
String	getStatusMessage() Returns the value of the statusMessage property.
boolean	isMutable() Returns true if the object is mutable, false otherwise
void	makeImmutable() Makes the obejct immutable
void	setStatusCode(StatusCode value) Sets the value of the statusCode property.
void	setStatusDetail(StatusDetail value) Sets the value of the statusDetail property.
void	setStatusMessage(String value) Sets the value of the statusMessage property.
String	toXMLString() Returns the Status in an XML document String format based on the Status schema described above.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns the Status in an XML document String format based on the Status schema described above.

Method Detail

getStatusCode

StatusCode getStatusCode()

Returns the value of the statusCode property.

Returns:

the value of the statusCode property

See Also:

setStatusCode(StatusCode)

setStatusCode

void setStatusCode(StatusCode value)
            throws SAML2Exception

Sets the value of the statusCode property.

Parameters:

value - the value of the statusCode property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getStatusCode()

getStatusMessage

String getStatusMessage()

Returns the value of the statusMessage property.

Returns:

the value of the statusMessage property

See Also:

setStatusMessage(String)

setStatusMessage

void setStatusMessage(String value)
               throws SAML2Exception

Sets the value of the statusMessage property.

Parameters:

value - the value of the statusMessage property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getStatusMessage()

getStatusDetail

StatusDetail getStatusDetail()

Returns the value of the statusDetail property.

Returns:

the value of the statusDetail property

See Also:

setStatusDetail(StatusDetail)

setStatusDetail

void setStatusDetail(StatusDetail value)
              throws SAML2Exception

Sets the value of the statusDetail property.

Parameters:

value - the value of the statusDetail property to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

getStatusDetail()

toXMLString

String toXMLString()
            throws SAML2Exception

Returns the Status in an XML document String format based on the Status schema described above.

Returns:

An XML String representing the Status.

Throws:

SAML2Exception - if some error occurs during conversion to String.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception

Returns the Status in an XML document String format based on the Status schema described above.

Parameters:

includeNSPrefix - Determines whether or not the namespace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the namespace is declared within the Element.

Returns:

A XML String representing the Status.

Throws:

SAML2Exception - if some error occurs during conversion to String.

makeImmutable

void makeImmutable()

Makes the obejct immutable

isMutable

boolean isMutable()

Returns true if the object is mutable, false otherwise

Returns:

true if the object is mutable, false otherwise