com.sun.identity.federation.message

Class FSRequest

java.lang.Object

com.sun.identity.saml.protocol.AbstractRequest

com.sun.identity.saml.protocol.Request

com.sun.identity.federation.message.FSRequest

Deprecated.

since 12.0.0

@Deprecated
public class FSRequest
extends Request

This class represents a Liberty Request. It extends from the abstract base class AbstractRequest.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FSRequest() Deprecated.
	FSRequest(Element root) Deprecated. Constructor creates a FSRequest object from a XML Document Element.
	FSRequest(String requestId, List contents) Deprecated. Constructor creates Request object.
	FSRequest(String requestId, Query query) Deprecated. Constructor creates Request object.

Method Summary

Modifier and Type	Method and Description
String	getID() Deprecated. Returns the value of id attribute.
int	getMinorVersion() Deprecated. Returns the MinorVersion.
static Request	parseXML(String xml) Deprecated. Parses the XML Document String to construct a Request object.
void	setID(String id) Deprecated. Sets the value of id attribute.
void	setMinorVersion(int version) Deprecated. Sets the MinorVersion.
String	toXMLString() Deprecated. Creates a String representation of the <samlp:Request> element.
String	toXMLString(boolean includeNS, boolean declareNS) Deprecated. Creates a String representation of the <samlp:Request> element.
String	toXMLString(boolean includeNS, boolean declareNS, boolean includeHeader) Deprecated. Creates a String representation of the <samlp:Request> element.

Methods inherited from class com.sun.identity.saml.protocol.Request

getAssertionArtifact, getAssertionIDReference, getContentType, getQuery, setSignature, signXML, toString, toString, toString

Methods inherited from class com.sun.identity.saml.protocol.AbstractRequest

addRespondWith, getIssueInstant, getMajorVersion, getRequestID, getRespondWith, getSignature, isSignatureValid, isSigned, setIssueInstant, setMajorVersion, setRequestID

Methods inherited from class java.lang.Object

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

Constructor Detail

FSRequest

protected FSRequest()

Deprecated.

FSRequest

public FSRequest(String requestId,
                 Query query)
          throws SAMLException

Deprecated.

Constructor creates Request object. This shall only be used at the client side to construct a Request object. NOTE: The content here is just the body for the Request. The constructor will add MajorVersion, MinorVersion, etc. to form a complete Request.

Parameters:

requestId - the request identifier, if this value is null then one will be generated.

query - AuthenticationQuery to be included in the Request.

Throws:

SAMLException - on error.

FSRequest

public FSRequest(String requestId,
                 List contents)
          throws SAMLException

Deprecated.

Constructor creates Request object. This shall only be used at the client side to construct a Request object. NOTE: The content here is just the body for the Request. The constructor will add MajorVersion, MinorVersion, etc. to form a complete Request.

Parameters:

requestId - the request identifier, if this value is null then one will be generated.

contents - a List of objects that are the contents of Request that the client wants to send to the server. It could be an : AuthenticationQuery, AuthorizationDecisionQuery, AttributeQuery, 1 or more AssertionIDReference, or 1 or more of AssertionArtifact.

Throws:

SAMLException - throws errors on exception.

FSRequest

public FSRequest(Element root)
          throws SAMLException

Deprecated.

Constructor creates a FSRequest object from a XML Document Element.

Parameters:

root - the XML Document Element.

Throws:

SAMLException - on error.

Method Detail

getID

public String getID()

Deprecated.

Returns the value of id attribute.

Returns:

the value of id attribute.

See Also:

FSRequest.setID(String)

setID

public void setID(String id)

Deprecated.

Sets the value of id attribute.

Parameters:

id - the value of id attribute.

See Also:

FSRequest.getID()

getMinorVersion

public int getMinorVersion()

Deprecated.

Returns the MinorVersion.

Overrides:

getMinorVersion in class AbstractRequest

Returns:

the MinorVersion.

See Also:

FSRequest.setMinorVersion(int)

setMinorVersion

public void setMinorVersion(int version)

Deprecated.

Sets the MinorVersion.

Overrides:

setMinorVersion in class AbstractRequest

Parameters:

version - the MinorVersion.

See Also:

FSRequest.getMinorVersion()

parseXML

public static Request parseXML(String xml)
                        throws SAMLException

Deprecated.

Parses the XML Document String to construct a Request object. This method shall only be used at the server side to reconstruct a Request object based on the XML document received from client.

Parameters:

xml - the XML Document string.

Returns:

the Request object.

Throws:

SAMLException - on error.

toXMLString

public String toXMLString()

Deprecated.

Creates a String representation of the <samlp:Request> element.

Returns:

a XML String representing the request.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS)

Deprecated.

Creates a String representation of the <samlp:Request> element.

Parameters:

includeNS - Determines whether or not the names pace qualifier is prepended to the Element when converted

declareNS - Determines whether or not the name space is declared within the Element.

Returns:

a string containing the valid XML for this object.

toXMLString

public String toXMLString(boolean includeNS,
                          boolean declareNS,
                          boolean includeHeader)

Deprecated.

Creates a String representation of the <samlp:Request> element.

Parameters:

includeNS - Determines whether or not the name space qualifier is prepended to the Element when converted

declareNS - Determines whether or not the name space is declared within the Element.

includeHeader - Determines whether the output include the XML declaration header.

Returns:

a string containing the valid XML for this object.