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 ofactor
attribute.Returns theIDPList
Object.Returns the value of the issuer attribute.Returns theProviderName
attribute value.Returns value ofmustUnderstand
attribute.boolean
Returns true if object is mutable.Returns the value of theisPassive
attribute.void
Makes this object immutable.void
Sets the value ofactor
attribute.void
setIDPList
(IDPList idpList) Sets theIDPList
Object.void
setIsPassive
(Boolean isPassive) Sets the value of theIsPassive
attribute.void
Sets the value of the issuer attribute.void
setMustUnderstand
(Boolean mustUnderstand) Sets the value of themustUnderstand
attribute.void
setProviderName
(String providerName) Sets theProviderName
attribute 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 theIDPList
Object.- Returns:
- the
IDPList
object. - See Also:
-
setIDPList
Sets theIDPList
Object.- Parameters:
idpList
- the newIDPList
object.- Throws:
com.sun.identity.saml2.common.SAML2Exception
- if the object is immutable.- See Also:
-
isMustUnderstand
Boolean isMustUnderstand()Returns value ofmustUnderstand
attribute.- Returns:
- value of
mustUnderstand
attribute.
-
setMustUnderstand
Sets the value of themustUnderstand
attribute.- Parameters:
mustUnderstand
- the value ofmustUnderstand
attribute.- Throws:
com.sun.identity.saml2.common.SAML2Exception
- if the object is immutable.
-
getActor
String getActor()Returns value ofactor
attribute.- Returns:
- value of
actor
attribute
-
setActor
Sets the value ofactor
attribute.- Parameters:
actor
- the value ofactor
attribute- Throws:
com.sun.identity.saml2.common.SAML2Exception
- if the object is immutable.
-
getProviderName
String getProviderName()Returns theProviderName
attribute value.- Returns:
- value of the
ProviderName
attribute value. - See Also:
-
setProviderName
Sets theProviderName
attribute value.- Parameters:
providerName
- value of theProviderName
attribute.- Throws:
com.sun.identity.saml2.common.SAML2Exception
- if the object is immutable.- See Also:
-
isPassive
Boolean isPassive()Returns the value of theisPassive
attribute.- Returns:
- value of
isPassive
attribute.
-
setIsPassive
Sets the value of theIsPassive
attribute.- Parameters:
isPassive
- value ofIsPassive
attribute.- 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.
-