com.sun.identity.saml2.protocol
インタフェース AuthnRequest

すべてのスーパーインタフェース:

RequestAbstract

public interface AuthnRequest
extends RequestAbstract

The AuthnRequest interface defines methods for properties required by an authentication request.

メソッドの概要

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.

インタフェース 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

メソッドの詳細

getSubject

Subject getSubject()

Returns the Subject object.

戻り値:

the Subject object.

関連項目:

AuthnRequest.setSubject(Subject)

setSubject

void setSubject(Subject subject)
                throws SAML2Exception

Sets the Subject object.

パラメータ:

subject - the new Subject object.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getSubject()

getNameIDPolicy

NameIDPolicy getNameIDPolicy()

Returns the NameIDPolicy object.

戻り値:

the NameIDPolicy object.

関連項目:

AuthnRequest.setNameIDPolicy(NameIDPolicy)

setNameIDPolicy

void setNameIDPolicy(NameIDPolicy nameIDPolicy)
                     throws SAML2Exception

Sets the NameIDPolicy object.

パラメータ:

nameIDPolicy - the new NameIDPolicy object.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getNameIDPolicy()

getConditions

Conditions getConditions()

Returns the Conditions object.

戻り値:

the Conditions object.

関連項目:

AuthnRequest.setConditions(Conditions)

setConditions

void setConditions(Conditions conditions)
                   throws SAML2Exception

Sets the Conditions object.

パラメータ:

conditions - the new Conditions object.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getConditions()

getRequestedAuthnContext

RequestedAuthnContext getRequestedAuthnContext()

Returns the RequestedAuthnContext object.

戻り値:

the RequestAuthnContext object.

関連項目:

AuthnRequest.setRequestedAuthnContext(RequestedAuthnContext)

setRequestedAuthnContext

void setRequestedAuthnContext(RequestedAuthnContext reqAuthnContext)
                              throws SAML2Exception

Sets the RequestedAuthnContext.

パラメータ:

reqAuthnContext - the new RequestedAuthnContext object.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getRequestedAuthnContext()

setScoping

void setScoping(Scoping scoping)
                throws SAML2Exception

Sets the Scoping object.

パラメータ:

scoping - the new Scoping Object.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getScoping()

getScoping

Scoping getScoping()

Returns the Scoping object.

戻り値:

the Scoping object.

関連項目:

AuthnRequest.setScoping(Scoping)

isForceAuthn

Boolean isForceAuthn()

Returns value of isForceAuthn attribute.

戻り値:

value of isForceAuthn attribute.

setForceAuthn

void setForceAuthn(Boolean value)
                   throws SAML2Exception

Sets the value of the ForceAuthn attribute.

パラメータ:

value - the value of ForceAuthn attribute.

例外:

SAML2Exception - if the object is immutable.

isPassive

Boolean isPassive()

Returns the value of the isPassive attribute.

戻り値:

value of isPassive attribute.

setIsPassive

void setIsPassive(Boolean value)
                  throws SAML2Exception

Sets the value of the IsPassive attribute.

パラメータ:

value - Value of IsPassive attribute.

例外:

SAML2Exception - if the object is immutable.

setProtocolBinding

void setProtocolBinding(String protocolBinding)
                        throws SAML2Exception

Sets the value of the ProtocolBinding attribute.

パラメータ:

protocolBinding - value of the ProtocolBinding attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getProtocolBinding()

getProtocolBinding

String getProtocolBinding()

Returns the value of the ProtocolBinding attribute.

戻り値:

the value of ProtocolBinding attribute.

関連項目:

AuthnRequest.setProtocolBinding(String)

getAssertionConsumerServiceURL

String getAssertionConsumerServiceURL()

Returns the value of the AssertionConsumerServiceURL attribute.

戻り値:

the value of AssertionConsumerServiceURL attribute.

関連項目:

AuthnRequest.setAssertionConsumerServiceURL(String)

setAssertionConsumerServiceURL

void setAssertionConsumerServiceURL(String url)
                                    throws SAML2Exception

Sets the value of the AssertionConsumerServiceURL attribute.

パラメータ:

url - the value of AssertionConsumerServiceURL attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getAssertionConsumerServiceURL()

getAssertionConsumerServiceIndex

Integer getAssertionConsumerServiceIndex()

Returns the value of the AssertionConsumerServiceIndex attribute.

戻り値:

value of the AssertionConsumerServiceIndex attribute.

関連項目:

AuthnRequest.setAssertionConsumerServiceIndex(Integer)

setAssertionConsumerServiceIndex

void setAssertionConsumerServiceIndex(Integer index)
                                      throws SAML2Exception

Sets the value of the AssertionConsumerServiceIndex attribute.

パラメータ:

index - value of the AssertionConsumerServiceIndex attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getAssertionConsumerServiceIndex()

getAttributeConsumingServiceIndex

Integer getAttributeConsumingServiceIndex()

Returns the value of the AttributeConsumingServiceIndex attribute.

戻り値:

value of the AttributeConsumingServiceIndex attribute.

関連項目:

AuthnRequest.setAttributeConsumingServiceIndex(Integer)

setAttributeConsumingServiceIndex

void setAttributeConsumingServiceIndex(Integer index)
                                       throws SAML2Exception

Sets the value of the AttributeConsumingServiceIndex attribute.

パラメータ:

index - value of the AttributeConsumingServiceIndex attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getAttributeConsumingServiceIndex()

setProviderName

void setProviderName(String providerName)
                     throws SAML2Exception

Sets the ProviderName attribute value.

パラメータ:

providerName - value of the ProviderName attribute.

例外:

SAML2Exception - if the object is immutable.

関連項目:

AuthnRequest.getProviderName()

getProviderName

String getProviderName()

Returns the ProviderName attribute value.

戻り値:

value of the ProviderName attribute value.

関連項目:

AuthnRequest.setProviderName(String)