Package com.sun.identity.saml2.protocol.impl

Class AuthnRequestImpl

java.lang.Object

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

com.sun.identity.saml2.protocol.impl.AuthnRequestImpl

All Implemented Interfaces:

AuthnRequest, RequestAbstract

public class AuthnRequestImpl
extends RequestAbstractImpl
implements AuthnRequest

The AuthnRequestImpl implements the AuthnRequest interface , defines methods for properties required by a saml request.

Field Summary

Fields inherited from class com.sun.identity.saml2.protocol.impl.RequestAbstractImpl

consent, destinationURI, elementName, extensions, isMutable, isSignatureValid, isSigned, issueInstant, nameID, publicKey, requestId, signatureString, signedXMLString, version

Constructor Summary

Constructors

Constructor	Description
AuthnRequestImpl()	Constructor to create AuthnRequest Object .
AuthnRequestImpl(String xmlString)	Constructor to create AuthnRequest Object.
AuthnRequestImpl(Element element)	Constructor to create AuthnRequest Object.

Method Summary

Modifier and Type	Method	Description
Integer	getAssertionConsumerServiceIndex()	Returns the value of the AssertionConsumerServiceIndex attribute.
String	getAssertionConsumerServiceURL()	Returns the value of the AssertionConsumerServiceURL attribute.
Integer	getAttributeConsumingServiceIndex()	Returns the value of the AttributeConsumingServiceIndex attribute.
Conditions	getConditions()	Returns the Conditions object.
NameIDPolicy	getNameIDPolicy()	Returns the NameIDPolicy object.
String	getProtocolBinding()	Returns the value of the ProtocolBinding attribute.
String	getProviderName()	Returns the ProviderName attribute value.
RequestedAuthnContext	getRequestedAuthnContext()	Returns the RequestedAuthnContext object.
Scoping	getScoping()	Returns the Scoping object.
Subject	getSubject()	Returns the Subject object.
Boolean	isForceAuthn()	Returns value of isForceAuthn attribute.
Boolean	isPassive()	Returns the value of the isPassive attribute.
void	makeImmutable()	Makes this object immutable.
protected void	parseDOMElement(Element element)	Parses the Docuemnt Element for this object.
void	setAssertionConsumerServiceIndex(Integer index)	Sets the value of the AssertionConsumerServiceIndex attribute.
void	setAssertionConsumerServiceURL(String url)	Sets the value of the AssertionConsumerServiceURL attribute.
void	setAttributeConsumingServiceIndex(Integer index)	Sets the value of the AttributeConsumingServiceIndex attribute.
void	setConditions(Conditions conditions)	Sets the Conditions object.
void	setForceAuthn(Boolean value)	Sets the value of the ForceAuthn attribute.
void	setIsPassive(Boolean value)	Sets the value of the IsPassive attribute.
void	setNameIDPolicy(NameIDPolicy nameIDPolicy)	Sets the NameIDPolicy object.
void	setProtocolBinding(String protocolBinding)	Sets the value of the ProtocolBinding attribute.
void	setProviderName(String providerName)	Sets the ProviderName attribute value.
void	setRequestedAuthnContext(RequestedAuthnContext reqAuthnContext)	Sets the RequestedAuthnContext.
void	setScoping(Scoping scoping)	Sets the Scoping object.
void	setSubject(Subject subject)	Sets the Subject object.
String	toXMLString()	Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS)	Returns a String representation

Methods inherited from class com.sun.identity.saml2.protocol.impl.RequestAbstractImpl

getAttributesString, getConsent, getDestination, getElements, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, getXMLString, isMutable, isSignatureValid, isSigned, parseDOMAttributes, parseDOMChileElements, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign, validateData, validateID, validateIssueInstant, validateVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.identity.saml2.protocol.RequestAbstract

getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, isMutable, isSignatureValid, isSigned, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign

Constructor Detail

AuthnRequestImpl

public AuthnRequestImpl()

Constructor to create AuthnRequest Object .

AuthnRequestImpl

public AuthnRequestImpl(Element element)
                 throws SAML2Exception

Constructor to create AuthnRequest Object.

Parameters:

element - the Document Element Object.

Throws:

SAML2Exception - if error creating AuthnRequest Object.

AuthnRequestImpl

public AuthnRequestImpl(String xmlString)
                 throws SAML2Exception

Constructor to create AuthnRequest Object.

Parameters:

xmlString - the XML String.

Throws:

SAML2Exception - if error creating AuthnRequest Object.

Method Detail

getSubject

public Subject getSubject()

Returns the Subject object.

Specified by:

getSubject in interface AuthnRequest

Returns:

the Subject object.

See Also:

setSubject(Subject)

setSubject

public void setSubject(Subject subject)
                throws SAML2Exception

Sets the Subject object.

Specified by:

setSubject in interface AuthnRequest

Parameters:

subject - the new Subject object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getSubject()

getNameIDPolicy

public NameIDPolicy getNameIDPolicy()

Returns the NameIDPolicy object.

Specified by:

getNameIDPolicy in interface AuthnRequest

Returns:

the NameIDPolicy object.

See Also:

setNameIDPolicy(NameIDPolicy)

setNameIDPolicy

public void setNameIDPolicy(NameIDPolicy nameIDPolicy)
                     throws SAML2Exception

Sets the NameIDPolicy object.

Specified by:

setNameIDPolicy in interface AuthnRequest

Parameters:

nameIDPolicy - the new NameIDPolicy object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getNameIDPolicy()

getConditions

public Conditions getConditions()

Returns the Conditions object.

Specified by:

getConditions in interface AuthnRequest

Returns:

the Conditions object.

See Also:

setConditions(Conditions)

setConditions

public void setConditions(Conditions conditions)
                   throws SAML2Exception

Sets the Conditions object.

Specified by:

setConditions in interface AuthnRequest

Parameters:

conditions - the new Conditions object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getConditions()

getRequestedAuthnContext

public RequestedAuthnContext getRequestedAuthnContext()

Returns the RequestedAuthnContext object.

Specified by:

getRequestedAuthnContext in interface AuthnRequest

Returns:

the RequestAuthnContext object.

See Also:

setRequestedAuthnContext(RequestedAuthnContext)

setRequestedAuthnContext

public void setRequestedAuthnContext(RequestedAuthnContext reqAuthnContext)
                              throws SAML2Exception

Sets the RequestedAuthnContext.

Specified by:

setRequestedAuthnContext in interface AuthnRequest

Parameters:

reqAuthnContext - the new RequestedAuthnContext object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getRequestedAuthnContext()

setScoping

public void setScoping(Scoping scoping)
                throws SAML2Exception

Sets the Scoping object.

Specified by:

setScoping in interface AuthnRequest

Parameters:

scoping - the new Scoping Object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getScoping()

getScoping

public Scoping getScoping()

Returns the Scoping object.

Specified by:

getScoping in interface AuthnRequest

Returns:

the Scoping object.

See Also:

setScoping(Scoping)

isForceAuthn

public Boolean isForceAuthn()

Returns value of isForceAuthn attribute.

Specified by:

isForceAuthn in interface AuthnRequest

Returns:

value of isForceAuthn attribute.

setForceAuthn

public void setForceAuthn(Boolean value)
                   throws SAML2Exception

Sets the value of the ForceAuthn attribute.

Specified by:

setForceAuthn in interface AuthnRequest

Parameters:

value - the value of ForceAuthn attribute.

Throws:

SAML2Exception - if the object is immutable.

isPassive

public Boolean isPassive()

Returns the value of the isPassive attribute.

Specified by:

isPassive in interface AuthnRequest

Returns:

value of isPassive attribute.

setIsPassive

public void setIsPassive(Boolean value)
                  throws SAML2Exception

Sets the value of the IsPassive attribute.

Specified by:

setIsPassive in interface AuthnRequest

Parameters:

value - Value of IsPassive attribute.

Throws:

