public interface OAuthComponentConfigurationConstants
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
OAUTH20_ACCESS_TOKEN_LENGTH
Defines the length in characters of a generated access token.
|
static java.lang.String |
OAUTH20_ACCESS_TOKENTYPEHANDLER_CLASSNAME
Defines the implementation class for an access token issuer.
|
static java.lang.String |
OAUTH20_ALLOW_PUBLIC_CLIENTS
Defines a boolean to indicate whether or not public clients may access
the token endpoint.
|
static java.lang.String |
OAUTH20_AUDITHANDLER_CLASSNAME
Defines an implementation class for an audit handler that implements the
com.ibm.oauth.core.api.audit.OAuthAuditHandler interface to be
called during OAuth flows. |
static java.lang.String |
OAUTH20_CLIENT_PROVIDER_CLASSNAME
Defines the implementation class for the client provider which must
implement the
com.ibm.oauth.core.api.oauth20.client.OAuth20ClientProvider
interface. |
static java.lang.String |
OAUTH20_CODE_LENGTH
Defines the length in characters of a generated authorization code.
|
static java.lang.String |
OAUTH20_CODE_LIFETIME_SECONDS
Defines the lifetime of an authorization code.
|
static java.lang.String |
OAUTH20_GRANT_TYPE_AUTH_CODE
Constant to be used as a value for the
OAUTH20_GRANT_TYPES_ALLOWED property to enable clients to use
the authorization code flow. |
static java.lang.String |
OAUTH20_GRANT_TYPE_CLIENT_CREDENTIALS
Constant to be used as a value for the
OAUTH20_GRANT_TYPES_ALLOWED property to enable clients to use
the client credentials flow. |
static java.lang.String |
OAUTH20_GRANT_TYPE_IMPLICIT
Constant to be used as a value for the
OAUTH20_GRANT_TYPES_ALLOWED property to enable clients to use
the implicit grant flow. |
static java.lang.String |
OAUTH20_GRANT_TYPE_OWNER_PASSWORD
Constant to be used as a value for the
OAUTH20_GRANT_TYPES_ALLOWED property to enable clients to use
the resource owner password credentials flow. |
static java.lang.String |
OAUTH20_GRANT_TYPE_REFRESH_TOKEN
Constant to be used as a value for the
OAUTH20_GRANT_TYPES_ALLOWED property to enable clients to the
token endpoint to exchange refresh tokens for a new access token and
refresh token. |
static java.lang.String |
OAUTH20_GRANT_TYPES_ALLOWED
Defines a list of the flows which may be used by clients for this
component instance.
|
static java.lang.String |
OAUTH20_ISSUE_REFRESH_TOKEN
Defines a boolean to indicate whether or not refresh tokens should be
issued.
|
static java.lang.String |
OAUTH20_MAX_AUTHORIZATION_GRANT_LIFETIME_SECONDS
Defines the maximum authorization grant lifetime for OAuth 2.0 flows in
which a refresh token is used.
|
static java.lang.String |
OAUTH20_MEDIATOR_CLASSNAMES
Defines a list of implementation classes for custom mediators that
implement the
OAuth20Mediator interface
to execute during OAuth flows. |
static java.lang.String |
OAUTH20_REFRESH_TOKEN_LENGTH
Defines the length in characters of a generated refresh token.
|
static java.lang.String |
OAUTH20_TOKEN_CACHE_CLASSNAME
Defines the implementation class for the token cache which must implement
the
com.ibm.oauth.core.api.oauth20.token.OAuth20TokenCache
interface. |
static java.lang.String |
OAUTH20_TOKEN_LIFETIME_SECONDS
Defines the maximum lifetime of an issued access token.
|
static final java.lang.String OAUTH20_CLIENT_PROVIDER_CLASSNAME
com.ibm.oauth.core.api.oauth20.client.OAuth20ClientProvider
interface. This configuration property MUST be defined and should be a
single string represents the class name of the implementation class for
your client configuration provider. The
SampleComponentConfiguration
class does not contain a
default value for this property. You can see an example of it being set
in the examples source in
com.ibm.oauth.examples.config.OAuthComponentConfigurationTestImpl
static final java.lang.String OAUTH20_TOKEN_CACHE_CLASSNAME
com.ibm.oauth.core.api.oauth20.token.OAuth20TokenCache
interface. This configuration property MUST be defined and should be a
single string represents the class name of the implementation class for
your token cache. The SampleComponentConfiguration
class does
not contain a default value for this property. You can see an
example of it being set in the examples source in
com.ibm.oauth.examples.config.OAuthComponentConfigurationTestImpl
static final java.lang.String OAUTH20_MAX_AUTHORIZATION_GRANT_LIFETIME_SECONDS
OAUTH20_TOKEN_LIFETIME_SECONDS
property will determine the
lifetime of access tokens. This configuration property MUST be defined
and should be a single string representing the lifetime in seconds. The
value should be greater than the value for
OAUTH20_TOKEN_LIFETIME_SECONDS
. The
SampleComponentConfiguration
class contains a default value for
this property.static final java.lang.String OAUTH20_CODE_LIFETIME_SECONDS
SampleComponentConfiguration
class contains a default value for
this property.static final java.lang.String OAUTH20_CODE_LENGTH
SampleComponentConfiguration
class
contains a default value for this property.static final java.lang.String OAUTH20_TOKEN_LIFETIME_SECONDS
SampleComponentConfiguration
class contains a default value for
this property.static final java.lang.String OAUTH20_ACCESS_TOKEN_LENGTH
SampleComponentConfiguration
class
contains a default value for this property.static final java.lang.String OAUTH20_ISSUE_REFRESH_TOKEN
SampleComponentConfiguration
class contains a default value for this property.static final java.lang.String OAUTH20_REFRESH_TOKEN_LENGTH
SampleComponentConfiguration
class
contains a default value for this property.static final java.lang.String OAUTH20_ACCESS_TOKENTYPEHANDLER_CLASSNAME
SampleComponentConfiguration.ACCESS_TOKENTYPEHANDLER_CLASSNAME
.
This configuration property MUST be defined and set as indicated. The
SampleComponentConfiguration
class contains a default value for
this property.static final java.lang.String OAUTH20_MEDIATOR_CLASSNAMES
OAuth20Mediator
interface
to execute during OAuth flows. This configuration property is optional
and when provided should be a list of string class names.static final java.lang.String OAUTH20_ALLOW_PUBLIC_CLIENTS
OAUTH20_GRANT_TYPES_ALLOWED
. The
client_credentials flow may not be used by a public client. This
configuration property MUST be defined and should be a single string
representing "true" or "false". The SampleComponentConfiguration
class contains a default value for this property.static final java.lang.String OAUTH20_AUDITHANDLER_CLASSNAME
com.ibm.oauth.core.api.audit.OAuthAuditHandler
interface to be
called during OAuth flows. This configuration property is optional and
when provided should be string class names. The component supports these
two pre-defined audit handlers, or you can write your own:
com.ibm.oauth.core.api.audit.SimpleFileOAuthAuditHandler
com.ibm.oauth.core.api.audit.XMLFileOAuthAuditHandler
static final java.lang.String OAUTH20_GRANT_TYPES_ALLOWED
static final java.lang.String OAUTH20_GRANT_TYPE_AUTH_CODE
OAUTH20_GRANT_TYPES_ALLOWED
property to enable clients to use
the authorization code flow.static final java.lang.String OAUTH20_GRANT_TYPE_IMPLICIT
OAUTH20_GRANT_TYPES_ALLOWED
property to enable clients to use
the implicit grant flow.static final java.lang.String OAUTH20_GRANT_TYPE_CLIENT_CREDENTIALS
OAUTH20_GRANT_TYPES_ALLOWED
property to enable clients to use
the client credentials flow.static final java.lang.String OAUTH20_GRANT_TYPE_OWNER_PASSWORD
OAUTH20_GRANT_TYPES_ALLOWED
property to enable clients to use
the resource owner password credentials flow.static final java.lang.String OAUTH20_GRANT_TYPE_REFRESH_TOKEN
OAUTH20_GRANT_TYPES_ALLOWED
property to enable clients to the
token endpoint to exchange refresh tokens for a new access token and
refresh token.