Package io.jans.scim.model.scim2.provider.config

Class AuthenticationScheme

  • public class AuthenticationScheme
extends Object
    This class represents the authenticationSchemes complex attribute in the Service Provider Config (see section 5 of RFC 7643).

    • Constructor Detail

      • AuthenticationScheme

        public AuthenticationScheme()
        Creates an instance of AuthenticationScheme with all its fields unassigned.

      • AuthenticationScheme

        public AuthenticationScheme​(String name,
                            String description,
                            String specUri,
                            String documentationUri,
                            String type,
                            boolean primary)
        Creates an instance of AuthenticationScheme using the parameter values passed.
        Parameters:
        name - The common authentication scheme name.
        description - The description of the authentication scheme.
        specUri - An HTTP addressable URL pointing to the authentication scheme's specification.
        documentationUri - An HTTP addressable URL pointing to the authentication scheme's usage documentation.
        type - The type of authentication scheme, e.g. "oauthbearertoken", "httpbasic", etc.
        primary - A boolean value specifying if current scheme is the preference

    • Method Detail

      • getName

        public String getName()
        Retrieves the name of the authentication scheme.
        Returns:
        The name of the authentication scheme.

      • getDescription

        public String getDescription()
        Retrieves the description of the authentication scheme.
        Returns:
        The description of the Authentication Scheme.

      • getSpecUri

        public String getSpecUri()
        Retrieves the HTTP URL of the authentication scheme's specification.
        Returns:
        A string representing a URL

      • getDocumentationUri

        public String getDocumentationUri()
        Retrieves the HTTP URL pointing of the authentication scheme's usage documentation.
        Returns:
        A string representing a URL

      • getType

        public String getType()
        Retrieves the type of authentication scheme.
        Returns:
        The type of authentication scheme.

      • isPrimary

        public boolean isPrimary()
        Whether this AuthenticationScheme is the preferred authentication scheme for service usage
        Returns:
        A boolean value

      • setType

        public void setType​(String type)

      • setName

        public void setName​(String name)

      • setDescription

        public void setDescription​(String description)

      • setSpecUri

        public void setSpecUri​(String specUri)

      • setDocumentationUri

        public void setDocumentationUri​(String documentationUri)

      • setPrimary

        public void setPrimary​(boolean primary)

      • createBasic

        public static AuthenticationScheme createBasic​(boolean primary)
        Convenience method that creates a new AuthenticationScheme instance of type HTTP BASIC.
        Parameters:
        primary - A boolean value for the "primary" field of object
        Returns:
        An AuthenticationScheme object

      • createOAuth2

        public static AuthenticationScheme createOAuth2​(boolean primary)
        Convenience method that creates a new AuthenticationScheme instances of type OAuth 2.
        Parameters:
        primary - A boolean value for the "primary" field of object
        Returns:
        An AuthenticationScheme object