|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines methods for setting and retrieving attributes and elements associated with a SAML request message used in SAML protocols.
Method Summary | |
java.lang.String |
getConsent()
Returns the value of the Consent attribute. |
java.lang.String |
getDestination()
Returns the value of the Destination attribute. |
Extensions |
getExtensions()
Returns the Extensions Object. |
java.lang.String |
getID()
Returns the value of the ID attribute. |
java.util.Date |
getIssueInstant()
Returns the value of IssueInstant attribute. |
Issuer |
getIssuer()
Returns the Issuer Object. |
java.lang.String |
getSignature()
Returns the Signature Object as a string. |
java.lang.String |
getVersion()
Returns the value of the Version attribute. |
boolean |
isMutable()
Returns true if object is mutable. |
boolean |
isSignatureValid(java.security.cert.X509Certificate senderCert)
Return whether the signature is valid or not. |
boolean |
isSigned()
Returns true if message is signed. |
void |
makeImmutable()
Makes this object immutable. |
void |
setConsent(java.lang.String consent)
Sets the value of the Consent attribute. |
void |
setDestination(java.lang.String destinationURI)
Sets the value of the Destination attribute. |
void |
setExtensions(Extensions extensions)
Sets the Extensions Object. |
void |
setID(java.lang.String id)
Sets the value of the ID attribute. |
void |
setIssueInstant(java.util.Date dateTime)
Sets the value of IssueInstant attribute. |
void |
setIssuer(Issuer nameID)
Sets the Issuer object. |
void |
setVersion(java.lang.String version)
Sets the value of the Version attribute. |
void |
sign(java.security.PrivateKey privateKey,
java.security.cert.X509Certificate cert)
Signs the Request. |
java.lang.String |
toXMLString()
Returns a String representation of this Object. |
java.lang.String |
toXMLString(boolean includeNSPrefix,
boolean declareNS)
Returns a String representation of this Object. |
Method Detail |
public void setIssuer(Issuer nameID) throws SAML2Exception
Issuer
object.
nameID
- the new Issuer
object.
SAML2Exception
- if the object is immutable.getIssuer()
public Issuer getIssuer()
Issuer
Object.
Issuer
object.setIssuer(Issuer)
public java.lang.String getSignature()
Signature
Object as a string.
Signature
object as a string.public void sign(java.security.PrivateKey privateKey, java.security.cert.X509Certificate cert) throws SAML2Exception
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 Request.public void setExtensions(Extensions extensions) throws SAML2Exception
Extensions
Object.
extensions
- the Extensions
object.
SAML2Exception
- if the object is immutable.getExtensions()
public Extensions getExtensions()
Extensions
Object.
Extensions
object.setExtensions(Extensions)
public void setID(java.lang.String id) throws SAML2Exception
ID
attribute.
id
- the new value of ID
attribute.
SAML2Exception
- if the object is immutable.getID()
public java.lang.String getID()
ID
attribute.
ID
attribute.setID(String)
public void setVersion(java.lang.String version) throws SAML2Exception
Version
attribute.
version
- the value of Version
attribute.
SAML2Exception
- if the object is immutable.getVersion()
public java.lang.String getVersion()
Version
attribute.
Version
attribute.setVersion(String)
public void setIssueInstant(java.util.Date dateTime) throws SAML2Exception
IssueInstant
attribute.
dateTime
- new value of the IssueInstant
attribute.
SAML2Exception
- if the object is immutable.getIssueInstant()
public java.util.Date getIssueInstant()
IssueInstant
attribute.
IssueInstant
attribute.setIssueInstant(Date)
public void setDestination(java.lang.String destinationURI) throws SAML2Exception
Destination
attribute.
destinationURI
- new value of Destination
attribute.
SAML2Exception
- if the object is immutable.getDestination()
public java.lang.String getDestination()
Destination
attribute.
Destination
attribute.setDestination(String)
public void setConsent(java.lang.String consent) throws SAML2Exception
Consent
attribute.
consent
- new value of Consent
attribute.
SAML2Exception
- if the object is immutable.getConsent()
public java.lang.String getConsent()
Consent
attribute.
Consent
attribute.setConsent(String)
public boolean isSigned()
public boolean isSignatureValid(java.security.cert.X509Certificate senderCert) throws SAML2Exception
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 java.lang.String toXMLString() throws SAML2Exception
SAML2Exception
- if it could not create String objectpublic java.lang.String toXMLString(boolean includeNSPrefix, boolean declareNS) throws SAML2Exception
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.
SAML2Exception
- if it could not create String object.public void makeImmutable()
public boolean isMutable()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |