Class DeveloperAuthenticationCallbackResponse

  • All Implemented Interfaces:
    Serializable

    public class DeveloperAuthenticationCallbackResponse
    extends Object
    implements Serializable
    Developer authentication response from a service implementation to Authlete.
    Since:
    1.9
    Author:
    Takahiko Kawasaki
    See Also:
    Serialized Form
    • Constructor Detail

      • DeveloperAuthenticationCallbackResponse

        public DeveloperAuthenticationCallbackResponse()
    • Method Detail

      • isAuthenticated

        public boolean isAuthenticated()
        Get the authentication result.
        Returns:
        true if the credentials of the developer were valid. Otherwise, false.
      • setAuthenticated

        public DeveloperAuthenticationCallbackResponse setAuthenticated​(boolean authenticated)
        Set the authentication result.

        When the credentials (id and password) in the developer authentication callback request (DeveloperAuthenticationCallbackRequest) are valid, true should be set to this property.

        Parameters:
        authenticated - true if the credentials of the developer were valid. Otherwise, false.
        Returns:
        this object.
      • getSubject

        public String getSubject()
        Get the subject (= unique identifier) of the authenticated developer.
        Returns:
        The subject (= unique identifier) of the authenticated developer.
      • setSubject

        public DeveloperAuthenticationCallbackResponse setSubject​(String subject)
        Set the subject (= unique identifier) of the authenticated developer.

        When the credentials (id and password) in the developer authentication callback request (DeveloperAuthenticationCallbackRequest) are valid, the subject (= unique identifier) of the developer should be set to this property.

        The value of subject does not always have to be equal to the value of id in the developer authentication callback request. For example, id may be an email address but a service implementation may have generated and assigned a unique identifier such as 60504791 to the developer who is represented by the email address. In such a case, 60504791 should be set as subject.

        Parameters:
        subject - The subject (= unique identifier) of the authenticated developer. When the authentication failed, this property should be null.
        Returns:
        this object.
      • getDisplayName

        public String getDisplayName()
        Get the display name of the authenticated developer.
        Returns:
        The display name of the authenticated developer.
      • setDisplayName

        public DeveloperAuthenticationCallbackResponse setDisplayName​(String displayName)
        Set the display name of the authenticated developer.
        Parameters:
        displayName - The display name of the authenticated developer.
        Returns:
        this object.