com.eibus.management

Interface IManagedComponent

public interface IManagedComponent

This interface describes a managed Cordys component. Managed components can have sub-components, setting, operations, performance counters and notifications.

Author:

Bert Roos

Method Summary

Modifier and Type	Method and Description
void	addLegacyPropertyProvider(java.lang.String prefix, ILegacySettingProvider legacyPropertyProvider) Registers a legacy property provider for a given legacy property prefix.
<T extends ICounter> T	createPerformanceCounter(java.lang.String name, ILocalizableString description, CounterFactory<T> counterTypeFactory) Creates a performance counter of a given type, with a given name and description.
<T extends ICounter> T	createPerformanceCounter(java.lang.String name, java.lang.String description, CounterFactory<T> counterTypeFactory) Deprecated. since C2. Use the localizable createPerformanceCounter instead
void	createPropertyBasedValueCounter(java.lang.String name, ILocalizableString description, java.beans.PropertyDescriptor propertyDescr, java.lang.Object sourceObject) Creates a property based value counter with a given name.
void	createPropertyBasedValueCounter(java.lang.String name, ILocalizableString description, java.lang.String propertyName, java.lang.Object sourceObject) Creates a property based value counter with a given name.
void	createPropertyBasedValueCounter(java.lang.String name, java.lang.String description, java.beans.PropertyDescriptor propertyDescr, java.lang.Object sourceObject) Deprecated. since C2. Use the localizable createPropertyBasedValueCounter instead
void	createPropertyBasedValueCounter(java.lang.String name, java.lang.String description, java.lang.String propertyName, java.lang.Object sourceObject) Deprecated. since C2. Use the localizable createPropertyBasedValueCounter instead
ISettingsCollection	createSettingsCollection(ISettingsPersistenceHandler persistenceHandler) Creates a default settings collection given the specified settings persistence handler.
ISettingsCollection	createSettingsCollection(java.lang.String name, ISettingsPersistenceHandler persistenceHandler) Creates a named settings collection given the specified settings persistence handler.
IManagedComponent	createSubComponent(java.lang.String type, java.lang.String name, ILocalizableString description, java.lang.Object componentImpl) Creates a nested sub-component inside this component.
IManagedComponent	createSubComponent(java.lang.String type, java.lang.String name, java.lang.String description, java.lang.Object componentImpl) Deprecated. since C2. Use the localizable createSubComponent instead
IAlertDefinition	defineAlert(AlertLevel level, IStringResource message, IStringResource description) Defines an alert that can be issued by this managed component.
void	defineInfoAttribute(java.lang.String name, ILocalizableString description, java.beans.PropertyDescriptor propertyDescr, java.lang.Object sourceObject) Defines an informational attribute of a managed component, based on a property of a class or object.
void	defineInfoAttribute(java.lang.String name, ILocalizableString description, java.lang.String propertyName, java.lang.Object sourceObject) Defines an informational attribute of a managed component, based on a property of a class or object.
void	defineOperation(java.lang.String name, ILocalizableString description, java.lang.String methodName, java.lang.Object targetObject, OperationImpact impact, IParameterDefinition<?>... parameters) Defines an operation with a given name, description and parameters, based on a given method name.
void	defineOperation(java.lang.String name, java.lang.String description, java.lang.String methodName, java.lang.Object targetObject, IParameterDefinition<?>[] parameters, OperationImpact impact) Deprecated. since C2. Use the localizable defineOperation method instead.
IProblemDefinition	defineProblem(IStringResource problemRaiseAlertMessage, IStringResource problemRaiseAlertDescription, IStringResource problemClearAlertMessage, IStringResource problemClearAlertDescription) Defines an problem that can be raised by this managed component.
java.lang.Object	getComponentImpl() Retrieves the actual component implementation.
java.util.Collection<ICounter>	getCounters(java.lang.String counterName) Retrieves the counter(s) with the given name.
java.lang.String	getFullName() Returns the full component name, that's the name of this component prefixed by the names of its parent components, separated by '/'.
java.lang.String	getName() Returns the component name.
IManagedComponent	getParent() Returns the parent managed component of this component.
ISettingsCollection	getSettingsCollection() Returns the default settings collection
ISettingsCollection	getSettingsCollection(java.lang.String name) Returns a named settings collection.
java.lang.Object	getSettingValue(java.lang.String name) Returns the value of a setting denoted by the given name.
java.util.Collection<IManagedComponent>	getSubComponents() Returns an iterator on the set of sub-components of this component.
java.util.Collection<IManagedComponent>	getSubComponents(java.lang.String name) Return the sub-components with the given name.
void	registerComponentTree() Registers the component tree to make it available for management tools.
void	unregisterComponentTree() Unregisters the component tree, causing all necessary cleanup actions to be performed.

