com.adobe.granite.auth.oauth

Class ProviderConfigProperties

java.lang.Object

com.adobe.granite.auth.oauth.ProviderConfigProperties

public final class ProviderConfigProperties
extends 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 Summary

Fields

Modifier and Type	Field and Description
static String	AUTO_CREATE_USERS Should JCR users be created if they do not exist?
static String	AUTO_CREATE_USERS_GROUPS If new users are created, which groups should they be added to?
static String	CALLBACK_URL URL configured with the OAuth providers to redirect the client back.
static String	CLIENT_ID The OAuth "Consumer Key"
static String	CLIENT_SECRET The OAuth "Consumer Secret"
static String	CONFIG_ID A unique ID to identify this configuration id.
static boolean	DEFAULT_AUTO_CREATE_USERS Default value for AUTO_CREATE_USERS property is false
static String	DEFAULT_CALL_BACK_URL Default value for CALLBACK_URL property is ""
static boolean	DEFAULT_ENCODE_USER_IDS Default value for ENCODE_USER_IDS property is false;
static boolean	DEFAULT_PERSIST_ACCESS_TOKEN Default value for PERSIST_ACCESS_TOKEN
static String	ENCODE_USER_IDS Should user ID be encoded?
static String	FACTORY_PID When using org.osgi.service.cm.ConfigurationAdmin to create configs, use this factoryPid
static 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.
static String	PROVIDER_ID The unique ID of the configured Provider implementation to use.
static String	SCOPE OAuth "Scope" parameter

Constructor Summary

Constructors

Constructor and Description
ProviderConfigProperties()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY_PID

public static final String FACTORY_PID

When using org.osgi.service.cm.ConfigurationAdmin to create configs, use this factoryPid

See Also:

Constant Field Values

CONFIG_ID

public static final 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 String CLIENT_ID

The OAuth "Consumer Key"

See Also:

Constant Field Values

CLIENT_SECRET

public static final String CLIENT_SECRET

The OAuth "Consumer Secret"

See Also:

Constant Field Values

SCOPE

public static final String SCOPE

OAuth "Scope" parameter

See Also:

Constant Field Values

PROVIDER_ID

public static final String PROVIDER_ID

The unique ID of the configured Provider implementation to use.

See Also:

Constant Field Values

AUTO_CREATE_USERS

public static final 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 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 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

CALLBACK_URL

public static final 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 String DEFAULT_CALL_BACK_URL

Default value for CALLBACK_URL property is ""

See Also:

Constant Field Values

PERSIST_ACCESS_TOKEN

public static final 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

Constructor Detail

ProviderConfigProperties

public ProviderConfigProperties()