com.sun.identity.saml2.protocol.impl

Class RequestAbstractImpl

java.lang.Object

com.sun.identity.saml2.protocol.impl.RequestAbstractImpl

All Implemented Interfaces:

RequestAbstract

Direct Known Subclasses:

ArtifactResolveImpl, AssertionIDRequestImpl, AuthnRequestImpl, LogoutRequestImpl, ManageNameIDRequestImpl, NameIDMappingRequestImpl, SubjectQueryAbstractImpl, XACMLAuthzDecisionQueryImpl

public abstract class RequestAbstractImpl
extends Object
implements RequestAbstract

This abstract class defines methods for setting and retrieving attributes and elements associated with a SAML request message used in SAML protocols. This class is the base class for all SAML Requests.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	consent
protected String	destinationURI
protected String	elementName
protected Extensions	extensions
protected boolean	isMutable
protected Boolean	isSignatureValid
protected boolean	isSigned
protected Date	issueInstant
protected Issuer	nameID
protected PublicKey	publicKey
protected String	requestId
protected String	signatureString
protected String	signedXMLString
protected String	version

Constructor Summary

Constructors

Constructor and Description
RequestAbstractImpl()

Method Summary

Modifier and Type	Method and Description
protected String	getAttributesString()
String	getConsent() Sets the value of the Consent attribute.
String	getDestination() Returns the value of the Destination attribute.
protected String	getElements(boolean includeNSPrefix, boolean declareNS)
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.
protected void	getXMLString(Set namespaces, StringBuffer attrs, StringBuffer childElements, boolean includeNSPrefix, boolean declareNS)
boolean	isMutable() Returns true if object is mutable.
boolean	isSignatureValid(Set<X509Certificate> verificationCerts) Return whether the signature is valid or not.
boolean	isSigned() Returns true if message is signed.
void	makeImmutable() Makes this object immutable.
protected void	parseDOMAttributes(Element element) Parses attributes of the Docuemnt Element for this object.
protected void	parseDOMChileElements(ListIterator iter) Parses child elements of the Docuemnt Element for this object.
protected void	parseDOMElement(Element element) Parses the Docuemnt Element for this object.
void	setConsent(String consent) Sets the value of the Consent property.
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.
protected void	validateData()
protected void	validateID(String requestID)
protected void	validateIssueInstant(String issueInstantStr)
protected void	validateVersion(String version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nameID

protected Issuer nameID

extensions

protected Extensions extensions

requestId

protected String requestId

version

protected String version

issueInstant

protected Date issueInstant

destinationURI

protected String destinationURI

consent

protected String consent

isSigned

protected boolean isSigned

isSignatureValid

protected Boolean isSignatureValid

publicKey

protected PublicKey publicKey

isMutable

protected boolean isMutable

signatureString

protected String signatureString

signedXMLString

protected String signedXMLString

elementName

protected String elementName

Constructor Detail

RequestAbstractImpl

public RequestAbstractImpl()

Method Detail

setIssuer

public void setIssuer(Issuer nameID)
               throws SAML2Exception

Sets the Issuer object.

Specified by:

setIssuer in interface RequestAbstract

Parameters:

nameID - the new Issuer object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getIssuer()

getIssuer

public Issuer getIssuer()

Returns the Issuer Object.

Specified by:

getIssuer in interface RequestAbstract

Returns:

the Issuer object.

See Also:

setIssuer(Issuer)

getSignature

public String getSignature()

Returns the Signature Object as a string.

Specified by:

getSignature in interface RequestAbstract

Returns:

the Signature object as a string.

sign

public void sign(PrivateKey privateKey,
                 X509Certificate cert)
          throws SAML2Exception

Signs the Request.

Specified by:

sign in interface RequestAbstract

Parameters:

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.

Throws:

SAML2Exception - if it could not sign the Request.

setExtensions

public void setExtensions(Extensions extensions)
                   throws SAML2Exception

Sets the Extensions Object.

Specified by:

setExtensions in interface RequestAbstract

Parameters:

extensions - the Extensions object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getExtensions()

getExtensions

public Extensions getExtensions()

Returns the Extensions Object.

Specified by:

getExtensions in interface RequestAbstract

Returns:

the Extensions object.

See Also:

setExtensions(Extensions)

setID

public void setID(String id)
           throws SAML2Exception

Sets the value of the ID attribute.

Specified by:

setID in interface RequestAbstract

Parameters:

id - the new value of ID attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getID()

getID

public String getID()

Returns the value of the ID attribute.

Specified by:

getID in interface RequestAbstract

Returns:

the value of ID attribute.

See Also:

setID(String)

setVersion

public void setVersion(String version)
                throws SAML2Exception

Sets the value of the Version attribute.

Specified by:

setVersion in interface RequestAbstract

Parameters:

version - the value of Version attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getVersion()

getVersion

public String getVersion()

Returns the value of the Version attribute.

Specified by:

getVersion in interface RequestAbstract

Returns:

value of Version attribute.

See Also:

setVersion(String)

setIssueInstant

public void setIssueInstant(Date dateTime)
                     throws SAML2Exception

Sets the value of IssueInstant attribute.

Specified by:

setIssueInstant in interface RequestAbstract

Parameters:

dateTime - new value of the IssueInstant attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getIssueInstant()

getIssueInstant

public Date getIssueInstant()

Returns the value of IssueInstant attribute.

Specified by:

getIssueInstant in interface RequestAbstract

Returns:

value of the IssueInstant attribute.

See Also:

setIssueInstant(Date)

setDestination

public void setDestination(String destinationURI)
                    throws SAML2Exception

Sets the value of the Destination attribute.

Specified by:

setDestination in interface RequestAbstract

Parameters:

destinationURI - new value of Destination attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getDestination()

getDestination

public String getDestination()

Returns the value of the Destination attribute.

Specified by:

getDestination in interface RequestAbstract

Returns:

the value of Destination attribute.

See Also:

setDestination(String)

setConsent

public void setConsent(String consent)
                throws SAML2Exception

Sets the value of the Consent property.

Specified by:

setConsent in interface RequestAbstract

Parameters:

consent - , value of Consent property.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getConsent()

getConsent

public String getConsent()

Sets the value of the Consent attribute.

Specified by:

getConsent in interface RequestAbstract

Returns:

the value of Consent attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

setConsent(String)

isSigned

public boolean isSigned()

Returns true if message is signed.

Specified by:

isSigned in interface RequestAbstract

Returns:

true if message is signed.

isSignatureValid

public boolean isSignatureValid(Set<X509Certificate> verificationCerts)
                         throws SAML2Exception

Description copied from interface: RequestAbstract

Return whether the signature is valid or not.

Specified by:

isSignatureValid in interface RequestAbstract

Parameters:

verificationCerts - Certificates containing the public keys which may be used for signature verification; This certificate may also may be used to check against the certificate included in the signature.

Returns:

true if the signature is valid; false otherwise.

Throws:

SAML2Exception - if the signature could not be verified

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface RequestAbstract

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if it could not create String object

toXMLString

public String toXMLString(boolean includeNSPrefix,
                          boolean declareNS)
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface RequestAbstract

Parameters:

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.

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if it could not create String object.

getAttributesString

protected String getAttributesString()
                              throws SAML2Exception

Throws:

SAML2Exception

getElements

protected String getElements(boolean includeNSPrefix,
                             boolean declareNS)
                      throws SAML2Exception

Throws:

SAML2Exception

makeImmutable

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface RequestAbstract

isMutable

public boolean isMutable()

Returns true if object is mutable.

Specified by:

isMutable in interface RequestAbstract

Returns:

true if object is mutable.

validateID

protected void validateID(String requestID)
                   throws SAML2Exception

Throws:

SAML2Exception

validateVersion

protected void validateVersion(String version)
                        throws SAML2Exception

Throws:

SAML2Exception

validateIssueInstant

protected void validateIssueInstant(String issueInstantStr)
                             throws SAML2Exception

Throws:

SAML2Exception

validateData

protected void validateData()
                     throws SAML2Exception

Throws:

SAML2Exception

getXMLString

protected void getXMLString(Set namespaces,
                            StringBuffer attrs,
                            StringBuffer childElements,
                            boolean includeNSPrefix,
                            boolean declareNS)
                     throws SAML2Exception

Throws:

SAML2Exception

parseDOMElement

protected void parseDOMElement(Element element)
                        throws SAML2Exception

Parses the Docuemnt Element for this object.

Parameters:

element - the Document Element of this object.

Throws:

SAML2Exception - if error parsing the Document Element.

parseDOMAttributes

protected void parseDOMAttributes(Element element)
                           throws SAML2Exception

Parses attributes of the Docuemnt Element for this object.

Parameters:

element - the Document Element of this object.

Throws:

SAML2Exception - if error parsing the Document Element.

parseDOMChileElements

protected void parseDOMChileElements(ListIterator iter)
                              throws SAML2Exception

Parses child elements of the Docuemnt Element for this object.

Parameters:

iter - the child elements iterator.

Throws:

SAML2Exception - if error parsing the Document Element.