Class OAuthClient


  • public class OAuthClient
    extends java.lang.Object
    An OAuth client implementation used for storing or retrieving entries from an OAuthStore implementation.
    • Constructor Summary

      Constructors 
      Constructor Description
      OAuthClient​(java.lang.String providerId, java.lang.String clientId, java.lang.String clientSecret, java.lang.String displayName, boolean enabled, java.lang.String clientMetadata)
      Constructs a new OAuthClient data transfer object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getClientId()
      Gets the client id.
      java.lang.String getClientMetadata()
      Gets the meta data as a JSON string.
      java.lang.String getClientSecret()
      Gets the encoded client secret.
      java.lang.String getDisplayName()
      Gets the display name.
      java.lang.String getProviderId()
      Gets the OAuth provider id.
      int hashCode()  
      boolean isEnabled()
      Returns whether this client can participate in an OAuth flow or not.
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • OAuthClient

        public OAuthClient​(java.lang.String providerId,
                           java.lang.String clientId,
                           java.lang.String clientSecret,
                           java.lang.String displayName,
                           boolean enabled,
                           java.lang.String clientMetadata)
        Constructs a new OAuthClient data transfer object.
    • Method Detail

      • getProviderId

        public java.lang.String getProviderId()
        Gets the OAuth provider id.
        Returns:
        the id of the OAuth provider this client is registered with
      • getClientId

        public java.lang.String getClientId()
        Gets the client id.
        Returns:
        the client id
      • getClientSecret

        public java.lang.String getClientSecret()
        Gets the encoded client secret.
        Returns:
        the client secret
      • getDisplayName

        public java.lang.String getDisplayName()
        Gets the display name.
        Returns:
        the display name
      • isEnabled

        public boolean isEnabled()
        Returns whether this client can participate in an OAuth flow or not.
        Returns:
        true when the client is allowed to participate in an OAuth flow with the OAuth provider it is registered with
      • getClientMetadata

        public java.lang.String getClientMetadata()
        Gets the meta data as a JSON string.
        Returns:
        the JSON string with the client meta data
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object