Method Detail

createPerformanceCounter

@Deprecated
<T extends ICounter> T createPerformanceCounter(java.lang.String name,
                                                             java.lang.String description,
                                                             CounterFactory<T> counterTypeFactory)

Deprecated. since C2. Use the localizable createPerformanceCounter instead

Creates a performance counter of a given type, with a given name and description.

Parameters:

name - the name of the new counter

description - cannot be a null or empty string.

counterTypeFactory - The factory for the required counter type

Returns:

the counter

createPerformanceCounter

<T extends ICounter> T createPerformanceCounter(java.lang.String name,
                                                ILocalizableString description,
                                                CounterFactory<T> counterTypeFactory)

Creates a performance counter of a given type, with a given name and description.

Parameters:

name - the name of the new counter

description - The localizable description of the new counter (cannot be a null).

counterTypeFactory - The factory for the required counter type

Returns:

the counter

createPropertyBasedValueCounter

@Deprecated
void createPropertyBasedValueCounter(java.lang.String name,
                                                  java.lang.String description,
                                                  java.beans.PropertyDescriptor propertyDescr,
                                                  java.lang.Object sourceObject)

Deprecated. since C2. Use the localizable createPropertyBasedValueCounter instead

Creates a property based value counter with a given name.

Parameters:

name - The name of the new counter

description - cannot be a null or empty string.

propertyDescr - The descriptor of the property supplying the counter value

sourceObject - The source object on which to invoke the getter method. This parameter can a class when the getter method is static. When null, the managed component is used as source object.

createPropertyBasedValueCounter

void createPropertyBasedValueCounter(java.lang.String name,
                                     ILocalizableString description,
                                     java.beans.PropertyDescriptor propertyDescr,
                                     java.lang.Object sourceObject)

Creates a property based value counter with a given name.

Parameters:

name - The name of the new counter

description - The localizable description of the new counter (cannot be a null).

propertyDescr - The descriptor of the property supplying the counter value

sourceObject - The source object on which to invoke the getter method. This parameter can a class when the getter method is static. When null, the managed component is used as source object.

createPropertyBasedValueCounter

@Deprecated
void createPropertyBasedValueCounter(java.lang.String name,
                                                  java.lang.String description,
                                                  java.lang.String propertyName,
                                                  java.lang.Object sourceObject)

Deprecated. since C2. Use the localizable createPropertyBasedValueCounter instead

Creates a property based value counter with a given name.

Parameters:

name - The name of the new counter

description - cannot be a null or empty string.

propertyName - The name of the property supplying the counter value

sourceObject - The source object on which to invoke the getter method. In case of a static property, this should be the class.

createPropertyBasedValueCounter

void createPropertyBasedValueCounter(java.lang.String name,
                                     ILocalizableString description,
                                     java.lang.String propertyName,
                                     java.lang.Object sourceObject)

Creates a property based value counter with a given name.

Parameters:

name - The name of the new counter

description - The localizable description of the new counter (cannot be a null).

propertyName - The name of the property supplying the counter value

sourceObject - The source object on which to invoke the getter method. In case of a static property, this should be the class.

createSettingsCollection

