oracle.communication.brm.charging.appconfiguration

Class AbstractConfigurationBean

java.lang.Object

java.util.Observable

oracle.communication.brm.charging.appconfiguration.AbstractConfigurationBean

All Implemented Interfaces:

oracle.communication.brm.charging.appconfiguration.ConfigurationBean

Direct Known Subclasses:

AbstractConnectionConfiguration, AbstractParentConfigurationBean, BizParamConfig, BrmCdrPluginConfiguration, BRMGatewayConfiguration, CdrFormatterConfiguration, CdrFormatterPluginConfiguration, CdrGatewayConfiguration, CommonConfig, ConsumptionRuleMapping, CustomerGeneratorConfig, DiameterGatewayConfiguration, DiameterGatewayPeerConfiguration, DiameterReplayerConfiguration, EMGatewayConfiguration, ErrorHandlerConfig, ExpirationConfiguration, ExtensionsConfig, HttpGatewayConfiguration, ItemAssignmentConfig, ItemTypeMapperConfig, KafkaConfiguration, LifecycleConfiguration, LifecycleStateMapper, LoaderConfig, MigrationLoaderConfig, NFProfileConfiguration, NFServiceConfiguration, NotificationConfig, NotificationHeaderEnrichmentConfigurations, RatedEventFormatterConfiguration, RatedEventPublisherConfig, ReservationConfig, SimpleFileBasedRatedEventPublisherConfig, SimulatorConfiguration, TaxConfigurationContainer, TopUpHistoryConfig

public abstract class AbstractConfigurationBean
extends java.util.Observable
implements oracle.communication.brm.charging.appconfiguration.ConfigurationBean

