public final class HTTPOauth2FileAuthorizationMechanismCfgDefn extends ManagedObjectDefinition<HTTPOauth2FileAuthorizationMechanismCfgClient,HTTPOauth2FileAuthorizationMechanismCfg>
The HTTP Oauth2 File Authorization Mechanism is used to define OAuth2 authorization through a file based access-token resolution. For test purpose only, this mechanism is looking up for JSON access-token files under the specified path.
getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
public static HTTPOauth2FileAuthorizationMechanismCfgDefn getInstance()
public HTTPOauth2FileAuthorizationMechanismCfgClient createClientConfiguration(ManagedObject<? extends HTTPOauth2FileAuthorizationMechanismCfgClient> impl)
createClientConfiguration
in class ManagedObjectDefinition<HTTPOauth2FileAuthorizationMechanismCfgClient,HTTPOauth2FileAuthorizationMechanismCfg>
impl
- The managed object.public HTTPOauth2FileAuthorizationMechanismCfg createServerConfiguration(ServerManagedObject<? extends HTTPOauth2FileAuthorizationMechanismCfg> impl)
createServerConfiguration
in class ManagedObjectDefinition<HTTPOauth2FileAuthorizationMechanismCfgClient,HTTPOauth2FileAuthorizationMechanismCfg>
impl
- The server managed object.public Class<HTTPOauth2FileAuthorizationMechanismCfg> getServerConfigurationClass()
getServerConfigurationClass
in class ManagedObjectDefinition<HTTPOauth2FileAuthorizationMechanismCfgClient,HTTPOauth2FileAuthorizationMechanismCfg>
public BooleanPropertyDefinition getAccessTokenCacheEnabledPropertyDefinition()
Indicates whether the HTTP Oauth2 File Authorization Mechanism is enabled for use.
public DurationPropertyDefinition getAccessTokenCacheExpirationPropertyDefinition()
Token cache expiration
public StringPropertyDefinition getAccessTokenDirectoryPropertyDefinition()
Directory containing token files. File names must be equal to the token strings. The file content must a JSON object with the following attributes: 'scope', 'expireTime' and all the field(s) needed to resolve the authzIdTemplate.
public StringPropertyDefinition getAuthzidJsonPointerPropertyDefinition()
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)
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the HTTP Oauth2 File Authorization Mechanism is enabled.
public AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg> getIdentityMapperPropertyDefinition()
> Specifies the name of the identity mapper to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the HTTP Oauth2 File Authorization Mechanism implementation.
public StringPropertyDefinition getRequiredScopePropertyDefinition()
Scopes required to grant access to the service.
Copyright 2010-2017 ForgeRock AS.