ISettingsCollection createSettingsCollection(ISettingsPersistenceHandler persistenceHandler)

Creates a default settings collection given the specified settings persistence handler. Only a single default settings collection can be created. This settings collection is automatically made available to nested sub-components.

Parameters:

persistenceHandler - the persistence handler for this default settings collection.

Returns:

the default settings collection

createSettingsCollection

ISettingsCollection createSettingsCollection(java.lang.String name,
                                             ISettingsPersistenceHandler persistenceHandler)

Creates a named settings collection given the specified settings persistence handler. The name of the settings collection must be unique. This settings collection is automatically made available to nested sub-components.

Parameters:

name - the name of the settings collection to be created.

persistenceHandler - the persistence handler for this default settings collection.

Returns:

the default settings collection

createSubComponent

@Deprecated
IManagedComponent createSubComponent(java.lang.String type,
                                                  java.lang.String name,
                                                  java.lang.String description,
                                                  java.lang.Object componentImpl)

Deprecated. since C2. Use the localizable createSubComponent instead

Creates a nested sub-component inside this component.

Parameters:

type - The type of sub-component. E.g. dbConnectionPool, soapConnector, ldapCache, etc.

name - The name of the sub-component.

description - The description of the sub-component

componentImpl - The object actually implementing the sub-component

Returns:

The created managed sub-component object.

createSubComponent

IManagedComponent createSubComponent(java.lang.String type,
                                     java.lang.String name,
                                     ILocalizableString description,
                                     java.lang.Object componentImpl)

Creates a nested sub-component inside this component.

Parameters:

type - The type of sub-component. E.g. dbConnectionPool, soapConnector, ldapCache, etc.

name - The name of the sub-component.

description - The localizable description of the new sub-component (cannot be a null).

componentImpl - The object actually implementing the sub-component

Returns:

The created managed sub-component object.

getComponentImpl

java.lang.Object getComponentImpl()

Retrieves the actual component implementation.

Returns:

the actual component implementation

getName

java.lang.String getName()

Returns the component name.

Returns:

The component name.

getFullName

java.lang.String getFullName()

Returns the full component name, that's the name of this component prefixed by the names of its parent components, separated by '/'.

Returns:

The full component name.

getParent

IManagedComponent getParent()

Returns the parent managed component of this component. Returns null for the root component.

Returns:

the parent managed component of this component or null for the root component.

getSettingsCollection

ISettingsCollection getSettingsCollection()

Returns the default settings collection

Returns:

the default settings collection or null when the default settings collection has not been created.

getSettingsCollection

ISettingsCollection getSettingsCollection(java.lang.String name)

Returns a named settings collection.

Parameters:

name - the name of the settings collection to be returned.

Returns:

the requested settings collection or null when this settings collection has not been created

getSettingValue

java.lang.Object getSettingValue(java.lang.String name)

Returns the value of a setting denoted by the given name.

Parameters:

name - the name of the setting whose value is to be retrieved

Returns:

the value of the specified setting.

addLegacyPropertyProvider

void addLegacyPropertyProvider(java.lang.String prefix,
                               ILegacySettingProvider legacyPropertyProvider)

Registers a legacy property provider for a given legacy property prefix. The names of all legacy properties must be prefixed to indicate the legacy property provider that's to be used to retrieve the legacy property value.

Parameters:

prefix - The legacy property prefix.

legacyPropertyProvider - The legacy property provider.

registerComponentTree

void registerComponentTree()

Registers the component tree to make it available for management tools.

unregisterComponentTree

void unregisterComponentTree()

Unregisters the component tree, causing all necessary cleanup actions to be performed. This method must be called prior to process exit.

getSubComponents

java.util.Collection<IManagedComponent> getSubComponents()

Returns an iterator on the set of sub-components of this component.

Returns:

an iterator on the set of sub-components of this component.

getSubComponents

java.util.Collection<IManagedComponent> getSubComponents(java.lang.String name)

Return the sub-components with the given name. Passing a '*' implies that all direct and indirect sub-components of this component are returned.

Parameters:

name - the full name of the sub-component to retrieve; pass '*' to get all direct and indirect sub-compponents

Returns:

the requested sub-components

getCounters

java.util.Collection<ICounter> getCounters(java.lang.String counterName)

Retrieves the counter(s) with the given name. Pass '*' to get all counters.

Parameters:

counterName - the name of the counter to retrieve. Pass '*' to reset all counters.

defineOperation

@Deprecated
void defineOperation(java.lang.String name,
                                  java.lang.String description,
                                  java.lang.String methodName,
                                  java.lang.Object targetObject,
                                  IParameterDefinition<?>[] parameters,
                                  OperationImpact impact)

Deprecated. since C2. Use the localizable defineOperation method instead.

Defines an operation with a given name, description and parameters, based on a given method name.

Parameters:

name - The name of the new operation

description - cannot be a null or empty string.

methodName - The name of the method implementing this operation

targetObject - The object on which to invoke the operation method. This parameter can be a class when the method is static. When null, the managed component is used as target object.

parameters - The set of parameters of the new operation

impact - The impact of the operation.

defineOperation

void defineOperation(java.lang.String name,
                     ILocalizableString description,
                     java.lang.String methodName,
                     java.lang.Object targetObject,
                     OperationImpact impact,
                     IParameterDefinition<?>... parameters)

Defines an operation with a given name, description and parameters, based on a given method name.

Parameters:

name - The name of the new operation

description - The localizable description of the new operation (cannot be a null).

methodName - The name of the method implementing this operation

targetObject - The object on which to invoke the operation method. This parameter can be a class when the method is static. When null, the managed component is used as target object.

impact - The impact of the operation.

parameters - The set of parameters of the new operation

defineAlert

IAlertDefinition defineAlert(AlertLevel level,
                             IStringResource message,
                             IStringResource description)

Defines an alert that can be issued by this managed component.

Parameters:

level - The level of the alert.

message - The localizable string of the alert message

description - The localizable string of the alert description

Returns:

the alert definitionM

defineProblem

IProblemDefinition defineProblem(IStringResource problemRaiseAlertMessage,
                                 IStringResource problemRaiseAlertDescription,
                                 IStringResource problemClearAlertMessage,
                                 IStringResource problemClearAlertDescription)

Defines an problem that can be raised by this managed component.

Parameters:

problemRaiseAlertMessage - The localizable string of the alert message that's issued when raising the problem

problemRaiseAlertDescription - The localizable string of the alert description that's issued when raising the problem

problemClearAlertMessage - The localizable string of the alert message that's issued when clearing the problem

problemClearAlertDescription - The localizable string of the alert description that's issued when clearing the problem

Returns:

the problem definition

defineInfoAttribute

void defineInfoAttribute(java.lang.String name,
                         ILocalizableString description,
                         java.beans.PropertyDescriptor propertyDescr,
                         java.lang.Object sourceObject)

Defines an informational attribute of a managed component, based on a property of a class or object. The value of this attribute can be retrieved through JMX.

Parameters:

name - The name of the new informational attribute

description - The localizable description of the informational attribute (cannot be a null).

propertyDescr - The descriptor of the property supplying the value for the informational attribute The source object on which to invoke the getter method. This parameter can be null when the getter method is static.

sourceObject - The source object on which to invoke the getter method. In case of a static property, this should be the class.

defineInfoAttribute

void defineInfoAttribute(java.lang.String name,
                         ILocalizableString description,
                         java.lang.String propertyName,
                         java.lang.Object sourceObject)

Defines an informational attribute of a managed component, based on a property of a class or object. The value of this attribute can be retrieved through JMX.

Parameters:

name - The name of the new informational attribute

description - The localizable description of the informational attribute (cannot be a null).

propertyName - The name of the property supplying the value for the informational attribute

sourceObject - The source object on which to invoke the getter method. In case of a static property, this should be the class.