The abstract base class that all configuration beans should extend if they wish to have their configuration values centrally accessible from the AppConfiguration replicated-cache; as well as persisted to the management/*.xml files from which they originated.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractConfigurationBean.Initializer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_CLASS
protected static java.lang.String	M_BEAN_CATEGORY
static java.lang.String	NAME
static int	POF_IMPL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConfigurationBean() default constructor for this abstract base class; should be called by implementing derived classes.

Method Summary

Modifier and Type	Method and Description
protected void	broadcast() This method will make the ConfigurationBean changes available to others running on the grid via the ConfigurationBeanRepository.
java.lang.Object	clone()
boolean	equals(java.lang.Object o)
java.lang.String	getBeanId() gets the associated id for the bean.
DEvolutionData	getEvolutionData()
java.lang.String	getFilename() gets the associated filename for the bean's configuration values.
oracle.communication.brm.charging.appconfiguration.internal.AbstractConfigurationBeanImpl	getImpl() used by serializer to write the impl to the pof stream
java.lang.String	getModifyingClusterName() get the name of the cluster that modified the MBean last.
com.tangosol.util.UID	getModifyingMemberId() gets the coherence MemberId for the Management Enabled Coherence Node that last modified this MBean.
void	giveInitializerTo(DEvolvableHelper evolvableHelper)
protected abstract void	handlePrintConfiguration(Logger logger) Method used by subclasses to dump their configuration settings to a log file.
int	hashCode()
void	printConfiguration(Logger logger) Method used to dump all configurations to a log file
protected <T> boolean	publish(java.lang.String fieldPath, java.lang.String fieldName, T value) This method is used to update multi-level attributes in the ConfigurationBean.
protected <T> boolean	publish(java.lang.String fieldName, T value) This method is used to update a top-level attribute in the ConfigurationBean.
protected boolean	publishArrayItem(java.lang.String arrayItemPath, java.lang.Class arrayItemClass, java.util.Map<java.lang.String,java.lang.Object> fieldNameAndValues) This method is used to add a new item to an already existing array.
protected boolean	publishClearArray(java.lang.String arrayItemPath) This method is used to clear an array.
protected boolean	publishRemoveArrayItem(java.lang.String arrayItemPath, int index) This method is used to remove an item from an array.
protected void	registerBean(oracle.communication.brm.charging.appconfiguration.ConfigurationBean bean, java.lang.String name) Registers an MBean on the MBean server.
void	setBeanId(java.lang.String id) sets the associated id for the configuration bean.
void	setEvolutionData(DEvolutionData data)
void	setFilename(java.lang.String name) sets the associated filename for the bean's configuration values.
void	setModifyingClusterName(java.lang.String modifyingClusterName) set the name of the cluster that modified the MBean last.
java.lang.String	toBinary() Returns the binary representation of the implementing class to be compared for regression testing after rolling upgrade.
java.lang.String	toString()
protected void	unRegisterBean(java.lang.String name) Un-registers an MBean from the MBean server.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.communication.brm.charging.appconfiguration.ConfigurationBean

republishAll

Field Detail

POF_IMPL

public static final int POF_IMPL

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

CONFIG_CLASS

public static final java.lang.String CONFIG_CLASS

See Also:

Constant Field Values

M_BEAN_CATEGORY

protected static final java.lang.String M_BEAN_CATEGORY

See Also:

Constant Field Values

Constructor Detail

AbstractConfigurationBean

protected AbstractConfigurationBean()

default constructor for this abstract base class; should be called by implementing derived classes.

Method Detail

giveInitializerTo

public void giveInitializerTo(DEvolvableHelper evolvableHelper)

setFilename

public void setFilename(java.lang.String name)

Description copied from interface: oracle.communication.brm.charging.appconfiguration.ConfigurationBean

sets the associated filename for the bean's configuration values. Subclasses do not need to call this method, it will be called by the ConfigurationBeanRepository when the beans are spring injection into the repository.

Specified by:

setFilename in interface oracle.communication.brm.charging.appconfiguration.ConfigurationBean

Parameters:

name - the filename

getFilename

public java.lang.String getFilename()

Description copied from interface: oracle.communication.brm.charging.appconfiguration.ConfigurationBean

gets the associated filename for the bean's configuration values. This is the name of the xml file that contains the persisted configuation value which are associated with this bean.

Specified by:

getFilename in interface oracle.communication.brm.charging.appconfiguration.ConfigurationBean

Returns:

the associated filename for the bean's configuration values.

setBeanId

public void setBeanId(java.lang.String id)

Description copied from interface: oracle.communication.brm.charging.appconfiguration.ConfigurationBean

sets the associated id for the configuration bean. This is the id that is used to lookup the bean from the ConfigurationBeanRepository. Subclasses do not need to call this method, it will be called by the ConfigurationBeanRepository when the beans are spring injection into the repository.

Specified by:

setBeanId in interface oracle.communication.brm.charging.appconfiguration.ConfigurationBean

Parameters:

id - the name of the bean, used to set the bean id. This will identify the bean inside the the ConfigurationBeanRepository.

getBeanId

public java.lang.String getBeanId()

Description copied from interface: oracle.communication.brm.charging.appconfiguration.ConfigurationBean

gets the associated id for the bean. This is the id that is used to lookup the bean from the ConfigurationBeanRepository.

Specified by:

getBeanId in interface oracle.communication.brm.charging.appconfiguration.ConfigurationBean

Returns:

the associated id for the bean.

getModifyingMemberId

public com.tangosol.util.UID getModifyingMemberId()

Description copied from interface: oracle.communication.brm.charging.appconfiguration.ConfigurationBean

gets the coherence MemberId for the Management Enabled Coherence Node that last modified this MBean.

Specified by:

getModifyingMemberId in interface oracle.communication.brm.charging.appconfiguration.ConfigurationBean

Returns:

the coherence MemberId in UID format. A UID value of -1 means the bean has never been modified via JMX.

getModifyingClusterName

public java.lang.String getModifyingClusterName()

Description copied from interface: oracle.communication.brm.charging.appconfiguration.ConfigurationBean

get the name of the cluster that modified the MBean last. This is used for DR and deciding when to re-publish the xml file.

Specified by:

getModifyingClusterName in interface oracle.communication.brm.charging.appconfiguration.ConfigurationBean

Returns:

the name of the cluster that modified the MBean last.

setModifyingClusterName

public void setModifyingClusterName(java.lang.String modifyingClusterName)

Description copied from interface: oracle.communication.brm.charging.appconfiguration.ConfigurationBean

set the name of the cluster that modified the MBean last. This is used for DR and deciding when to re-publish the xml file.

Specified by:

setModifyingClusterName in interface oracle.communication.brm.charging.appconfiguration.ConfigurationBean

printConfiguration

public void printConfiguration(Logger logger)

Description copied from interface: oracle.communication.brm.charging.appconfiguration.ConfigurationBean

Method used to dump all configurations to a log file

Specified by:

printConfiguration in interface oracle.communication.brm.charging.appconfiguration.ConfigurationBean

Parameters:

logger - the log where values should dumped. Subclasses should log there configuration value using the INFO log level.

publish

protected <T> boolean publish(java.lang.String fieldName,
                              T value)

This method is used to update a top-level attribute in the ConfigurationBean. The newly modified field will be re-written to the xml file. This field must already exist in the current xml file in order to be updated and published.

Type Parameters:

T - the type of the value

Parameters:

fieldName - the name of the field to update

value - the new value of the field.

Returns:

true if the new value was successfully published to the xml file.

publish

protected <T> boolean publish(java.lang.String fieldPath,
                              java.lang.String fieldName,
                              T value)

This method is used to update multi-level attributes in the ConfigurationBean. The newly modified field will be re-written to the xml file. This field must already exist in the current xml file in order to be updated and published. The fieldPath directs the method to the location of the field in the ConfigurationBean. If the field resides in an array list, then you must provide the index of the array as part of the fieldPath. For example, fieldPath = "CarConfig.TireArray.Tire(2)" and fieldName = "maxAirPressured" and value= "32" indicates that the 3rd Tire in the array should have its maxAirPressure updated to 32 psi.

Type Parameters:

T - the type of the value

Parameters:

fieldPath - the indexed pathname to the configuration field that needs to be updated.

fieldName - the name of the field to update

value - the new value of the field.

Returns:

true if the new value was successfully published to the xml file.

publishArrayItem

protected boolean publishArrayItem(java.lang.String arrayItemPath,
                                   java.lang.Class arrayItemClass,
                                   java.util.Map<java.lang.String,java.lang.Object> fieldNameAndValues)

This method is used to add a new item to an already existing array. The arrayItemPath directs the method to the full name of the array item. Do not provide array indexes in the arrayItemPath, the new item will be added to the end of the already existing array. You must also to provide the names and values of the fields that reside in the arrayItem so they can be created with default values. (This is required to support xsd validation) For example: arrayItemPath = "CarConfig.TireArray.Tire" and arrayItem = "Tire.class" and key/value maps entries {{"maxTirePressure", 32}, {"maxSpeed", 120}} will create a new item in the array with the "maxTirePressure" and "maxSpeed" attributes initialized to 32 and 120.

Parameters:

arrayItemPath - the path to the array item that should be added to the array.

arrayItemClass - the class type of the array item

fieldNameAndValues - the map of key/value pairs to be set in the new array item.

Returns:

true if the new value was successfully published to the xml file.

publishRemoveArrayItem

protected boolean publishRemoveArrayItem(java.lang.String arrayItemPath,
                                         int index)

This method is used to remove an item from an array. The arrayItemPath directs the method to the full name of the array item to be removed. Do not provide array indexes in the arrayItemPath; instead provide the index of the item to be removed in a separate argument. For example: arrayItemPath = "CarConfig.TireArray.Tire" with index = 0 means that the zero element in the TireArray will be deleted.

Parameters:

arrayItemPath - the path to the array item that should be added to the array.

index - the index of the array item to be removed

Returns:

true if the array item was successfully removed and published to the xml file.

publishClearArray

protected boolean publishClearArray(java.lang.String arrayItemPath)

This method is used to clear an array. The arrayPath directs the method to the full name of the array to be cleared.

Parameters:

arrayItemPath - the path to the array that should be cleared.

Returns:

true if the array was successfully cleared and published to the xml file.

broadcast

protected void broadcast()

This method will make the ConfigurationBean changes available to others running on the grid via the ConfigurationBeanRepository. Also, when running a multi-coherence management enabled topology, all other MBean are refreshed on the grid.

registerBean

protected void registerBean(oracle.communication.brm.charging.appconfiguration.ConfigurationBean bean,
                            java.lang.String name)

Registers an MBean on the MBean server.

Parameters:

bean - to register

name - to register under

unRegisterBean

protected void unRegisterBean(java.lang.String name)

Un-registers an MBean from the MBean server.

Parameters:

name - bean name to un- register

handlePrintConfiguration

protected abstract void handlePrintConfiguration(Logger logger)

Method used by subclasses to dump their configuration settings to a log file.

Parameters:

logger - the logger is provided to subclassers for writing their config values.

getEvolutionData

public DEvolutionData getEvolutionData()

setEvolutionData

public void setEvolutionData(DEvolutionData data)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getImpl

public oracle.communication.brm.charging.appconfiguration.internal.AbstractConfigurationBeanImpl getImpl()

used by serializer to write the impl to the pof stream

Returns:

the impl instance.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toBinary

public java.lang.String toBinary()
                          throws java.io.IOException

Returns the binary representation of the implementing class to be compared for regression testing after rolling upgrade. It uses the implementing class POF Serializer for that matter.

Returns:

Binary representation of implementing class.

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object