SAML2Exception - if the object is immutable.

setProtocolBinding

public void setProtocolBinding(String protocolBinding)
                        throws SAML2Exception

Sets the value of the ProtocolBinding attribute.

Specified by:

setProtocolBinding in interface AuthnRequest

Parameters:

protocolBinding - value of the ProtocolBinding attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getProtocolBinding()

getProtocolBinding

public String getProtocolBinding()

Returns the value of the ProtocolBinding attribute.

Specified by:

getProtocolBinding in interface AuthnRequest

Returns:

the value of ProtocolBinding attribute.

See Also:

setProtocolBinding(String)

getAssertionConsumerServiceURL

public String getAssertionConsumerServiceURL()

Returns the value of the AssertionConsumerServiceURL attribute.

Specified by:

getAssertionConsumerServiceURL in interface AuthnRequest

Returns:

the value of AssertionConsumerServiceURL attribute.

See Also:

setAssertionConsumerServiceURL(String)

setAssertionConsumerServiceURL

public void setAssertionConsumerServiceURL(String url)
                                    throws SAML2Exception

Sets the value of the AssertionConsumerServiceURL attribute.

Specified by:

setAssertionConsumerServiceURL in interface AuthnRequest

Parameters:

url - the value of AssertionConsumerServiceURL attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAssertionConsumerServiceURL()

getAssertionConsumerServiceIndex

public Integer getAssertionConsumerServiceIndex()

Returns the value of the AssertionConsumerServiceIndex attribute.

Specified by:

getAssertionConsumerServiceIndex in interface AuthnRequest

Returns:

value of the AssertionConsumerServiceIndex attribute.

See Also:

setAssertionConsumerServiceIndex(Integer)

setAssertionConsumerServiceIndex

public void setAssertionConsumerServiceIndex(Integer index)
                                      throws SAML2Exception

Sets the value of the AssertionConsumerServiceIndex attribute.

Specified by:

setAssertionConsumerServiceIndex in interface AuthnRequest

Parameters:

index - value of the AssertionConsumerServiceIndex attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAssertionConsumerServiceIndex()

getAttributeConsumingServiceIndex

public Integer getAttributeConsumingServiceIndex()

Returns the value of the AttributeConsumingServiceIndex attribute.

Specified by:

getAttributeConsumingServiceIndex in interface AuthnRequest

Returns:

value of the AttributeConsumingServiceIndex attribute.

See Also:

setAttributeConsumingServiceIndex(Integer)

setAttributeConsumingServiceIndex

public void setAttributeConsumingServiceIndex(Integer index)
                                       throws SAML2Exception

Sets the value of the AttributeConsumingServiceIndex attribute.

Specified by:

setAttributeConsumingServiceIndex in interface AuthnRequest

Parameters:

index - value of the AttributeConsumingServiceIndex attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getAttributeConsumingServiceIndex()

setProviderName

public void setProviderName(String providerName)
                     throws SAML2Exception

Sets the ProviderName attribute value.

Specified by:

setProviderName in interface AuthnRequest

Parameters:

providerName - value of the ProviderName attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getProviderName()

getProviderName

public String getProviderName()

Returns the ProviderName attribute value.

Specified by:

getProviderName in interface AuthnRequest

Returns:

value of the ProviderName attribute value.

See Also:

setProviderName(String)

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface RequestAbstract

Overrides:

toXMLString in class RequestAbstractImpl

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

Specified by:

toXMLString in interface RequestAbstract

Overrides:

toXMLString in class RequestAbstractImpl

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.

makeImmutable

public void makeImmutable()

Makes this object immutable.

Specified by:

makeImmutable in interface RequestAbstract

Overrides:

makeImmutable in class RequestAbstractImpl

parseDOMElement

protected void parseDOMElement(Element element)
                        throws SAML2Exception

Parses the Docuemnt Element for this object.

Overrides:

parseDOMElement in class RequestAbstractImpl

Parameters:

element - the Document Element of this object.

Throws:

SAML2Exception - if error parsing the Document Element.