Package org.forgerock.openig.filter.oauth2.client

Class ResourceOwnerOAuth2ClientFilterHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.filter.oauth2.client.ResourceOwnerOAuth2ClientFilterHeaplet

All Implemented Interfaces:

Heaplet

public class ResourceOwnerOAuth2ClientFilterHeaplet
extends GenericHeaplet

Creates and initializes a Filter supporting the transformation of client and user credentials to an access_token, using the grant type "password". This grant type should generally only be used with service accounts (not users).

The ResourceOwnerOAuth2ClientFilterHeaplet has the following configuration:

 {
      "type": "ResourceOwnerOAuth2ClientFilter",
      "config": {
        <inherited configuration settings from BearerTokenOAuth2ClientFilterHeaplet>
        "username"            : string            [REQUIRED - resource owner username to use to authenticate. ]
        "passwordSecretId"    : secret-id         [REQUIRED - secret ID to use to obtain resource owner password. ]
        "secretsProvider"     : secrets provider  [REQUIRED - secrets provider used to obtain "passwordSecretId". ]
      }
 }
 
 

See Also:

RFC 6749 - Resource Owner Password Grant

Field Summary

Fields inherited from class org.forgerock.openig.heap.GenericHeaplet

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
ResourceOwnerOAuth2ClientFilterHeaplet()

Method Summary

Modifier and Type	Method	Description
protected String	clientId()
Object	create()	Called to request the heaplet create an object.
protected GrantTypeHandler	createGrantTypeHandler()
protected JsonValue	getEndpointHandlerConfig()
protected Handler	getOrDefaultEndpointHandler()
protected Set<String>	scopes()

Methods inherited from class org.forgerock.openig.heap.GenericHeaplet

create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getType, meterRegistryHolder, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceOwnerOAuth2ClientFilterHeaplet

public ResourceOwnerOAuth2ClientFilterHeaplet()

Method Detail

createGrantTypeHandler

protected GrantTypeHandler createGrantTypeHandler()
                                           throws HeapException

Throws:

HeapException

create

public Object create()
              throws HeapException

Description copied from class: GenericHeaplet

Called to request the heaplet create an object. Called by Heaplet.create(Name, JsonValue, Heap) after initializing the protected field members. Implementations should parse configuration but not acquire resources, start threads, or log any initialization messages. These tasks should be performed by the GenericHeaplet.start() method.

Specified by:

create in class GenericHeaplet

Returns:

The created object.

Throws:

HeapException - if an exception occurred during creation of the heap object or any of its dependencies.

getEndpointHandlerConfig

protected JsonValue getEndpointHandlerConfig()

getOrDefaultEndpointHandler

protected Handler getOrDefaultEndpointHandler()
                                       throws HeapException

Throws:

HeapException

clientId

protected String clientId()

scopes

protected Set<String> scopes()