Package com.adobe.granite.auth.oauth

Class ProviderConfigProperties

  • @ProviderType
public final class ProviderConfigProperties
extends java.lang.Object
    Expose the list of well known configuration properties so that external services can find and use existing configurations for additional oauth functionality that is NOT related to Authentication.

    • Field Detail

      • CONFIG_ID

        public static final java.lang.String CONFIG_ID
        A unique ID to identify this configuration id. This ID will be passed to the authentication handler as a request parameter.
        See Also:
        Constant Field Values

      • CLIENT_ID

        public static final java.lang.String CLIENT_ID
        The OAuth "Consumer Key"
        See Also:
        Constant Field Values

      • CLIENT_SECRET

        public static final java.lang.String CLIENT_SECRET
        The OAuth "Consumer Secret"
        See Also:
        Constant Field Values

      • SCOPE

        public static final java.lang.String SCOPE
        OAuth "Scope" parameter
        See Also:
        Constant Field Values

      • PROVIDER_ID

        public static final java.lang.String PROVIDER_ID
        The unique ID of the configured Provider implementation to use.
        See Also:
        Constant Field Values

      • AUTO_CREATE_USERS

        public static final java.lang.String AUTO_CREATE_USERS
        Should JCR users be created if they do not exist?
        See Also:
        Constant Field Values

      • DEFAULT_AUTO_CREATE_USERS

        public static final boolean DEFAULT_AUTO_CREATE_USERS
        Default value for AUTO_CREATE_USERS property is false
        See Also:
        Constant Field Values

      • AUTO_CREATE_USERS_GROUPS

        public static final java.lang.String AUTO_CREATE_USERS_GROUPS
        If new users are created, which groups should they be added to?
        See Also:
        Constant Field Values

      • ENCODE_USER_IDS

        public static final java.lang.String ENCODE_USER_IDS
        Should user ID be encoded?
        See Also:
        Constant Field Values

      • DEFAULT_ENCODE_USER_IDS

        public static final boolean DEFAULT_ENCODE_USER_IDS
        Default value for ENCODE_USER_IDS property is false;
        See Also:
        Constant Field Values

      • HASH_USER_IDS

        public static final java.lang.String HASH_USER_IDS
        Should user ID be hashed?
        See Also:
        Constant Field Values

      • DEFAULT_HASH_USER_IDS

        public static final boolean DEFAULT_HASH_USER_IDS
        Default value for HASH_USER_IDS property is false;
        See Also:
        Constant Field Values

      • USER_ID_PROPERTY

        public static final java.lang.String USER_ID_PROPERTY
        The property to use as user ID when synchronizing users
        See Also:
        Constant Field Values

      • DEFAULT_USER_ID_PROPERTY

        public static final java.lang.String DEFAULT_USER_ID_PROPERTY
        The default behaviour is to use the user_id field
        See Also:
        Constant Field Values

      • FORCE_STRICT_USERNAME_MATCHING

        public static final java.lang.String FORCE_STRICT_USERNAME_MATCHING
        Setting this to true will allow to have multiple users sharing the same oauthId
        See Also:
        Constant Field Values

      • DEFAULT_FORCE_STRICT_USERNAME_MATCHING

        public static final boolean DEFAULT_FORCE_STRICT_USERNAME_MATCHING
        Default value for FORCE_STRICT_USERNAME_MATCHING property is false;
        See Also:
        Constant Field Values

      • CALLBACK_URL

        public static final java.lang.String CALLBACK_URL
        URL configured with the OAuth providers to redirect the client back.

        Use a relative url to use the host of the original request.

        Leave empty to use the originally requested URL instead. Suffix "/callback/j_security_check" is automatically appended to this url.

        Note: the domain for the callback must be \ registered at the provider side (e.g. Facebook or Twitter).
        See Also:
        Constant Field Values

      • DEFAULT_CALL_BACK_URL

        public static final java.lang.String DEFAULT_CALL_BACK_URL
        Default value for CALLBACK_URL property is ""
        See Also:
        Constant Field Values

      • PERSIST_ACCESS_TOKEN

        public static final java.lang.String PERSIST_ACCESS_TOKEN
        Should user's access token be stored in JCR with user profile? If true, the system can use the access token to execute actions on behalf of the user later.
        See Also:
        Constant Field Values

      • DEFAULT_PERSIST_ACCESS_TOKEN

        public static final boolean DEFAULT_PERSIST_ACCESS_TOKEN
        Default value for PERSIST_ACCESS_TOKEN
        See Also:
        Constant Field Values

      • PERSIST_ACCESS_TOKEN_COOKIE

        public static final java.lang.String PERSIST_ACCESS_TOKEN_COOKIE
        Should user's access token be stored in the cookie? If true, the system can use the access token to execute actions on behalf of the user later.
        See Also:
        Constant Field Values

      • DEFAULT_PERSIST_ACCESS_TOKEN_COOKIE

        public static final boolean DEFAULT_PERSIST_ACCESS_TOKEN_COOKIE
        Default value for PERSIST_ACCESS_TOKEN_COOKIE
        See Also:
        Constant Field Values

      • ENABLE_CSRF_STATE_PROTECTION

        public static final java.lang.String ENABLE_CSRF_STATE_PROTECTION
        Enable the Cross-Site Request Forgery state protection as per http://tools.ietf.org/html/draft-ietf-oauth-v2-31#section-10.12
        See Also:
        Constant Field Values

      • DEFAULT_ENABLE_CSRF_STATE_PROTECTION

        public static final boolean DEFAULT_ENABLE_CSRF_STATE_PROTECTION
        Default value for ENABLE_CSRF_STATE_PROTECTION
        See Also:
        Constant Field Values

      • PERSIST_REQUEST_PARAM_CALLBACK_URL

        public static final java.lang.String PERSIST_REQUEST_PARAM_CALLBACK_URL
        Should the request parameters be persisted in the callback url ? This could be used to redirect the user to the original requested resource
        See Also:
        Constant Field Values

      • DEFAULT_PERSIST_REQUEST_PARAM_CALLBACK_URL

        public static final boolean DEFAULT_PERSIST_REQUEST_PARAM_CALLBACK_URL
        Default value for PERSIST_REQUEST_PARAM_CALLBACK_URL
        See Also:
        Constant Field Values

      • ALLOW_SIBLING_CONFIGS

        public static final java.lang.String ALLOW_SIBLING_CONFIGS
        See Also:
        Constant Field Values

      • DEFAULT_ALLOW_SIBLING_CONFIGS

        public static final boolean DEFAULT_ALLOW_SIBLING_CONFIGS
        See Also:
        Constant Field Values

    • Constructor Detail

      • ProviderConfigProperties

        public ProviderConfigProperties()