Class AuthnRequestImpl

All Implemented Interfaces:
XMLObject, SAMLObject, SignableSAMLObject, AuthnRequest, RequestAbstractType, SignableXMLObject

public class AuthnRequestImpl
extends RequestAbstractTypeImpl
implements AuthnRequest
A concrete implementation of AuthnRequest.
  • Field Details

    • subject

      private Subject subject
      Subject child element.
    • nameIDPolicy

      private NameIDPolicy nameIDPolicy
      NameIDPolicy child element.
    • conditions

      private Conditions conditions
      Conditions child element.
    • requestedAuthnContext

      private RequestedAuthnContext requestedAuthnContext
      RequestedAuthnContext child element.
    • scoping

      private Scoping scoping
      Scoping child element.
    • forceAuthn

      private XSBooleanValue forceAuthn
      ForeceAuthn attribute.
    • isPassive

      private XSBooleanValue isPassive
      IsPassive attribute.
    • protocolBinding

      private String protocolBinding
      ProtocolBinding attribute.
    • assertionConsumerServiceIndex

      private Integer assertionConsumerServiceIndex
      AssertionConsumerServiceIndex attribute.
    • assertionConsumerServiceURL

      private String assertionConsumerServiceURL
      AssertionConsumerServiceURL attribute.
    • attributeConsumingServiceIndex

      private Integer attributeConsumingServiceIndex
      AttributeConsumingServiceIndex attribute.
    • providerName

      private String providerName
      ProviderName attribute.
  • Constructor Details

    • AuthnRequestImpl

      protected AuthnRequestImpl​(String namespaceURI, String elementLocalName, String namespacePrefix)
      Constructor.
      Parameters:
      namespaceURI - the namespace the element is in
      elementLocalName - the local name of the XML element this Object represents
      namespacePrefix - the prefix for the given namespace
  • Method Details

    • isForceAuthn

      public Boolean isForceAuthn()
      Gets whether the IdP should force the user to reauthenticate.
      Specified by:
      isForceAuthn in interface AuthnRequest
      Returns:
      whether the IdP should force the user to reauthenticate
    • isForceAuthnXSBoolean

      public XSBooleanValue isForceAuthnXSBoolean()
      Gets whether the IdP should force the user to reauthenticate.
      Specified by:
      isForceAuthnXSBoolean in interface AuthnRequest
      Returns:
      whether the IdP should force the user to reauthenticate
    • setForceAuthn

      public void setForceAuthn​(Boolean newForceAuth)
      Sets whether the IdP should force the user to reauthenticate. Boolean values will be marshalled to either "true" or "false".
      Specified by:
      setForceAuthn in interface AuthnRequest
      Parameters:
      newForceAuth - whether the IdP should force the user to reauthenticate
    • setForceAuthn

      public void setForceAuthn​(XSBooleanValue newForceAuthn)
      Sets whether the IdP should force the user to reauthenticate.
      Specified by:
      setForceAuthn in interface AuthnRequest
      Parameters:
      newForceAuthn - whether the IdP should force the user to reauthenticate
    • isPassive

      public Boolean isPassive()
      Gets whether the IdP should refrain from interacting with the user during the authentication process.
      Specified by:
      isPassive in interface AuthnRequest
      Returns:
      whether the IdP should refrain from interacting with the user during the authentication process
    • isPassiveXSBoolean

      public XSBooleanValue isPassiveXSBoolean()
      Gets whether the IdP should refrain from interacting with the user during the authentication process.
      Specified by:
      isPassiveXSBoolean in interface AuthnRequest
      Returns:
      whether the IdP should refrain from interacting with the user during the authentication process
    • setIsPassive

      public void setIsPassive​(Boolean newIsPassive)
      Sets whether the IdP should refrain from interacting with the user during the authentication process. Boolean values will be marshalled to either "true" or "false".
      Specified by:
      setIsPassive in interface AuthnRequest
      Parameters:
      newIsPassive - whether the IdP should refrain from interacting with the user during the authentication process
    • setIsPassive

      public void setIsPassive​(XSBooleanValue newIsPassive)
      Sets whether the IdP should refrain from interacting with the user during the authentication process.
      Specified by:
      setIsPassive in interface AuthnRequest
      Parameters:
      newIsPassive - whether the IdP should refrain from interacting with the user during the authentication process
    • getProtocolBinding

      public String getProtocolBinding()
      Gets the protocol binding URI for the request.
      Specified by:
      getProtocolBinding in interface AuthnRequest
      Returns:
      the value of the ProtocolBinding attribute
    • setProtocolBinding

      public void setProtocolBinding​(String newProtocolBinding)
      Sets the protocol binding URI for the request.
      Specified by:
      setProtocolBinding in interface AuthnRequest
      Parameters:
      newProtocolBinding - the new value of the ProtocolBinding attribute
    • getAssertionConsumerServiceIndex

      public Integer getAssertionConsumerServiceIndex()
      Gets the index of the particular Assertion Consumer Service to which the response to this request should be delivered.
      Specified by:
      getAssertionConsumerServiceIndex in interface AuthnRequest
      Returns:
      the value of the AssertionConsumerServiceIndex attribute
    • setAssertionConsumerServiceIndex

      public void setAssertionConsumerServiceIndex​(Integer newAssertionConsumerServiceIndex)
      Sets the index of the particular Assertion Consumer Service to which the response to this request should be delivered.
      Specified by:
      setAssertionConsumerServiceIndex in interface AuthnRequest
      Parameters:
      newAssertionConsumerServiceIndex - the new value of the AssertionConsumerServiceIndex attribute
    • getAssertionConsumerServiceURL

      public String getAssertionConsumerServiceURL()
      Gets the URL of the particular Assertion Consumer Service to which the response to this request should be delivered.
      Specified by:
      getAssertionConsumerServiceURL in interface AuthnRequest
      Returns:
      the value of the AssertionConsumerServiceURL attribute
    • setAssertionConsumerServiceURL

      public void setAssertionConsumerServiceURL​(String newAssertionConsumerServiceURL)
      Sets the URL of the particular Assertion Consumer Service to which the response to this request should be delivered.
      Specified by:
      setAssertionConsumerServiceURL in interface AuthnRequest
      Parameters:
      newAssertionConsumerServiceURL - the new value of the AssertionConsumerServiceURL attribute
    • getAttributeConsumingServiceIndex

      public Integer getAttributeConsumingServiceIndex()
      Gets the index of the Attribute Consuming Service which describes the SAML attributes the requester desires or requires to be supplied in the Response message.
      Specified by:
      getAttributeConsumingServiceIndex in interface AuthnRequest
      Returns:
      the value of the AssertionConsumerServiceIndex attribute
    • setAttributeConsumingServiceIndex

      public void setAttributeConsumingServiceIndex​(Integer newAttributeConsumingServiceIndex)
      Sets the index of the Attribute Consuming Service which describes the SAML attributes the requester desires or requires to be supplied in the Response message.
      Specified by:
      setAttributeConsumingServiceIndex in interface AuthnRequest
      Parameters:
      newAttributeConsumingServiceIndex - the new value of the AttributeConsumingServiceIndex attribute
    • getProviderName

      public String getProviderName()
      Gets the human-readable name of the requester for use by the presenter's user agent or the identity provider.
      Specified by:
      getProviderName in interface AuthnRequest
      Returns:
      the value of the ProviderName attribute
    • setProviderName

      public void setProviderName​(String newProviderName)
      Sets the human-readable name of the requester for use by the presenter's user agent or the identity provider.
      Specified by:
      setProviderName in interface AuthnRequest
      Parameters:
      newProviderName - the new value of the ProviderName attribute
    • getSubject

      public Subject getSubject()
      Gets the Subject of the request.
      Specified by:
      getSubject in interface AuthnRequest
      Returns:
      the Subject of the request
    • setSubject

      public void setSubject​(Subject newSubject)
      Sets the Subject of the request.
      Specified by:
      setSubject in interface AuthnRequest
      Parameters:
      newSubject - the new value of the Subject of the request
    • getNameIDPolicy

      public NameIDPolicy getNameIDPolicy()
      Gets the NameIDPolicy of the request.
      Specified by:
      getNameIDPolicy in interface AuthnRequest
      Returns:
      the NameIDPolicy of the request
    • setNameIDPolicy

      public void setNameIDPolicy​(NameIDPolicy newNameIDPolicy)
      Sets the NameIDPolicy of the request.
      Specified by:
      setNameIDPolicy in interface AuthnRequest
      Parameters:
      newNameIDPolicy - the new value of the NameIDPolicy of the request
    • getConditions

      public Conditions getConditions()
      Gets the Conditions of the request.
      Specified by:
      getConditions in interface AuthnRequest
      Returns:
      the Conditions of the request
    • setConditions

      public void setConditions​(Conditions newConditions)
      Sets the Conditions of the request.
      Specified by:
      setConditions in interface AuthnRequest
      Parameters:
      newConditions - the new value of the Conditions of the request
    • getRequestedAuthnContext

      public RequestedAuthnContext getRequestedAuthnContext()
      Gets the RequestedAuthnContext of the request.
      Specified by:
      getRequestedAuthnContext in interface AuthnRequest
      Returns:
      the RequestedAuthnContext of the request
    • setRequestedAuthnContext

      public void setRequestedAuthnContext​(RequestedAuthnContext newRequestedAuthnContext)
      Sets the RequestedAuthnContext of the request.
      Specified by:
      setRequestedAuthnContext in interface AuthnRequest
      Parameters:
      newRequestedAuthnContext - the new value of the RequestedAuthnContext of the request
    • getScoping

      public Scoping getScoping()
      Gets the Scoping of the request.
      Specified by:
      getScoping in interface AuthnRequest
      Returns:
      the Scoping of the request
    • setScoping

      public void setScoping​(Scoping newScoping)
      Sets the Scoping of the request.
      Specified by:
      setScoping in interface AuthnRequest
      Parameters:
      newScoping - the new value of the Scoping of the request
    • getOrderedChildren

      public List<XMLObject> getOrderedChildren()
      Gets an unmodifiable list of child elements in the order that they will appear in the DOM.
      Specified by:
      getOrderedChildren in interface XMLObject
      Overrides:
      getOrderedChildren in class RequestAbstractTypeImpl
      Returns:
      ordered list of child elements