org.keycloak.dom.saml.v2.protocol

## Class AuthnRequestType

- java.lang.Object
- - org.keycloak.dom.saml.common.CommonRequestAbstractType
  - - org.keycloak.dom.saml.v2.protocol.RequestAbstractType
    - - org.keycloak.dom.saml.v2.protocol.AuthnRequestType

- All Implemented Interfaces:
    Serializable, SAML2Object

      public class AuthnRequestType
      extends RequestAbstractType

  Java class for AuthnRequestType complex type.

  The following schema fragment specifies the expected content contained within this class.

       <complexType name="AuthnRequestType">
         <complexContent>
           <extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType">
             <sequence>
               <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}Subject" minOccurs="0"/>
               <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}NameIDPolicy" minOccurs="0"/>
               <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}Conditions" minOccurs="0"/>
               <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}RequestedAuthnContext" minOccurs="0"/>
               <element ref="{urn:oasis:names:tc:SAML:2.0:protocol}Scoping" minOccurs="0"/>
             </sequence>
             <attribute name="ForceAuthn" type="{http://www.w3.org/2001/XMLSchema}boolean" />
             <attribute name="IsPassive" type="{http://www.w3.org/2001/XMLSchema}boolean" />
             <attribute name="ProtocolBinding" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
             <attribute name="AssertionConsumerServiceIndex" type="{http://www.w3.org/2001/XMLSchema}unsignedShort" />
             <attribute name="AssertionConsumerServiceURL" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
             <attribute name="AttributeConsumingServiceIndex" type="{http://www.w3.org/2001/XMLSchema}unsignedShort" />
             <attribute name="ProviderName" type="{http://www.w3.org/2001/XMLSchema}string" />
           </extension>
         </complexContent>
       </complexType>

  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected Integer` | `assertionConsumerServiceIndex`
    `protected URI` | `assertionConsumerServiceURL`
    `protected Integer` | `attributeConsumingServiceIndex`
    `protected ConditionsType` | `conditions`
    `protected Boolean` | `forceAuthn`
    `protected Boolean` | `isPassive`
    `protected NameIDPolicyType` | `nameIDPolicy`
    `protected URI` | `protocolBinding`
    `protected String` | `providerName`
    `protected RequestedAuthnContextType` | `requestedAuthnContext`
    `protected ScopingType` | `scoping`
    `protected SubjectType` | `subject`

    - ### Fields inherited from class org.keycloak.dom.saml.v2.protocol.RequestAbstractType

      `consent, destination, extensions, issuer, version`

    - ### Fields inherited from class org.keycloak.dom.saml.common.CommonRequestAbstractType

      `id, issueInstant, signature`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `AuthnRequestType(String id, XMLGregorianCalendar instant)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Integer` | `getAssertionConsumerServiceIndex()` Gets the value of the assertionConsumerServiceIndex property.
    `URI` | `getAssertionConsumerServiceURL()` Gets the value of the assertionConsumerServiceURL property.
    `Integer` | `getAttributeConsumingServiceIndex()` Gets the value of the attributeConsumingServiceIndex property.
    `ConditionsType` | `getConditions()` Gets the value of the conditions property.
    `NameIDPolicyType` | `getNameIDPolicy()` Gets the value of the nameIDPolicy property.
    `URI` | `getProtocolBinding()` Gets the value of the protocolBinding property.
    `String` | `getProviderName()` Gets the value of the providerName property.
    `RequestedAuthnContextType` | `getRequestedAuthnContext()` Gets the value of the requestedAuthnContext property.
    `ScopingType` | `getScoping()` Gets the value of the scoping property.
    `URI` | `getSenderURL()`
    `SubjectType` | `getSubject()` Gets the value of the subject property.
    `Boolean` | `isForceAuthn()` Gets the value of the forceAuthn property.
    `Boolean` | `isIsPassive()` Gets the value of the isPassive property.
    `void` | `setAssertionConsumerServiceIndex(Integer value)` Sets the value of the assertionConsumerServiceIndex property.
    `void` | `setAssertionConsumerServiceURL(URI value)` Sets the value of the assertionConsumerServiceURL property.
    `void` | `setAttributeConsumingServiceIndex(Integer value)` Sets the value of the attributeConsumingServiceIndex property.
    `void` | `setConditions(ConditionsType value)` Sets the value of the conditions property.
    `void` | `setForceAuthn(Boolean value)` Sets the value of the forceAuthn property.
    `void` | `setIsPassive(Boolean value)` Sets the value of the isPassive property.
    `void` | `setNameIDPolicy(NameIDPolicyType value)` Sets the value of the nameIDPolicy property.
    `void` | `setProtocolBinding(URI value)` Sets the value of the protocolBinding property.
    `void` | `setProviderName(String value)` Sets the value of the providerName property.
    `void` | `setRequestedAuthnContext(RequestedAuthnContextType value)` Sets the value of the requestedAuthnContext property.
    `void` | `setScoping(ScopingType value)` Sets the value of the scoping property.
    `void` | `setSubject(SubjectType value)` Sets the value of the subject property.

    - ### Methods inherited from class org.keycloak.dom.saml.v2.protocol.RequestAbstractType

      `getConsent, getDestination, getExtensions, getIssuer, getVersion, setConsent, setDestination, setExtensions, setIssuer`

    - ### Methods inherited from class org.keycloak.dom.saml.common.CommonRequestAbstractType

      `getID, getIssueInstant, getSignature, setSignature`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### subject

          protected SubjectType subject

    - #### nameIDPolicy

          protected NameIDPolicyType nameIDPolicy

    - #### conditions

          protected ConditionsType conditions

    - #### requestedAuthnContext

          protected RequestedAuthnContextType requestedAuthnContext

    - #### scoping

          protected ScopingType scoping

    - #### forceAuthn

          protected Boolean forceAuthn

    - #### isPassive

          protected Boolean isPassive

    - #### protocolBinding

          protected URI protocolBinding

    - #### assertionConsumerServiceIndex

          protected Integer assertionConsumerServiceIndex

    - #### assertionConsumerServiceURL

          protected URI assertionConsumerServiceURL

    - #### attributeConsumingServiceIndex

          protected Integer attributeConsumingServiceIndex

    - #### providerName

          protected String providerName

  - ### Constructor Detail

    - #### AuthnRequestType

          public AuthnRequestType(String id,
                                  XMLGregorianCalendar instant)

  - ### Method Detail

    - #### getSubject

          public SubjectType getSubject()

      Gets the value of the subject property.
      Returns:
        possible object is `SubjectType`

    - #### setSubject

          public void setSubject(SubjectType value)

      Sets the value of the subject property.
      Parameters:
        `value` - allowed object is `SubjectType`

    - #### getNameIDPolicy

          public NameIDPolicyType getNameIDPolicy()

      Gets the value of the nameIDPolicy property.
      Returns:
        possible object is `NameIDPolicyType`

    - #### setNameIDPolicy

          public void setNameIDPolicy(NameIDPolicyType value)

      Sets the value of the nameIDPolicy property.
      Parameters:
        `value` - allowed object is `NameIDPolicyType`

    - #### getConditions

          public ConditionsType getConditions()

      Gets the value of the conditions property.
      Returns:
        possible object is `ConditionsType`

    - #### setConditions

          public void setConditions(ConditionsType value)

      Sets the value of the conditions property.
      Parameters:
        `value` - allowed object is `ConditionsType`

    - #### getRequestedAuthnContext

          public RequestedAuthnContextType getRequestedAuthnContext()

      Gets the value of the requestedAuthnContext property.
      Returns:
        possible object is `RequestedAuthnContextType`

    - #### setRequestedAuthnContext

          public void setRequestedAuthnContext(RequestedAuthnContextType value)

      Sets the value of the requestedAuthnContext property.
      Parameters:
        `value` - allowed object is `RequestedAuthnContextType`

    - #### getScoping

          public ScopingType getScoping()

      Gets the value of the scoping property.
      Returns:
        possible object is `ScopingType`

    - #### setScoping

          public void setScoping(ScopingType value)

      Sets the value of the scoping property.
      Parameters:
        `value` - allowed object is `ScopingType`

    - #### isForceAuthn

          public Boolean isForceAuthn()

      Gets the value of the forceAuthn property.
      Returns:
        possible object is `Boolean`

    - #### setForceAuthn

          public void setForceAuthn(Boolean value)

      Sets the value of the forceAuthn property.
      Parameters:
        `value` - allowed object is `Boolean`

    - #### isIsPassive

          public Boolean isIsPassive()

      Gets the value of the isPassive property.
      Returns:
        possible object is `Boolean`

    - #### setIsPassive

          public void setIsPassive(Boolean value)

      Sets the value of the isPassive property.
      Parameters:
        `value` - allowed object is `Boolean`

    - #### getProtocolBinding

          public URI getProtocolBinding()

      Gets the value of the protocolBinding property.
      Returns:
        possible object is `String`

    - #### setProtocolBinding

          public void setProtocolBinding(URI value)

      Sets the value of the protocolBinding property.
      Parameters:
        `value` - allowed object is `String`

    - #### getAssertionConsumerServiceIndex

          public Integer getAssertionConsumerServiceIndex()

      Gets the value of the assertionConsumerServiceIndex property.
      Returns:
        possible object is `Integer`

    - #### setAssertionConsumerServiceIndex

          public void setAssertionConsumerServiceIndex(Integer value)

      Sets the value of the assertionConsumerServiceIndex property.
      Parameters:
        `value` - allowed object is `Integer`

    - #### getAssertionConsumerServiceURL

          public URI getAssertionConsumerServiceURL()

      Gets the value of the assertionConsumerServiceURL property.
      Returns:
        possible object is `String`

    - #### setAssertionConsumerServiceURL

          public void setAssertionConsumerServiceURL(URI value)

      Sets the value of the assertionConsumerServiceURL property.
      Parameters:
        `value` - allowed object is `String`

    - #### getAttributeConsumingServiceIndex

          public Integer getAttributeConsumingServiceIndex()

      Gets the value of the attributeConsumingServiceIndex property.
      Returns:
        possible object is `Integer`

    - #### setAttributeConsumingServiceIndex

          public void setAttributeConsumingServiceIndex(Integer value)

      Sets the value of the attributeConsumingServiceIndex property.
      Parameters:
        `value` - allowed object is `Integer`

    - #### getProviderName

          public String getProviderName()

      Gets the value of the providerName property.
      Returns:
        possible object is `String`

    - #### setProviderName

          public void setProviderName(String value)

      Sets the value of the providerName property.
      Parameters:
        `value` - allowed object is `String`

    - #### getSenderURL

          public URI getSenderURL()

Copyright © 2021 JBoss by Red Hat. All rights reserved.