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