com.kabira.platform.switchconfig

Class Notifier

java.lang.Object

com.kabira.platform.switchconfig.Notifier

Deprecated.

Notifier has been replaced by ConfigurationListener.

@Deprecated
 @Managed
public class Notifier
extends java.lang.Object

Configuration data notifier

Used to register interest in being notified of changes in version state.

Constructor Summary

Constructors

Constructor and Description
Notifier() Deprecated. Create a new Notifier

Method Summary

Modifier and Type	Method and Description
void	active(Version version) Deprecated. Specified version being made active
void	audit(Version version) Deprecated. Audit activating a configuration version
void	auditInactive(Version version) Deprecated. Audit a configuration version that is being deactivated
void	auditLoad(Version version, OutParameter<Config[]> configToRemove) Deprecated. Audit a configuration being loaded
void	auditRemove(Version version) Deprecated. Audit a configuration version that is being removed
void	auditReplace(Version deactivating, Version activating) Deprecated. Audit replacing an active version
void	inactive(Version version) Deprecated. Specified version being made inactive
void	load(Version version, OutParameter<Config[]> configList) Deprecated. Specified version being loaded
void	remove(Version version) Deprecated. Specified version is being removed
void	replace(Version deactivating, Version activating) Deprecated. Replace an active version with another version

Methods inherited from class java.lang.Object

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

Constructor Detail

Notifier

public Notifier()

Deprecated.

Create a new Notifier

Method Detail

load

public void load(Version version,
                 OutParameter<Config[]> configList)
          throws OperationFailed

Deprecated.

Specified version being loaded

Parameters:

version - Version being loaded

configList - additional configuration objects to be added to version.

Called after a new configuration version is loaded. The load operation may return a list of configuration objects to be added to the version.

Throws:

OperationFailed

active

public void active(Version version)

Deprecated.

Specified version being made active

Parameters:

version - Version made active

Called when a new configuration version is made active and there was no previous active version of configuration data.

inactive

public void inactive(Version version)

Deprecated.

Specified version being made inactive

Parameters:

version - Version being made inactive

Called when a configuration version is deactivated without activating a new version. The version specified in the operation parameter is already inactive when this operation is called.

replace

public void replace(Version deactivating,
                    Version activating)

Deprecated.

Replace an active version with another version

Parameters:

deactivating - Version being made inactive

activating - Version being made active

Called when there is an active configuration version being replaced with a new version. The versions change state before the notifier operation is called so the activating version is the active version.

remove

public void remove(Version version)

Deprecated.

Specified version is being removed

Parameters:

version - Version being removed

Called when a configuration version is being removed. This operation is called after all of the registered auditRemove() operations have been called but before the version is removed.

auditLoad

public void auditLoad(Version version,
                      OutParameter<Config[]> configToRemove)
               throws OperationFailed

Deprecated.

Audit a configuration being loaded

Parameters:

version - Version to audit

configToRemove - Configuration objects to remove

Called during the configuration load operation to audit the configuration version just loaded. This operation will be called after the entire version has been loaded. This means that all load notifiers will be called before any of the auditLoad notifiers are called.

The auditLoad operation decides whether to accept the configuration version without modification, remove a subset of the configuration objects from the version, or reject the configuration version.

To accept the configuration version without modification return normally from the auditLoad operation. Do not place any objects into the configToRemove output parameter.

To remove objects from the configuration version place the objects in the configToRemove output parameter and then return normally.

To reject the configuration version raise an OperationFailed exception with the reason field set to the reason the audit failed. This will cause the load operation to fail. All configuration objects loaded into shared memory during the load operation will be removed.

Throws:

OperationFailed

audit

public void audit(Version version)
           throws OperationFailed

Deprecated.

Audit activating a configuration version

Parameters:

version - Version to audit

Called to audit a configuration version that is transitioning from inactive to active.

OperationFailed is raised if the audit fails. Reason contains the reason the audit failed.

Throws:

OperationFailed

auditReplace

public void auditReplace(Version deactivating,
                         Version activating)
                  throws OperationFailed

Deprecated.

Audit replacing an active version

Parameters:

deactivating - Version being made inactive

activating - Version being made active

Called to audit replacement of an active version with another version. In the case of replacing an active version with another version, the auditReplace notifier is called, if it has been implemented. If not, the audit notifier operation is called with the activating version as the version parameter.

OperationFailed is raised if the audit fails. Reason contains the reason the audit failed.

Throws:

OperationFailed

auditInactive

public void auditInactive(Version version)
                   throws OperationFailed

Deprecated.

Audit a configuration version that is being deactivated

Parameters:

version - Version to audit

Called to audit a configuration version that is transitioning from active to inactive.

OperationFailed is raised if the audit fails. Reason contains the reason the audit failed.

Throws:

OperationFailed

auditRemove

public void auditRemove(Version version)
                 throws OperationFailed

Deprecated.

Audit a configuration version that is being removed

Parameters:

version - Version to audit

Called to audit a configuration version that is being removed

OperationFailed is raised if the audit fails. Reason contains the reason the audit failed.

Throws:

OperationFailed