Package org.forgerock.oauth2.core

Class OAuth2ProviderSettingsFactory

java.lang.Object

org.forgerock.oauth2.core.OAuth2ProviderSettingsFactory

All Implemented Interfaces:

ServiceListener

@Singleton
public class OAuth2ProviderSettingsFactory
extends Object
implements ServiceListener

A factory for creating/retrieving OAuth2ProviderSettings instances.
It is up to the implementation to provide caching of OAuth2ProviderSettings instance if it wants to supported multiple OAuth2 providers.

Since:

12.0.0

Field Summary

Fields inherited from interface com.sun.identity.sm.ServiceListener

ADDED, MODIFIED, REMOVED

Constructor Summary

Constructors

Constructor	Description
OAuth2ProviderSettingsFactory(ResourceSetStoreFactory resourceSetStoreFactory, OAuth2RealmResolver realmResolver, ServiceConfigManagerFactory serviceConfigManagerFactory)	Constructs a new OpenAMOAuth2ProviderSettingsFactory instance.

Method Summary

Modifier and Type	Method	Description
OAuth2ProviderSettings	get(OAuth2Request request)	Gets the instance of the OAuth2ProviderSettings
OAuth2ProviderSettings	get(org.forgerock.services.context.Context context)	Gets the instance of the OAuth2ProviderSettings.
OAuth2ProviderSettings	getRealmProviderSettings(String realm)	Gets the instance of the OAuth2ProviderSettings defined in the realm.
void	globalConfigChanged(String serviceName, String version, String groupName, String serviceComponent, int type)	This method will be invoked when a service's global configuration data has been changed.
void	organizationConfigChanged(String serviceName, String version, String orgName, String groupName, String serviceComponent, int type)	This method will be invoked when a service's organization configuration data has been changed.
void	schemaChanged(String serviceName, String version)	This method will be invoked when a service's schema has been changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2ProviderSettingsFactory

@Inject
public OAuth2ProviderSettingsFactory(ResourceSetStoreFactory resourceSetStoreFactory,
                                     OAuth2RealmResolver realmResolver,
                                     ServiceConfigManagerFactory serviceConfigManagerFactory)

Constructs a new OpenAMOAuth2ProviderSettingsFactory instance.

Parameters:

resourceSetStoreFactory - Factory for creating ResourceSetStore instances.

realmResolver - Used to resolve the realm.

serviceConfigManagerFactory - Factory for creating ServiceConfigManager instances.

Method Detail

getRealmProviderSettings

public OAuth2ProviderSettings getRealmProviderSettings(String realm)
                                                throws NotFoundException

Gets the instance of the OAuth2ProviderSettings defined in the realm.

Parameters:

realm - The realm.

Returns:

The OAuth2ProviderSettings instance.

Throws:

NotFoundException

get

public OAuth2ProviderSettings get(org.forgerock.services.context.Context context)
                           throws NotFoundException

Gets the instance of the OAuth2ProviderSettings.

Parameters:

context - The context that can be used to obtain the base deployment url.

Returns:

The OAuth2ProviderSettings instance.

Throws:

NotFoundException

get

public OAuth2ProviderSettings get(OAuth2Request request)
                           throws NotFoundException

Gets the instance of the OAuth2ProviderSettings

Parameters:

request - The OAuth2 request.

Returns:

The OAuth2ProviderSettings instance.

Throws:

NotFoundException

schemaChanged

public void schemaChanged(String serviceName,
                          String version)

Description copied from interface: ServiceListener

This method will be invoked when a service's schema has been changed.

Specified by:

schemaChanged in interface ServiceListener

Parameters:

serviceName - name of the service

version - version of the service

globalConfigChanged

public void globalConfigChanged(String serviceName,
                                String version,
                                String groupName,
                                String serviceComponent,
                                int type)

Description copied from interface: ServiceListener

This method will be invoked when a service's global configuration data has been changed. The parameter groupName denote the name of the configuration grouping (e.g. default) and serviceComponent denotes the service's sub-component that changed (e.g. /NamedPolicy, /Templates).

Specified by:

globalConfigChanged in interface ServiceListener

Parameters:

serviceName - name of the service.

version - version of the service.

groupName - name of the configuration grouping.

serviceComponent - name of the service components that changed.

type - change type, i.e., ADDED, REMOVED or MODIFIED.

organizationConfigChanged

public void organizationConfigChanged(String serviceName,
                                      String version,
                                      String orgName,
                                      String groupName,
                                      String serviceComponent,
                                      int type)

Description copied from interface: ServiceListener

This method will be invoked when a service's organization configuration data has been changed. The parameters orgName, groupName and serviceComponent denotes the organization name, configuration grouping name and service's sub-component that are changed respectively.

Specified by:

organizationConfigChanged in interface ServiceListener

Parameters:

serviceName - name of the service

version - version of the service

orgName - organization name as DN

groupName - name of the configuration grouping

serviceComponent - the name of the service components that changed

type - change type, i.e., ADDED, REMOVED or MODIFIED