|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sun.identity.saml.protocol.StatusCode
public class StatusCode
This class represents the StatusCode
and
SubStatusCode
element. It corresponds to
samlp:StatusCodeType
in SAML protocol schema.
Constructor Summary | |
---|---|
StatusCode(Element statusCode)
Constructs an instance of StatusCode from a DOM element. |
|
StatusCode(String value)
Construct a StatusCode object from a value String. |
|
StatusCode(String value,
StatusCode subCode)
Construct a StatusCode object from a value String and a sub
StatusCode . |
Method Summary | |
---|---|
StatusCode |
getStatusCode()
Gets the sub StatusCode of the StatusCode . |
String |
getValue()
Gets the value of the StatusCode . |
void |
setStatusCode(StatusCode subcode)
Sets the sub StatusCode . |
String |
toString()
Translates the StatusCode to an XML document String
based on the SAML schema. |
String |
toString(boolean includeNS,
boolean declareNS)
Creates a String representation of the <samlp:StatusCode> element. |
Constructor Detail |
---|
public StatusCode(Element statusCode) throws SAMLException
StatusCode
from a DOM element.
statusCode
- An DOM Element that's rooted by
<StatusCode>
.
SAMLException
- when an error occurs.public StatusCode(String value, StatusCode subCode) throws SAMLException
StatusCode
object from a value String and a sub
StatusCode
.
value
- The value of the StatusCode
. This could be
prefixed by samlp:
. If it is not prefixed, or
prefixed by prefix other than samlp:
,
samlp:
will be used instead.subCode
- The optional sub StatusCode
.
SAMLException
- if value string is null, empty, or contains
wrong value.public StatusCode(String value) throws SAMLException
StatusCode
object from a value String.
value
- The value of the StatusCode
. This could be
prefixed by samlp:
. It it is not prefixed, or
prefixed by prefix other than samlp:
,
samlp:
will be used instead.
SAMLException
- if value string is null, empty, or contains
wrong value.Method Detail |
---|
public void setStatusCode(StatusCode subcode)
StatusCode
.
subcode
- StatusCode
to be included.public StatusCode getStatusCode()
StatusCode
of the StatusCode
.
StatusCode
.public String getValue()
StatusCode
.
StatusCode
.public String toString()
StatusCode
to an XML document String
based on the SAML schema.
toString
in class Object
StatusCode
.public String toString(boolean includeNS, boolean declareNS)
<samlp:StatusCode>
element.
includeNS
- Determines whether or not the namespace qualifier
is prepended to the Element when converteddeclareNS
- Determines whether or not the namespace is declared
within the Element.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |