com.sun.identity.saml2.protocol
インタフェース RequestAbstract

既知のサブインタフェースの一覧:

ArtifactResolve, AssertionIDRequest, AttributeQuery, AuthnQuery, AuthnRequest, LogoutRequest, ManageNameIDRequest, NameIDMappingRequest, SubjectQueryAbstract, XACMLAuthzDecisionQuery

既知の実装クラスの一覧:

RequestAbstractImpl, XACMLAuthzDecisionQueryImpl

public interface RequestAbstract

This interface defines methods for setting and retrieving attributes and elements associated with a SAML request message used in SAML protocols.

メソッドの概要

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.

メソッドの詳細

setIssuer

void setIssuer(Issuer nameID)
               throws SAML2Exception

Sets the Issuer object.

パラメータ:

nameID - the new Issuer object.

例外:

SAML2Exception - if the object is immutable.

関連項目:

RequestAbstract.getIssuer()

getIssuer

Issuer getIssuer()

Returns the Issuer Object.

戻り値:

the Issuer object.

関連項目:

RequestAbstract.setIssuer(Issuer)

getSignature

String getSignature()

Returns the Signature Object as a string.

戻り値:

the Signature object as a string.

sign

void sign(PrivateKey privateKey,
          X509Certificate cert)
          throws SAML2Exception

Signs the Request.

パラメータ:

privateKey - Signing key

cert - 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.

setExtensions

void setExtensions(Extensions extensions)
                   throws SAML2Exception

Sets the Extensions Object.

パラメータ:

extensions - the Extensions object.

例外:

SAML2Exception - if the object is immutable.

関連項目:

RequestAbstract.getExtensions()

getExtensions

Extensions getExtensions()

Returns the Extensions Object.

戻り値:

the Extensions object.

関連項目:

RequestAbstract.setExtensions(Extensions)

setID

void setID(String id)
           throws SAML2Exception

Sets the value of the ID attribute.

パラメータ:

id - the new value of ID attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

RequestAbstract.getID()

getID

String getID()

Returns the value of the ID attribute.

戻り値:

the value of ID attribute.

関連項目:

RequestAbstract.setID(String)

setVersion

void setVersion(String version)
                throws SAML2Exception

Sets the value of the Version attribute.

パラメータ:

version - the value of Version attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

RequestAbstract.getVersion()

getVersion

String getVersion()

Returns the value of the Version attribute.

戻り値:

value of Version attribute.

関連項目:

RequestAbstract.setVersion(String)

setIssueInstant

void setIssueInstant(Date dateTime)
                     throws SAML2Exception

Sets the value of IssueInstant attribute.

パラメータ:

dateTime - new value of the IssueInstant attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

RequestAbstract.getIssueInstant()

getIssueInstant

Date getIssueInstant()

Returns the value of IssueInstant attribute.

戻り値:

value of the IssueInstant attribute.

関連項目:

RequestAbstract.setIssueInstant(Date)

setDestination

void setDestination(String destinationURI)
                    throws SAML2Exception

Sets the value of the Destination attribute.

パラメータ:

destinationURI - new value of Destination attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

RequestAbstract.getDestination()

getDestination

String getDestination()

Returns the value of the Destination attribute.

戻り値:

the value of Destination attribute.

関連項目:

RequestAbstract.setDestination(String)

setConsent

void setConsent(String consent)
                throws SAML2Exception

Sets the value of the Consent attribute.

パラメータ:

consent - new value of Consent attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

RequestAbstract.getConsent()

getConsent

String getConsent()

Returns the value of the Consent attribute.

戻り値:

value of Consent attribute.

関連項目:

RequestAbstract.setConsent(String)

isSigned

boolean isSigned()

Returns true if message is signed.

戻り値:

true if message is signed.

isSignatureValid

boolean isSignatureValid(X509Certificate senderCert)
                         throws SAML2Exception

Return whether the signature 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

戻り値:

true if the signature is valid; false otherwise.

例外:

SAML2Exception - if the signature could not be verified

toXMLString

String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

戻り値:

a String representation of this Object.

例外:

SAML2Exception - if it could not create String object

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
                   throws SAML2Exception

Returns a String representation of this Object.

パラメータ:

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.

戻り値:

a String representation of this Object.

例外:

SAML2Exception - if it could not create String object.

makeImmutable

void makeImmutable()

Makes this object immutable.

isMutable

boolean isMutable()

Returns true if object is mutable.

戻り値:

true if object is mutable.