Interface HTTPOauth2TokenIntrospectionAuthorizationMechanismCfgClient
-
- All Superinterfaces:
ConfigurationClient,HTTPAuthorizationMechanismCfgClient,HTTPOauth2AuthorizationMechanismCfgClient
public interface HTTPOauth2TokenIntrospectionAuthorizationMechanismCfgClient extends HTTPOauth2AuthorizationMechanismCfgClient
A client-side interface for reading and modifying HTTP Oauth2 Token Introspection Authorization Mechanism settings.The HTTP Oauth2 Token Introspection Authorization Mechanism is used to define OAuth2 authorization using an introspection (RFC7662) compliant authorization server.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ManagedObjectDefinition<? extends HTTPOauth2TokenIntrospectionAuthorizationMechanismCfgClient,? extends HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg>definition()Get the configuration definition associated with this HTTP Oauth2 Token Introspection Authorization Mechanism.StringgetAuthzidJsonPointer()Gets the "authzid-json-pointer" property.StringgetClientId()Gets the "client-id" property.StringgetClientSecret()Gets the "client-secret" property.StringgetJavaClass()Gets the "java-class" property.StringgetKeyManagerProvider()Gets the "key-manager-provider" property.StringgetTokenIntrospectionUrl()Gets the "token-introspection-url" property.StringgetTrustManagerProvider()Gets the "trust-manager-provider" property.voidsetAuthzidJsonPointer(String value)Sets the "authzid-json-pointer" property.voidsetClientId(String value)Sets the "client-id" property.voidsetClientSecret(String value)Sets the "client-secret" property.voidsetJavaClass(String value)Sets the "java-class" property.voidsetKeyManagerProvider(String value)Sets the "key-manager-provider" property.voidsetTokenIntrospectionUrl(String value)Sets the "token-introspection-url" property.voidsetTrustManagerProvider(String value)Sets the "trust-manager-provider" property.-
Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient
commit, properties
-
Methods inherited from interface org.forgerock.opendj.server.config.client.HTTPAuthorizationMechanismCfgClient
isEnabled, setEnabled
-
Methods inherited from interface org.forgerock.opendj.server.config.client.HTTPOauth2AuthorizationMechanismCfgClient
getAccessTokenCacheExpiration, getIdentityMapper, getRequiredScope, isAccessTokenCacheEnabled, setAccessTokenCacheEnabled, setAccessTokenCacheExpiration, setIdentityMapper, setRequiredScope
-
-
-
-
Method Detail
-
definition
ManagedObjectDefinition<? extends HTTPOauth2TokenIntrospectionAuthorizationMechanismCfgClient,? extends HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg> definition()
Get the configuration definition associated with this HTTP Oauth2 Token Introspection Authorization Mechanism.- Specified by:
definitionin interfaceConfigurationClient- Specified by:
definitionin interfaceHTTPAuthorizationMechanismCfgClient- Specified by:
definitionin interfaceHTTPOauth2AuthorizationMechanismCfgClient- Returns:
- Returns the configuration definition associated with this HTTP Oauth2 Token Introspection Authorization Mechanism.
-
getAuthzidJsonPointer
String getAuthzidJsonPointer()
Gets the "authzid-json-pointer" property.Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document. (example: /uid)
- Specified by:
getAuthzidJsonPointerin interfaceHTTPOauth2AuthorizationMechanismCfgClient- Returns:
- Returns the value of the "authzid-json-pointer" property.
-
setAuthzidJsonPointer
void setAuthzidJsonPointer(String value) throws PropertyException
Sets the "authzid-json-pointer" property.Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document. (example: /uid)
- Specified by:
setAuthzidJsonPointerin interfaceHTTPOauth2AuthorizationMechanismCfgClient- Parameters:
value- The value of the "authzid-json-pointer" property.- Throws:
PropertyException- If the new value is invalid.
-
getClientId
String getClientId()
Gets the "client-id" property.Client's ID to use during the HTTP basic authentication against the authorization server.
- Returns:
- Returns the value of the "client-id" property.
-
setClientId
void setClientId(String value) throws PropertyException
Sets the "client-id" property.Client's ID to use during the HTTP basic authentication against the authorization server.
- Parameters:
value- The value of the "client-id" property.- Throws:
PropertyException- If the new value is invalid.
-
getClientSecret
String getClientSecret()
Gets the "client-secret" property.Client's secret to use during the HTTP basic authentication against the authorization server.
- Returns:
- Returns the value of the "client-secret" property.
-
setClientSecret
void setClientSecret(String value) throws PropertyException
Sets the "client-secret" property.Client's secret to use during the HTTP basic authentication against the authorization server.
- Parameters:
value- The value of the "client-secret" property.- Throws:
PropertyException- If the new value is invalid.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the HTTP Oauth2 Token Introspection Authorization Mechanism implementation.
- Specified by:
getJavaClassin interfaceHTTPAuthorizationMechanismCfgClient- Returns:
- Returns the value of the "java-class" property.
-
setJavaClass
void setJavaClass(String value) throws PropertyException
Sets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the HTTP Oauth2 Token Introspection Authorization Mechanism implementation.
- Specified by:
setJavaClassin interfaceHTTPAuthorizationMechanismCfgClient- Parameters:
value- The value of the "java-class" property.- Throws:
PropertyException- If the new value is invalid.
-
getKeyManagerProvider
String getKeyManagerProvider()
Gets the "key-manager-provider" property.Specifies the name of the key manager that should be used with this HTTP Oauth2 Token Introspection Authorization Mechanism .
- Returns:
- Returns the value of the "key-manager-provider" property.
-
setKeyManagerProvider
void setKeyManagerProvider(String value) throws PropertyException
Sets the "key-manager-provider" property.Specifies the name of the key manager that should be used with this HTTP Oauth2 Token Introspection Authorization Mechanism .
- Parameters:
value- The value of the "key-manager-provider" property.- Throws:
PropertyException- If the new value is invalid.
-
getTokenIntrospectionUrl
String getTokenIntrospectionUrl()
Gets the "token-introspection-url" property.Defines the token introspection endpoint URL where the access-token resolution request should be sent. (example: http://example.com/introspect)
- Returns:
- Returns the value of the "token-introspection-url" property.
-
setTokenIntrospectionUrl
void setTokenIntrospectionUrl(String value) throws PropertyException
Sets the "token-introspection-url" property.Defines the token introspection endpoint URL where the access-token resolution request should be sent. (example: http://example.com/introspect)
- Parameters:
value- The value of the "token-introspection-url" property.- Throws:
PropertyException- If the new value is invalid.
-
getTrustManagerProvider
String getTrustManagerProvider()
Gets the "trust-manager-provider" property.Specifies the name of the trust manager that should be used when negotiating SSL connections with the remote authorization server.
- Returns:
- Returns the value of the "trust-manager-provider" property.
-
setTrustManagerProvider
void setTrustManagerProvider(String value) throws PropertyException
Sets the "trust-manager-provider" property.Specifies the name of the trust manager that should be used when negotiating SSL connections with the remote authorization server.
- Parameters:
value- The value of the "trust-manager-provider" property.- Throws:
PropertyException- If the new value is invalid.
-
-