Package com.ebasetech.xi.services.auth

Class OAuthAuthentication

java.lang.Object
com.ebasetech.xi.services.auth.OAuthAuthentication
All Implemented Interfaces:
Authentication
Direct Known Subclasses:
TestOAuthAuthentication
public class OAuthAuthentication
extends java.lang.Object
implements Authentication
OAuth 2.0 Authentication holding the name of the configured OAuth configuration on the Ebase server.
Since:
v5.1

  • Field Summary

    Fields inherited from interface com.ebasetech.xi.services.Authentication

    BASIC_AUTHENTICATION, DIGEST_AUTHENTICATION, GATEWAY_AUTHENTICATION, NTLM_AUTHENTICATION, OAUTH_AUTHENTICATION

  • Constructor Summary

    Constructors
    Constructor Description
    OAuthAuthentication()  

  • Method Summary

    Modifier and Type Method Description
    java.util.Map<java.lang.String,​java.lang.Object> getAdditionalParameters()
    Returns any additional parameters for authentication
    java.lang.String getName()
    Returns the name of the OAuth authentication configuration
    java.lang.String getPassword()
    Returns the password used to authenticate the user
    java.lang.String getScope()
    Returns the scope for the resource owner password grant authentication
    int getType()
    Returns the Authentication type ID
    java.lang.String getUsername()
    Returns the username used to authenticate the user
    void setAdditionalParameters​(java.util.Map<java.lang.String,​java.lang.Object> additionalParameters)
    Sets any additional parameters for authentication.
    void setName​(java.lang.String name)
    Sets the name of the OAuth authentication configuration
    void setPassword​(java.lang.String password)
    Sets the password used to authenticate the user
    void setScope​(java.lang.String scope)
    Sets the scope for the resource owner password grant authentication
    void setUsername​(java.lang.String username)
    Sets the username used to authenticate the user

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • OAuthAuthentication

      public OAuthAuthentication()

  • Method Details

    • setName

      public void setName​(java.lang.String name)
      Sets the name of the OAuth authentication configuration
      Parameters:
      name - of the OAuth configuration
      Since:
      v5.1

    • getName

      public java.lang.String getName()
      Returns the name of the OAuth authentication configuration
      Since:
      v5.1

    • getUsername

      public java.lang.String getUsername()
      Returns the username used to authenticate the user
      Since:
      v5.1

    • setUsername

      public void setUsername​(java.lang.String username)
      Sets the username used to authenticate the user
      Parameters:
      username -
      Since:
      v5.1

    • getPassword

      public java.lang.String getPassword()
      Returns the password used to authenticate the user
      Since:
      v5.1

    • setPassword

      public void setPassword​(java.lang.String password)
      Sets the password used to authenticate the user
      Parameters:
      password -
      Since:
      v5.1

    • getScope

      public java.lang.String getScope()
      Returns the scope for the resource owner password grant authentication
      Since:
      v5.1

    • setScope

      public void setScope​(java.lang.String scope)
      Sets the scope for the resource owner password grant authentication
      Parameters:
      scope -
      Since:
      v5.1

    • getAdditionalParameters

      public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalParameters()
      Returns any additional parameters for authentication
      Since:
      v5.3.1

    • setAdditionalParameters

      public void setAdditionalParameters​(java.util.Map<java.lang.String,​java.lang.Object> additionalParameters)
      Sets any additional parameters for authentication. These are only applicable to Client Credentials and Resource Owner Password Credentials OAuth.
      Parameters:
      additionalParameters -
      Since:
      v5.3.1

    • getType

      public int getType()
      Description copied from interface: Authentication
      Returns the Authentication type ID
      Specified by:
      getType in interface Authentication