AuthorizationPolicy (Apache CXF JavaDoc 3.0.4.redhat-621177 API)

org.apache.cxf.configuration.security

## Class AuthorizationPolicy

- java.lang.Object
- - org.apache.cxf.configuration.security.AuthorizationPolicy

- Direct Known Subclasses:
    ProxyAuthorizationPolicy

      public class AuthorizationPolicy
      extends Object

  This structure holds parameters that may govern authentication that use a User Password strategy.

  Java class for AuthorizationPolicy complex type.

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

       <complexType name="AuthorizationPolicy">
         <complexContent>
           <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
             <sequence>
               <element name="UserName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
               <element name="Password" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
               <element name="AuthorizationType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
               <element name="Authorization" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
             </sequence>
           </restriction>
         </complexContent>
       </complexType>

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected String` | `authorization` Actual authentication data for server, if not using username and password based "BASIC" authentication If username and password are used, this does not need to be set.
    `protected String` | `authorizationType` Type of authentication to use with server, if not using username and password based "BASIC" authentication.
    `protected String` | `password` Password for server BASIC authentication login (some servers require users to authenticate with the server -- see also UserName, AuthorizationType, and Authorization)
    `protected String` | `userName` User Name for server BASIC authentication login (some servers require users to authenticate with the server -- see also Password, AuthorizationType, and Authorization)

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `AuthorizationPolicy()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getAuthorization()` Gets the value of the authorization property.
    `String` | `getAuthorizationType()` Gets the value of the authorizationType property.
    `String` | `getPassword()` Gets the value of the password property.
    `String` | `getUserName()` Gets the value of the userName property.
    `boolean` | `isSetAuthorization()`
    `boolean` | `isSetAuthorizationType()`
    `boolean` | `isSetPassword()`
    `boolean` | `isSetUserName()`
    `void` | `setAuthorization(String value)` Sets the value of the authorization property.
    `void` | `setAuthorizationType(String value)` Sets the value of the authorizationType property.
    `void` | `setPassword(String value)` Sets the value of the password property.
    `void` | `setUserName(String value)` Sets the value of the userName property.

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

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

- - ### Field Detail

    - #### userName

          protected String userName

      User Name for server BASIC authentication login (some servers require users to authenticate with the server -- see also Password, AuthorizationType, and Authorization)

    - #### password

          protected String password

      Password for server BASIC authentication login (some servers require users to authenticate with the server -- see also UserName, AuthorizationType, and Authorization)

    - #### authorizationType

          protected String authorizationType

      Type of authentication to use with server, if not using username and password based "BASIC" authentication. If username and password are used, this does not need to be set. (some servers require users to authenticate with the server -- see also UserName, Password, and Authorization)

    - #### authorization

          protected String authorization

      Actual authentication data for server, if not using username and password based "BASIC" authentication If username and password are used, this does not need to be set. (some servers require users to authenticate with the server -- see also UserName, Password, and AuthorizationType)

  - ### Constructor Detail

    - #### AuthorizationPolicy

          public AuthorizationPolicy()

  - ### Method Detail

    - #### getUserName

          public String getUserName()

      Gets the value of the userName property.

      User Name for server BASIC authentication login (some servers require users to authenticate with the server -- see also Password, AuthorizationType, and Authorization)

      Returns:
        possible object is `String`

    - #### setUserName

          public void setUserName(String value)

      Sets the value of the userName property.
      Parameters:
        `value` - allowed object is `String`
      See Also:
        `getUserName()`

    - #### isSetUserName

          public boolean isSetUserName()

    - #### getPassword

          public String getPassword()

      Gets the value of the password property.

      Password for server BASIC authentication login (some servers require users to authenticate with the server -- see also UserName, AuthorizationType, and Authorization)

      Returns:
        possible object is `String`

    - #### setPassword

          public void setPassword(String value)

      Sets the value of the password property.
      Parameters:
        `value` - allowed object is `String`
      See Also:
        `getPassword()`

    - #### isSetPassword

          public boolean isSetPassword()

    - #### getAuthorizationType

          public String getAuthorizationType()

      Gets the value of the authorizationType property.

      Type of authentication to use with server, if not using username and password based "BASIC" authentication. If username and password are used, this does not need to be set. (some servers require users to authenticate with the server -- see also UserName, Password, and Authorization)

      Returns:
        possible object is `String`

    - #### setAuthorizationType

          public void setAuthorizationType(String value)

      Sets the value of the authorizationType property.
      Parameters:
        `value` - allowed object is `String`
      See Also:
        `getAuthorizationType()`

    - #### isSetAuthorizationType

          public boolean isSetAuthorizationType()

    - #### getAuthorization

          public String getAuthorization()

      Gets the value of the authorization property.

      Actual authentication data for server, if not using username and password based "BASIC" authentication If username and password are used, this does not need to be set. (some servers require users to authenticate with the server -- see also UserName, Password, and AuthorizationType)

      Returns:
        possible object is `String`

    - #### setAuthorization

          public void setAuthorization(String value)

      Sets the value of the authorization property.
      Parameters:
        `value` - allowed object is `String`
      See Also:
        `getAuthorization()`

    - #### isSetAuthorization

          public boolean isSetAuthorization()

Apache CXF