com.sun.identity.saml2.ecp

Interface ECPRequest

public interface ECPRequest

The ECPRequest interface defines methods for properties required by an ECP request.

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 of this Object.

Method Detail

getIssuer

Issuer getIssuer()

Returns the value of the issuer attribute.

Returns:

the value of the issuer attribute

See Also:

ECPRequest.setIssuer(Issuer)

setIssuer

void setIssuer(Issuer issuer)
        throws SAML2Exception

Sets the value of the issuer attribute.

Parameters:

issuer - the value of the issuer attribute to be set

Throws:

SAML2Exception - if the object is immutable

See Also:

ECPRequest.getIssuer()

getIDPList

IDPList getIDPList()

Returns the IDPList Object.

Returns:

the IDPList object.

See Also:

ECPRequest.setIDPList(IDPList)

setIDPList

void setIDPList(IDPList idpList)
         throws SAML2Exception

Sets the IDPList Object.

Parameters:

idpList - the new IDPList object.

Throws:

SAML2Exception - if the object is immutable.

See Also:

ECPRequest.getIDPList()

isMustUnderstand

Boolean isMustUnderstand()

Returns value of mustUnderstand attribute.

Returns:

value of mustUnderstand attribute.

setMustUnderstand

void setMustUnderstand(Boolean mustUnderstand)
                throws SAML2Exception

Sets the value of the mustUnderstand attribute.

Parameters:

mustUnderstand - the value of mustUnderstand attribute.

Throws:

SAML2Exception - if the object is immutable.

getActor

String getActor()

Returns value of actor attribute.

Returns:

value of actor attribute

setActor

void setActor(String actor)
       throws SAML2Exception

Sets the value of actor attribute.

Parameters:

actor - the value of actor attribute

Throws:

SAML2Exception - if the object is immutable.

getProviderName

String getProviderName()

Returns the ProviderName attribute value.

Returns:

value of the ProviderName attribute value.

See Also:

ECPRequest.setProviderName(String)

setProviderName

void setProviderName(String providerName)
              throws SAML2Exception

Sets the ProviderName attribute value.

Parameters:

providerName - value of the ProviderName attribute.

Throws:

SAML2Exception - if the object is immutable.

See Also:

ECPRequest.getProviderName()

isPassive

Boolean isPassive()

Returns the value of the isPassive attribute.

Returns:

value of isPassive attribute.

setIsPassive

void setIsPassive(Boolean isPassive)
           throws SAML2Exception

Sets the value of the IsPassive attribute.

Parameters:

isPassive - value of IsPassive attribute.

Throws:

SAML2Exception - if the object is immutable.

toXMLString

String toXMLString()
            throws SAML2Exception

Returns a String representation of this Object.

Returns:

a String representation of this Object.

Throws:

SAML2Exception - if cannot create String object.

toXMLString

String toXMLString(boolean includeNSPrefix,
                   boolean declareNS)
            throws SAML2Exception

Returns a String representation of this Object.

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:

the String representation of this Object.

Throws:

SAML2Exception - if cannot create String object.

makeImmutable

void makeImmutable()

Makes this object immutable.

isMutable

boolean isMutable()

Returns true if object is mutable.

Returns:

true if object is mutable.