|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class represents the StatusResponseType
complex type in
SAML protocol schema.
All SAML responses are of types that are derived from the
StatusResponseType
complex type. This type defines common
attributes and elements that are associated with all SAML responses.
<complexType name="StatusResponseType"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}Issuer" minOccurs="0"/> <element ref="{http://www.w3.org/2000/09/xmldsig#}Signature" minOccurs="0"/> <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Extensions" minOccurs="0"/> <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Status"/> </sequence> <attribute name="Consent" type="{http://www.w3.org/2001/XMLSchema}anyURI" /> <attribute name="Destination" type="{http://www.w3.org/2001/XMLSchema}anyURI" /> <attribute name="ID" use="required" type="{http://www.w3.org/2001/XMLSchema}ID" /> <attribute name="InResponseTo" type="{http://www.w3.org/2001/XMLSchema}NCName" /> <attribute name="IssueInstant" use="required" type="{http://www.w3.org/2001/XMLSchema}dateTime" /> <attribute name="Version" use="required" type="{http://www.w3.org/2001/XMLSchema}string" /> </restriction> </complexContent> </complexType>
Method Summary | |
java.lang.String |
getConsent()
Returns the value of the consent property. |
java.lang.String |
getDestination()
Returns the value of the destination property. |
Extensions |
getExtensions()
Returns the value of the extensions property. |
java.lang.String |
getID()
Returns the value of the id property. |
java.lang.String |
getInResponseTo()
Returns the value of the inResponseTo property. |
java.util.Date |
getIssueInstant()
Returns the value of the issueInstant property. |
Issuer |
getIssuer()
Returns the value of the issuer property. |
java.lang.String |
getSignature()
Returns the signature element, the StatusResponse contains
as String . |
Status |
getStatus()
Returns the value of the status property. |
java.lang.String |
getVersion()
Returns the value of the version property. |
boolean |
isMutable()
Returns true if the object is mutable, false otherwise |
boolean |
isSignatureValid(java.security.cert.X509Certificate senderCert)
Returns whether the signature on the StatusResponse
is valid or not. |
boolean |
isSigned()
Returns whether the StatusResponse is signed or not. |
void |
makeImmutable()
Makes the obejct immutable |
void |
setConsent(java.lang.String value)
Sets the value of the consent property. |
void |
setDestination(java.lang.String value)
Sets the value of the destination property. |
void |
setExtensions(Extensions value)
Sets the value of the extensions property. |
void |
setID(java.lang.String value)
Sets the value of the id property. |
void |
setInResponseTo(java.lang.String value)
Sets the value of the inResponseTo property. |
void |
setIssueInstant(java.util.Date value)
Sets the value of the issueInstant property. |
void |
setIssuer(Issuer value)
Sets the value of the issuer property. |
void |
setStatus(Status value)
Sets the value of the status property. |
void |
setVersion(java.lang.String value)
Sets the value of the version property. |
void |
sign(java.security.PrivateKey privateKey,
java.security.cert.X509Certificate cert)
Signs the StatusResponse . |
java.lang.String |
toXMLString()
Returns the StatusResponse in an XML document String format
based on the StatusResponse schema described above. |
java.lang.String |
toXMLString(boolean includeNSPrefix,
boolean declareNS)
Returns the StatusResponse in an XML document String format
based on the StatusResponse schema described above. |
Method Detail |
public java.lang.String getVersion()
setVersion(String)
public void setVersion(java.lang.String value) throws SAML2Exception
value
- the value of the version property to be set
SAML2Exception
- if the object is immutablegetVersion()
public java.util.Date getIssueInstant()
setIssueInstant(java.util.Date)
public void setIssueInstant(java.util.Date value) throws SAML2Exception
value
- the value of the issueInstant property to be set
SAML2Exception
- if the object is immutablegetIssueInstant()
public java.lang.String getDestination()
setDestination(String)
public void setDestination(java.lang.String value) throws SAML2Exception
value
- the value of the destination property to be set
SAML2Exception
- if the object is immutablegetDestination()
public java.lang.String getSignature()
StatusResponse
contains
as String
.
It returns null if the StatusResponse
has no signature.
String
representation of the signature.public Extensions getExtensions()
setExtensions(Extensions)
public void setExtensions(Extensions value) throws SAML2Exception
value
- the value of the extensions property to be set
SAML2Exception
- if the object is immutablegetExtensions()
public java.lang.String getConsent()
setConsent(String)
public void setConsent(java.lang.String value) throws SAML2Exception
value
- the value of the consent property to be set
SAML2Exception
- if the object is immutablegetConsent()
public java.lang.String getInResponseTo()
setInResponseTo(String)
public void setInResponseTo(java.lang.String value) throws SAML2Exception
value
- the value of the inResponseTo property to be set
SAML2Exception
- if the object is immutablegetInResponseTo()
public Status getStatus()
setStatus(Status)
public void setStatus(Status value) throws SAML2Exception
value
- the value of the status property to be set
SAML2Exception
- if the object is immutablegetStatus()
public java.lang.String getID()
setID(String)
public void setID(java.lang.String value) throws SAML2Exception
value
- the value of the id property to be set
SAML2Exception
- if the object is immutablegetID()
public Issuer getIssuer()
setIssuer(Issuer)
public void setIssuer(Issuer value) throws SAML2Exception
value
- the value of the issuer property to be set
SAML2Exception
- if the object is immutablegetIssuer()
public boolean isSigned()
StatusResponse
is signed or not.
StatusResponse
is signed;
false otherwise.public boolean isSignatureValid(java.security.cert.X509Certificate senderCert) throws SAML2Exception
StatusResponse
is valid or not.
senderCert
- Certificate containing the public key
which may be used for signature verification;
This certificate may also may be used to check
against the certificate included in the signature
SAML2Exception
- if the signature could not be verifiedpublic void sign(java.security.PrivateKey privateKey, java.security.cert.X509Certificate cert) throws SAML2Exception
StatusResponse
.
privateKey
- Signing keycert
- Certificate which contain the public key correlated to
the signing key; It if is not null, then the signature
will include the certificate; Otherwise, the signature
will not include any certificate.
SAML2Exception
- if it could not sign the StatusResponse.public java.lang.String toXMLString() throws SAML2Exception
StatusResponse
in an XML document String format
based on the StatusResponse
schema described above.
StatusResponse
.
SAML2Exception
- if some error occurs during conversion to
String
.public java.lang.String toXMLString(boolean includeNSPrefix, boolean declareNS) throws SAML2Exception
StatusResponse
in an XML document String format
based on the StatusResponse
schema described above.
includeNSPrefix
- 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.
StatusResponse
.
SAML2Exception
- if some error occurs during conversion to
String
.public void makeImmutable()
public boolean isMutable()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |