Package com.sun.identity.saml.protocol

Class AbstractRequest

java.lang.Object

com.sun.identity.saml.protocol.AbstractRequest

Direct Known Subclasses:

FSAuthnRequest, FSFederationTerminationNotification, FSLogoutNotification, FSNameIdentifierMappingRequest, FSNameRegistrationRequest, Request

public abstract class AbstractRequest
extends Object

This AbstractRequest class is an abstract base class for all SAML Request in samlp namespace. It corresponds to RequestAbstractType in SAML protocol schema.

Field Summary

Fields

Modifier and Type	Field	Description
protected Date	issueInstant
protected int	majorVersion
protected int	minorVersion
protected String	requestID
protected List	respondWiths
protected Element	signature
protected boolean	signed
protected boolean	valid

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRequest()

Method Summary

Modifier and Type	Method	Description
boolean	addRespondWith(String respondWith)	Adds a RespondWith to the Request.
Date	getIssueInstant()	Returns the IssueInstant of the Request.
int	getMajorVersion()	Returns the MajorVersion of the Request.
int	getMinorVersion()	Returns the MinorVersion of the Request.
String	getRequestID()	Gets the RequestID of the Request.
List	getRespondWith()	Gets 0 or more of RespondWith in the Request.
Element	getSignature()	Gets 0 or 1 of Signature in the Request.
boolean	isSignatureValid()	Return whether the signature on the object is valid or not.
boolean	isSigned()	Return whether the object is signed or not.
boolean	setIssueInstant(Date issueInstant)	Set the IssueInstant of the Request.
void	setMajorVersion(int majorVersion)	Sets the MajorVersion of the Request.
void	setMinorVersion(int minorVersion)	Sets the MinorVersion of the Request.
boolean	setRequestID(String requestID)	Set the RequestID of the Request.
boolean	setSignature(Element elem)	Set the signature for the Request
abstract void	signXML()	An abstract method to sign the object.

Methods inherited from class java.lang.Object

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

Field Detail

respondWiths

protected List respondWiths

signature

protected Element signature

requestID

protected String requestID

majorVersion

protected int majorVersion

minorVersion

protected int minorVersion

issueInstant

protected Date issueInstant

signed

protected boolean signed

valid

protected boolean valid

Constructor Detail

AbstractRequest

protected AbstractRequest()

Method Detail

isSigned

public boolean isSigned()

Return whether the object is signed or not.

Returns:

true if the object is signed; false otherwise.

isSignatureValid

public boolean isSignatureValid()

Return whether the signature on the object is valid or not.

Returns:

true if the signature is valid; false otherwise.

signXML

public abstract void signXML()
                      throws SAMLException

An abstract method to sign the object.

Throws:

SAMLException - If could not sign the object.

getRespondWith

public List getRespondWith()

Gets 0 or more of RespondWith in the Request.

Returns:

A List of Strings.

addRespondWith

public boolean addRespondWith(String respondWith)

Adds a RespondWith to the Request.

Parameters:

respondWith - A String that needs to be added to the Request.

Returns:

true if the operation is successful.

getSignature

public Element getSignature()

Gets 0 or 1 of Signature in the Request.

Returns:

The signature Element the Request contains. It returns null if the Request has no signature.

setSignature

public boolean setSignature(Element elem)

Set the signature for the Request

Parameters:

elem - ds:Signature element

Returns:

true if the operation succeeds.

getRequestID

public String getRequestID()

Gets the RequestID of the Request.

Returns:

the RequestID of the Request.

setRequestID

public boolean setRequestID(String requestID)

Set the RequestID of the Request.

Parameters:

requestID - A String that is the RequestID attribute of the Request.

Returns:

true if the operation is successful.

getMajorVersion

public int getMajorVersion()

Returns the MajorVersion of the Request.

Returns:

The MajorVersion of the Request.

getMinorVersion

public int getMinorVersion()

Returns the MinorVersion of the Request.

Returns:

The MinorVersion of the request.

setMajorVersion

public void setMajorVersion(int majorVersion)

Sets the MajorVersion of the Request.

Parameters:

majorVersion - the intended major version for SAML Request

setMinorVersion

public void setMinorVersion(int minorVersion)

Sets the MinorVersion of the Request.

Parameters:

minorVersion - the intended minor version for SAML Request

getIssueInstant

public Date getIssueInstant()

Returns the IssueInstant of the Request.

Returns:

the IssueInstant of the Request.

setIssueInstant

public boolean setIssueInstant(Date issueInstant)

Set the IssueInstant of the Request.

Parameters:

issueInstant - a Date object representing the time when the Request is issued.

Returns:

true if the operation succeeds.