org.mule.runtime.extension.internal.ocs

Class OCSConstants

java.lang.Object

org.mule.runtime.extension.internal.ocs.OCSConstants

@Experimental
public final class OCSConstants
extends Object

Constants for the OAuth Client Service functionality.

These are used to extract configuration arguments from the application's ConfigurationProperties object. The following properties will be fetch:

• OCS_SERVICE_URL
• OCS_PLATFORM_AUTH_URL
• OCS_CLIENT_ID
• OCS_CLIENT_SECRET
• OCS_ORG_ID

If any of these properties are missing, IllegalStateException will be thrown when using this client. Because this feature is at the moment experimental, the presence of these properties also act as a feature flag. If any is absent, the feature will not work

Platform Managed OAuth is an experimental feature. It will only be enabled on selected environments and scenarios. Backwards compatibility is not guaranteed.

Since:

1.3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	OCS_API_VERSION Key to obtain the OCS API version to be used, if not specified, the default api version for the mule version running will be used.
static String	OCS_CLIENT_ID Key to obtain the client id to obtain an access token for the OCS API
static String	OCS_CLIENT_SECRET Key to obtain the client secret to obtain an access token to the OCS API
static String	OCS_ENABLED Property that if set signals that OCS is supported.
static String	OCS_ORG_ID Key to obtain the organization id to be used when accessing the OCS API
static String	OCS_PLATFORM_AUTH_DEFAULT_PATH Default value of the path of the URL of the OAuth service provider that grants access tokens to the OCS API
static String	OCS_PLATFORM_AUTH_PATH Key to obtain the path of the URL of the OAuth service provider that grants access tokens to the OCS API
static String	OCS_PLATFORM_AUTH_URL Key to obtain the URL of the OAuth service provider that grants access tokens to the OCS API
static String	OCS_SERVICE_URL Key to obtain the URL of the OCS API

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

OCS_SERVICE_URL

public static final String OCS_SERVICE_URL

Key to obtain the URL of the OCS API

See Also:

Constant Field Values

OCS_PLATFORM_AUTH_URL

public static final String OCS_PLATFORM_AUTH_URL

Key to obtain the URL of the OAuth service provider that grants access tokens to the OCS API

See Also:

Constant Field Values

OCS_PLATFORM_AUTH_PATH

public static final String OCS_PLATFORM_AUTH_PATH

Key to obtain the path of the URL of the OAuth service provider that grants access tokens to the OCS API

See Also:

Constant Field Values

OCS_PLATFORM_AUTH_DEFAULT_PATH

public static final String OCS_PLATFORM_AUTH_DEFAULT_PATH

Default value of the path of the URL of the OAuth service provider that grants access tokens to the OCS API

See Also:

Constant Field Values

OCS_CLIENT_ID

public static final String OCS_CLIENT_ID

Key to obtain the client id to obtain an access token for the OCS API

See Also:

Constant Field Values

OCS_CLIENT_SECRET

public static final String OCS_CLIENT_SECRET

Key to obtain the client secret to obtain an access token to the OCS API

See Also:

Constant Field Values

OCS_ORG_ID

public static final String OCS_ORG_ID

Key to obtain the organization id to be used when accessing the OCS API

See Also:

Constant Field Values

OCS_API_VERSION

public static final String OCS_API_VERSION

Key to obtain the OCS API version to be used, if not specified, the default api version for the mule version running will be used.

Since:

1.3.1 1.4.0

See Also:

Constant Field Values

OCS_ENABLED

public static final String OCS_ENABLED

Property that if set signals that OCS is supported.

See Also:

Constant Field Values