com.sun.identity.saml2.ecp.impl

Class ECPRequestImpl

java.lang.Object

com.sun.identity.saml2.ecp.impl.ECPRequestImpl

All Implemented Interfaces:

ECPRequest

public class ECPRequestImpl
extends Object
implements ECPRequest

This class implements ECPRequest element. It provides all the methods required by ECPRequest

Constructor Summary

Constructors

Constructor and Description
ECPRequestImpl() Constructs the ECPRequest Object.
ECPRequestImpl(Element element) Constructs the ECPRequest Object.
ECPRequestImpl(String xmlString) Constructs the ECPRequest Object.

Method Summary

Modifier and Type	Method and Description
String	getActor() Returns value of actor attribute.
IDPList	getIDPList() Returns the IDPList Object.
Issuer	getIssuer() Returns the value of the issuer attribute.
String	getProviderName() Returns the ProviderName attribute value.
Boolean	isMustUnderstand() Returns value of mustUnderstand attribute.
boolean	isMutable() Returns true if object is mutable.
Boolean	isPassive() Returns the value of the isPassive attribute.
void	makeImmutable() Makes this object immutable.
void	setActor(String actor) Sets the value of actor attribute.
void	setIDPList(IDPList idpList) Sets the IDPList Object.
void	setIsPassive(Boolean isPassive) Sets the value of the IsPassive attribute.
void	setIssuer(Issuer issuer) Sets the value of the issuer attribute.
void	setMustUnderstand(Boolean mustUnderstand) Sets the value of the mustUnderstand attribute.
void	setProviderName(String providerName) Sets the ProviderName attribute value.
String	toXMLString() Returns a String representation of this Object.
String	toXMLString(boolean includeNSPrefix, boolean declareNS) Returns a String representation
protected void	validateData()

Methods inherited from class java.lang.Object

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

Constructor Detail

ECPRequestImpl

public ECPRequestImpl()

Constructs the ECPRequest Object.

ECPRequestImpl

public ECPRequestImpl(Element element)
               throws SAML2Exception

Constructs the ECPRequest Object.

Parameters:

element - the Document Element of ECP Request object.

Throws:

SAML2Exception - if ECPRequest cannot be created.

ECPRequestImpl

public ECPRequestImpl(String xmlString)
               throws SAML2Exception

Constructs the ECPRequest Object.

Parameters:

xmlString - the XML String representation of this object.

Throws:

SAML2Exception - if ECPRequest cannot be created.

Method Detail

getIssuer

public Issuer getIssuer()

Returns the value of the issuer attribute.

Specified by:

getIssuer in interface ECPRequest

Returns:

the value of the issuer attribute.

See Also:

setIssuer(Issuer)

setIssuer

public void setIssuer(Issuer issuer)
               throws SAML2Exception

Sets the value of the issuer attribute.

Specified by:

setIssuer in interface ECPRequest

Parameters:

issuer - the value of the issuer attribute

Throws:

SAML2Exception - if the object is immutable

See Also:

getIssuer()

getIDPList

public IDPList getIDPList()

Returns the IDPList Object.

Specified by:

getIDPList in interface ECPRequest

Returns:

the IDPList object.

See Also:

setIDPList(IDPList)

setIDPList

public void setIDPList(IDPList idpList)
                throws SAML2Exception

Sets the IDPList Object.

Specified by:

setIDPList in interface ECPRequest

Parameters:

idpList - the new IDPList object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getIDPList()

isMustUnderstand

public Boolean isMustUnderstand()

Returns value of mustUnderstand attribute.

Specified by:

isMustUnderstand in interface ECPRequest

Returns:

value of mustUnderstand attribute.

setMustUnderstand

public void setMustUnderstand(Boolean mustUnderstand)
                       throws SAML2Exception

Sets the value of the mustUnderstand attribute.

Specified by:

setMustUnderstand in interface ECPRequest

Parameters:

mustUnderstand - the value of mustUnderstand attribute.

Throws:

SAML2Exception - if the object is immutable.

getActor

public String getActor()

Returns value of actor attribute.

Specified by:

getActor in interface ECPRequest

Returns:

value of actor attribute

setActor

public void setActor(String actor)
              throws SAML2Exception

Sets the value of actor attribute.

Specified by:

setActor in interface ECPRequest

Parameters:

actor - the value of actor attribute

Throws:

SAML2Exception - if the object is immutable.

getProviderName

public String getProviderName()

Returns the ProviderName attribute value.

Specified by:

getProviderName in interface ECPRequest

Returns:

value of the ProviderName attribute value.

See Also:

setProviderName(String)

setProviderName

public void setProviderName(String providerName)
                     throws SAML2Exception

Sets the ProviderName attribute value.

Specified by:

setProviderName in interface ECPRequest

Parameters:

providerName - value of the ProviderName attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

getProviderName()

isPassive

public Boolean isPassive()

Returns the value of the isPassive attribute.

Specified by:

isPassive in interface ECPRequest

Returns:

value of isPassive attribute.

setIsPassive

public void setIsPassive(Boolean isPassive)
                  throws SAML2Exception

Sets the value of the IsPassive attribute.

Specified by:

setIsPassive in interface ECPRequest

Parameters:

isPassive - value of IsPassive attribute.

Throws:

SAML2Exception - if the object is immutable.

toXMLString

public String toXMLString()
                   throws SAML2Exception

Returns a String representation of this Object.

Specified by:

toXMLString in interface ECPRequest

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 ECPRequest

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 ECPRequest

isMutable

public boolean isMutable()

Returns true if object is mutable.

Specified by:

isMutable in interface ECPRequest

Returns:

true if object is mutable.

validateData

protected void validateData()
                     throws SAML2Exception

Throws:

SAML2Exception