Package com.sun.identity.saml2.ecp
Interface ECPRequest
- All Superinterfaces:
XmlSerializable
The
ECPRequest interface defines methods for properties
required by an ECP request.-
Method Summary
Modifier and TypeMethodDescriptiongetActor()Returns value ofactorattribute.Returns theIDPListObject.Returns the value of the issuer attribute.Returns theProviderNameattribute value.Returns value ofmustUnderstandattribute.booleanReturns true if object is mutable.Returns the value of theisPassiveattribute.voidMakes this object immutable.voidSets the value ofactorattribute.voidsetIDPList(IDPList idpList) Sets theIDPListObject.voidsetIsPassive(Boolean isPassive) Sets the value of theIsPassiveattribute.voidSets the value of the issuer attribute.voidsetMustUnderstand(Boolean mustUnderstand) Sets the value of themustUnderstandattribute.voidsetProviderName(String providerName) Sets theProviderNameattribute value.Methods inherited from interface com.sun.identity.saml2.common.XmlSerializable
toDocumentFragment, toXMLString, toXMLString
-
Method Details
-
getIssuer
Issuer getIssuer()Returns the value of the issuer attribute.- Returns:
- the value of the issuer attribute
- See Also:
-
setIssuer
Sets the value of the issuer attribute.- Parameters:
issuer- the value of the issuer attribute to be set- Throws:
com.sun.identity.saml2.common.SAML2Exception- if the object is immutable- See Also:
-
getIDPList
IDPList getIDPList()Returns theIDPListObject.- Returns:
- the
IDPListobject. - See Also:
-
setIDPList
Sets theIDPListObject.- Parameters:
idpList- the newIDPListobject.- Throws:
com.sun.identity.saml2.common.SAML2Exception- if the object is immutable.- See Also:
-
isMustUnderstand
Boolean isMustUnderstand()Returns value ofmustUnderstandattribute.- Returns:
- value of
mustUnderstandattribute.
-
setMustUnderstand
Sets the value of themustUnderstandattribute.- Parameters:
mustUnderstand- the value ofmustUnderstandattribute.- Throws:
com.sun.identity.saml2.common.SAML2Exception- if the object is immutable.
-
getActor
String getActor()Returns value ofactorattribute.- Returns:
- value of
actorattribute
-
setActor
Sets the value ofactorattribute.- Parameters:
actor- the value ofactorattribute- Throws:
com.sun.identity.saml2.common.SAML2Exception- if the object is immutable.
-
getProviderName
String getProviderName()Returns theProviderNameattribute value.- Returns:
- value of the
ProviderNameattribute value. - See Also:
-
setProviderName
Sets theProviderNameattribute value.- Parameters:
providerName- value of theProviderNameattribute.- Throws:
com.sun.identity.saml2.common.SAML2Exception- if the object is immutable.- See Also:
-
isPassive
Boolean isPassive()Returns the value of theisPassiveattribute.- Returns:
- value of
isPassiveattribute.
-
setIsPassive
Sets the value of theIsPassiveattribute.- Parameters:
isPassive- value ofIsPassiveattribute.- Throws:
com.sun.identity.saml2.common.SAML2Exception- if the object is immutable.
-
makeImmutable
void makeImmutable()Makes this object immutable. -
isMutable
boolean isMutable()Returns true if object is mutable.- Returns:
- true if object is mutable.
-