Package com.sun.identity.sm

Interface ServiceListener

All Known Implementing Classes:

AdminInterfaceUtils, AdministrationServiceListener, AgentsRepo, AMAuthLevelManager, ApiDescriptorFilter.State, AuditServiceConfigurationProviderImpl, AuthConfigMonitor, AuthenticatedSharedAgentsCondition, AuthenticationServiceAttributeCache, CMListener, ConfigChangeListener, ConfigurationObserver, CoreTokenConfigService, CORSConfigListener, DefaultUrlResourceTypeGenerator, DelegationPolicyImpl, G11NSettings, GatewayServletUtils, IdentityResourceV2, IdRepoAttributeValidatorManager, IdRepoPluginsCache, LogConfigReader, OAuth2ProviderSettingsFactory, PolicyCache, PolicyConfig, RestSTSInstanceStateServiceListener, RestSTSPublishServiceListener, ScriptConfigurationService, ScriptEngineConfigurator, SMServiceListener, SmsRequestHandler, SoapSTSInstanceStateServiceListener, SpecialRepo, StatelessSSOProvider, STSInstanceStateServiceListenerBase, SubRealmObserver, VersionBehaviourConfigListener

public interface ServiceListener

The interface ServiceListener needs to be implemented by applications in order to receive service data change notifications. The method schemaChanged() is invoked when a service schema data has been changed. The method globalConfigChanged() and organizationConfigChanged() are invoked when the service configuration data has been changed.

Field Summary

Fields

Modifier and Type	Field	Description
static int	ADDED	The change type specifies that the entry has been added.
static int	MODIFIED	The change type specifies that the entry has been modified.
static int	REMOVED	The change type specifies that the entry has been removed.

Method Summary

Modifier and Type	Method	Description
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.

Field Detail

ADDED

static final int ADDED

The change type specifies that the entry has been added.

See Also:

Constant Field Values

REMOVED

static final int REMOVED

The change type specifies that the entry has been removed.

See Also:

Constant Field Values

MODIFIED

static final int MODIFIED

The change type specifies that the entry has been modified.

See Also:

Constant Field Values

Method Detail

schemaChanged

void schemaChanged(String serviceName,
                   String version)

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

Parameters:

serviceName - name of the service

version - version of the service

globalConfigChanged

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. 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).

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

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. The parameters orgName, groupName and serviceComponent denotes the organization name, configuration grouping name and service's sub-component that are changed respectively.

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