gov.virginia.dcjs.identity.saml
Class AuthnRequest

java.lang.Object
  gov.virginia.dcjs.ws.Element
      gov.virginia.dcjs.identity.saml.MessageAbstractType
          gov.virginia.dcjs.identity.saml.RequestAbstractType
              gov.virginia.dcjs.identity.saml.AuthnRequest

All Implemented Interfaces:

org.apache.soap.util.xml.Serializer, XmlElement

public class AuthnRequest

extends RequestAbstractType

Use this class to request that an IDP issue an assertion with an * authentication statement. A presenter authenticates to that IDP * (or relies on an existing security context) and sends it the * contents of this class.

Constructor Summary

AuthnRequest()

Method Summary

void	setAssertionConsumerServiceIndex(int index) Index to indirectly identify location to send response.
void	setAssertionConsumerServiceURL(java.lang.String url) Specify the attribute for specifying the location to send the response.
void	setAttributeConsumingServiceIndex(int index) Specify the index that indirectly describes SAML attributes desired in the response.
void	setConditions(Conditions conditions)
void	setForceAuthn(boolean authn) Specifies whether or not the IDP must directly authenticate the presenter.
void	setNameIDPolicy(NameIDPolicy policy)
void	setPassive(boolean passive) Specifies whether or not the IDP can interact with the presenter.
void	setProtocolBinding(java.lang.String uri) Specify the attribute for specifying the protocol binding to return the response with.
void	setProviderName(java.lang.String name) Specify the human readable requester name for the IDP to present * to the user.
void	setRequestedAuthnContext(RequestedAuthnContext context)
void	setScoping(Scoping scoping)
void	setSubject(Subject subject)

Methods inherited from class gov.virginia.dcjs.identity.saml.MessageAbstractType

getID, getIssueInstant, setConsent, setDestination, setExtensions, setIssuer, setSignature

Methods inherited from class gov.virginia.dcjs.ws.Element

addAttribute, addElement, arrayAppend, declareNamespaces, getNamespaces, marshall, removeAttribute, removeElement, setContent, toString, toXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthnRequest

public AuthnRequest()

Method Detail

setForceAuthn

public void setForceAuthn(boolean authn)

Specifies whether or not the IDP must directly authenticate the presenter. * @param authn True when IDP must authenticate presenter directly.

setPassive

public void setPassive(boolean passive)

Specifies whether or not the IDP can interact with the presenter. * @param passive True when IDP MUST NOT interact with the presenter in a noticeable fashion.

setAssertionConsumerServiceIndex

public void setAssertionConsumerServiceIndex(int index)

Index to indirectly identify location to send response. * The index must be an XML unsigned short; out of range * values will remove the attribute from use.
*
* Since this attribute is mutually exclusive to attributes:

*
• AssertionConsumerServiceURL
*
• ProtocolBinding
*
• AttributeConsumingServiceIndex
*

* calling this method with a valid index also removes any settings * those attributes may have had. * @param index XML unsignedShort value for IDP to map to a location.

setAssertionConsumerServiceURL

public void setAssertionConsumerServiceURL(java.lang.String url)

Specify the attribute for specifying the location to send the response. * Setting this to null removes it from use. * Since this attribute is mutually exclusive with the * AssertionConsumerServiceIndex attribute, non-null URL * values will cause the latter to have its setting removed. * @param url Location to send response to.

setProtocolBinding

public void setProtocolBinding(java.lang.String uri)

Specify the attribute for specifying the protocol binding to return the response with. * Setting this to null removes it from use. * Since this attribute is mutually exclusive with the * AssertionConsumerServiceIndex attribute, non-null URI values * will cause the latter to have its setting removed. * @param uri Binding to return response by.

setAttributeConsumingServiceIndex

public void setAttributeConsumingServiceIndex(int index)

Specify the index that indirectly describes SAML attributes desired in the response. * The index must be an XML unsigned short; out of range * values will remove the attribute from use.
* Since this attribute is mutually exclusive with the * AssertionConsumerServiceIndex attribute, a valid index will * cause the latter to have its setting removed. * @param index XML unsignedShort value for IDP to map to response attributes.

setProviderName

public void setProviderName(java.lang.String name)

Specify the human readable requester name for the IDP to present * to the user. Setting this to null removes it from use. * @param name Human readable name of the requester.

setSubject

public void setSubject(Subject subject)

setNameIDPolicy

public void setNameIDPolicy(NameIDPolicy policy)

setConditions

public void setConditions(Conditions conditions)

setRequestedAuthnContext

public void setRequestedAuthnContext(RequestedAuthnContext context)

setScoping

public void setScoping(Scoping scoping)