|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuthnRequest
The AuthnRequest
interface defines methods for properties
required by an authentication request.
Method Summary | |
---|---|
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 |
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. |
Methods inherited from interface com.sun.identity.saml2.protocol.RequestAbstract |
---|
getConsent, getDestination, getExtensions, getID, getIssueInstant, getIssuer, getSignature, getVersion, isMutable, isSignatureValid, isSigned, makeImmutable, setConsent, setDestination, setExtensions, setID, setIssueInstant, setIssuer, setVersion, sign, toXMLString, toXMLString |
Method Detail |
---|
Subject getSubject()
Subject
object.
Subject
object.AuthnRequest.setSubject(Subject)
void setSubject(Subject subject) throws SAML2Exception
Subject
object.
subject
- the new Subject
object.
SAML2Exception
- if the object is immutable.AuthnRequest.getSubject()
NameIDPolicy getNameIDPolicy()
NameIDPolicy
object.
NameIDPolicy
object.AuthnRequest.setNameIDPolicy(NameIDPolicy)
void setNameIDPolicy(NameIDPolicy nameIDPolicy) throws SAML2Exception
NameIDPolicy
object.
nameIDPolicy
- the new NameIDPolicy
object.
SAML2Exception
- if the object is immutable.AuthnRequest.getNameIDPolicy()
Conditions getConditions()
Conditions
object.
Conditions
object.AuthnRequest.setConditions(Conditions)
void setConditions(Conditions conditions) throws SAML2Exception
Conditions
object.
conditions
- the new Conditions
object.
SAML2Exception
- if the object is immutable.AuthnRequest.getConditions()
RequestedAuthnContext getRequestedAuthnContext()
RequestedAuthnContext
object.
RequestAuthnContext
object.AuthnRequest.setRequestedAuthnContext(RequestedAuthnContext)
void setRequestedAuthnContext(RequestedAuthnContext reqAuthnContext) throws SAML2Exception
RequestedAuthnContext
.
reqAuthnContext
- the new RequestedAuthnContext
object.
SAML2Exception
- if the object is immutable.AuthnRequest.getRequestedAuthnContext()
void setScoping(Scoping scoping) throws SAML2Exception
Scoping
object.
scoping
- the new Scoping
Object.
SAML2Exception
- if the object is immutable.AuthnRequest.getScoping()
Scoping getScoping()
Scoping
object.
Scoping
object.AuthnRequest.setScoping(Scoping)
Boolean isForceAuthn()
isForceAuthn
attribute.
isForceAuthn
attribute.void setForceAuthn(Boolean value) throws SAML2Exception
ForceAuthn
attribute.
value
- the value of ForceAuthn
attribute.
SAML2Exception
- if the object is immutable.Boolean isPassive()
isPassive
attribute.
isPassive
attribute.void setIsPassive(Boolean value) throws SAML2Exception
IsPassive
attribute.
value
- Value of IsPassive
attribute.
SAML2Exception
- if the object is immutable.void setProtocolBinding(String protocolBinding) throws SAML2Exception
ProtocolBinding
attribute.
protocolBinding
- value of the ProtocolBinding
attribute.
SAML2Exception
- if the object is immutable.AuthnRequest.getProtocolBinding()
String getProtocolBinding()
ProtocolBinding
attribute.
ProtocolBinding
attribute.AuthnRequest.setProtocolBinding(String)
String getAssertionConsumerServiceURL()
AssertionConsumerServiceURL
attribute.
AssertionConsumerServiceURL
attribute.AuthnRequest.setAssertionConsumerServiceURL(String)
void setAssertionConsumerServiceURL(String url) throws SAML2Exception
AssertionConsumerServiceURL
attribute.
url
- the value of AssertionConsumerServiceURL
attribute.
SAML2Exception
- if the object is immutable.AuthnRequest.getAssertionConsumerServiceURL()
Integer getAssertionConsumerServiceIndex()
AssertionConsumerServiceIndex
attribute.
AssertionConsumerServiceIndex
attribute.- See Also:
AuthnRequest.setAssertionConsumerServiceIndex(Integer)
void setAssertionConsumerServiceIndex(Integer index) throws SAML2Exception
AssertionConsumerServiceIndex
attribute.
index
- value of the AssertionConsumerServiceIndex
attribute.
SAML2Exception
- if the object is immutable.AuthnRequest.getAssertionConsumerServiceIndex()
Integer getAttributeConsumingServiceIndex()
AttributeConsumingServiceIndex
attribute.
AttributeConsumingServiceIndex
attribute.- See Also:
AuthnRequest.setAttributeConsumingServiceIndex(Integer)
void setAttributeConsumingServiceIndex(Integer index) throws SAML2Exception
AttributeConsumingServiceIndex
attribute.
index
- value of the AttributeConsumingServiceIndex
attribute.
SAML2Exception
- if the object is immutable.AuthnRequest.getAttributeConsumingServiceIndex()
void setProviderName(String providerName) throws SAML2Exception
ProviderName
attribute value.
providerName
- value of the ProviderName
attribute.
SAML2Exception
- if the object is immutable.AuthnRequest.getProviderName()
String getProviderName()
ProviderName
attribute value.
ProviderName
attribute value.AuthnRequest.setProviderName(String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |