com.sun.jbi.management.registry

Interface Updater

All Known Implementing Classes:

UpdaterImpl

public interface Updater

This interface defines operations which clients can use to update the registry.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCluster(String clusterNameRef)
void	addComponent(ComponentInfo componentInfo) Add a component to the runtime target
void	addComponent(String targetName, ComponentInfo componentInfo) Add a component to a given target.
void	addComponent(String componentName, String fileName, Calendar timestamp) Add a domain component
void	addComponentApplicationConfiguration(String componentName, Properties appConfig) Add a named application configuration to the registry for the component for the implicit runtime target.
void	addComponentApplicationConfiguration(String componentName, String targetName, Properties appConfig) Add a named application configuration to the registry for the component for the specified runtime target.
void	addComponentApplicationVariables(String componentName, ComponentInfo.Variable[] appVars) Add a set of application variables to the registry for the runtime target.
void	addComponentApplicationVariables(String componentName, String targetName, ComponentInfo.Variable[] appVars) Add a set of application variables to the registry for the specified target.
void	addServer(String serverNameRef)
void	addServiceAssembly(String saName) Add a service assembly to he runtime's target
void	addServiceAssembly(String targetName, String saName) Add a service assembly to a given target.
void	addServiceAssembly(String saName, String fileName, Calendar timestamp) Add a service assembly to the domain.
void	addServiceUnitToComponent(String componentName, ServiceUnitInfo suInfo) Add a ServiceUnit to a Component for the runtime target
void	addServiceUnitToComponent(String targetName, String componentName, ServiceUnitInfo suInfo) Add a ServiceUnit to a Component
void	addSharedLibrary(ComponentInfo sharedLibraryInfo) Add a shared library to he runtime's target
void	addSharedLibrary(String targetName, ComponentInfo sharedLibraryInfo) Add a shared library to a given target.
void	addSharedLibrary(String slName, String fileName, Calendar timestamp) Add a domain shared library
void	deleteAttribute(ConfigurationCategory type, String name) Delete the named attribute from the category if it exists, for the implicit target.
void	deleteAttribute(String targetName, ConfigurationCategory type, String name) Delete the named attribute from the category if it exists.
void	deleteComponentApplicationConfiguration(String componentName, String appConfigName) Delete a named application configuration
void	deleteComponentApplicationConfiguration(String componentName, String targetName, String appConfigName) Delete a named application configuration
void	deleteComponentApplicationVariables(String componentName, String[] names) Delete a set of application variables from the registry for the runtime target.
void	deleteComponentApplicationVariables(String componentName, String targetName, String[] names) Add a set of application variables to the registry for the specified target.
void	removeCluster(String clusterNameRef)
void	removeComponent(String componentName) Remove a component from the runtime's target
void	removeComponent(String targetName, String componentName) Remove a component from a given target.
void	removeServer(String serverNameRef)
void	removeServiceAssembly(String serviceAssemblyName) Remove a service assembly from a given target.
void	removeServiceAssembly(String targetName, String serviceAssemblyName) Remove a service assembly from a given target.
void	removeServiceUnitFromComponent(String componentName, String suName) Remove a ServiceUnit from a Component for the runtime target
void	removeServiceUnitFromComponent(String targetName, String componentName, String suName) Remove a ServiceUnit from a Component
void	removeSharedLibrary(String sharedLibraryName) Remove a shared library from the runtimes target
void	removeSharedLibrary(String targetName, String sharedLibraryName) Remove a shared library from a given target.
void	setAttribute(ConfigurationCategory type, String name, String value) Set the value of a configuration attribute belonging to the specified category, for the runtime target.
void	setAttribute(String targetName, ConfigurationCategory type, String name, String value) Get the value of a configuration attribute belonging to the specified category, for the runtime target.
void	setComponentAttribute(String componentName, String name, String value) Set the value of a configuration attribute for a component installed on a target for the runtime target.
void	setComponentAttribute(String componentName, String targetName, String name, String value) Set the value of a configuration attribute for a component installed on a target,
void	setComponentAttributes(String componentName, Properties props) Set the value of a configuration attribute for a component installed on a target for the runtime target.
void	setComponentAttributes(String componentName, String targetName, Properties props) Set the value of a configuration attribute for a component installed on a target,
void	setComponentFileName(String fileName, String componentName) Set the file name for the domain component.
void	setComponentProperties(String targetName, Map<String,String> state, String componentName) Set the properties of a component in a server/cluster.
void	setComponentState(ComponentState state, String componentName) Set the state of a component for the target at runtime.
void	setComponentState(String targetName, ComponentState state, String componentName) Set the state of a component in a server/cluster.
void	setComponentUpgradeNumber(String componentName, BigInteger upgradeNumber) This method is used to set the upgrade-number attribute in the domain level entry for a component
void	setServiceAssemblyFileName(String fileName, String saName) Set the file name for the domain service assembly.
void	setServiceAssemblyState(ServiceAssemblyState state, String saName) Set the state of a ServiceAssembly for the runtime target.
void	setServiceAssemblyState(String targetName, ServiceAssemblyState state, String saName) Set the state of a ServiceAssembly in a server / cluster.
void	setServiceUnitState(ServiceUnitState state, String componentName, String suName) Set the state of a ServiceUnit for the runtime target.
void	setServiceUnitState(String targetName, ServiceUnitState state, String componentName, String suName) Set the state of a ServiceUnit in a server / cluster.
void	setSharedLibraryFileName(String fileName, String slName) Set the file name for the domain shared library.
void	updateComponentApplicationConfiguration(String componentName, Properties appConfig) Update a named application configuration set on a component for the implicit runtime target.
void	updateComponentApplicationConfiguration(String componentName, String targetName, Properties appConfig) Update a named application configuration set on a component for the specified runtime target.
void	updateComponentApplicationVariables(String componentName, ComponentInfo.Variable[] appVars) Update a set of application variables to the registry for the runtime target.
void	updateComponentApplicationVariables(String componentName, String targetName, ComponentInfo.Variable[] appVars) Updated a set of application variables to the registry for the specified target.

Method Detail

addComponent

void addComponent(ComponentInfo componentInfo)
                  throws RegistryException

Add a component to the runtime target

Parameters:

componentInfo - - component instance

Throws:

RegistryException - on errors

addComponent

void addComponent(String targetName,
                ComponentInfo componentInfo)
                  throws RegistryException

Add a component to a given target. If target = DOMAIN, then a simple component entry is created with the component name. If the target = SERVER / CLUSTER a component-ref is added.

Parameters:

targetName - - {'domain', 'server', "instance-name", "cluster-name"} not considered when targetType = DOMAIN.

componentInfo - - component instance

Throws:

RegistryException - on errors

removeComponent

void removeComponent(String componentName)
                     throws RegistryException

Remove a component from the runtime's target

Parameters:

componentName - - component name

Throws:

RegistryException - on errors

removeComponent

void removeComponent(String targetName,
                   String componentName)
                     throws RegistryException

Remove a component from a given target.

Parameters:

targetName - - {'domain', 'server', "instance-name", "cluster-name"}

componentName - - component name

Throws:

RegistryException - on errors

addSharedLibrary

void addSharedLibrary(ComponentInfo sharedLibraryInfo)
                      throws RegistryException

Add a shared library to he runtime's target

Parameters:

ComponentInfo - - shared library info

Throws:

RegistryException - on errors

addSharedLibrary

void addSharedLibrary(String targetName,
                    ComponentInfo sharedLibraryInfo)
                      throws RegistryException

Add a shared library to a given target. If target = DOMAIN, then a simple entry is created with the library name. If the target = SERVER / CLUSTER a shared-library-ref is added.

Parameters:

targetName - - {'domain', 'server', "instance-name", "cluster-name"}

ComponentInfo - - shared library info

Throws:

RegistryException - on errors

removeSharedLibrary

void removeSharedLibrary(String sharedLibraryName)
                         throws RegistryException

Remove a shared library from the runtimes target

Parameters:

sharedLibraryName - - shared library name

Throws:

RegistryException - on errors

removeSharedLibrary

void removeSharedLibrary(String targetName,
                       String sharedLibraryName)
                         throws RegistryException

Remove a shared library from a given target.

Parameters:

targetName - - {'domain', 'server', "instance-name", "cluster-name"}

sharedLibraryName - - shared library name

Throws:

RegistryException - on errors

addServiceAssembly

void addServiceAssembly(String saName)
                        throws RegistryException

Add a service assembly to he runtime's target

Parameters:

saName - - service assembly name

Throws:

RegistryException - on errors

addServiceAssembly

void addServiceAssembly(String targetName,
                      String saName)
                        throws RegistryException

Add a service assembly to a given target. If target = DOMAIN, then a simple entry is created with the assembly name. If the target = SERVER / CLUSTER a service-assembly-ref is added.

Parameters:

targetName - - {'domain', 'server', "instance-name", "cluster-name"}

saName - - service assembly name

Throws:

RegistryException - on errors

removeServiceAssembly

void removeServiceAssembly(String serviceAssemblyName)
                           throws RegistryException

Remove a service assembly from a given target.

Parameters:

serviceAssemblyName - - service assembly name

Throws:

RegistryException - on errors

removeServiceAssembly

void removeServiceAssembly(String targetName,
                         String serviceAssemblyName)
                           throws RegistryException

Remove a service assembly from a given target.

Parameters:

serviceAssemblyName - - service assembly name

targetName - - {'domain', 'server', "instance-name", "cluster-name"}

Throws:

RegistryException - on errors

addServer

void addServer(String serverNameRef)
               throws RegistryException

Parameters:

serverNameRef - - server name to be added

Throws:

RegistryException

removeServer

void removeServer(String serverNameRef)
                  throws RegistryException

Parameters:

serverNameRef - - server name to be removed

Throws:

RegistryException

addCluster

void addCluster(String clusterNameRef)
                throws RegistryException

Parameters:

clusterNameRef - - cluster name to be added

Throws:

RegistryException

removeCluster

void removeCluster(String clusterNameRef)
                   throws RegistryException

Parameters:

clusterNameRef - - cluster name to be removed

Throws:

RegistryException

addSharedLibrary

void addSharedLibrary(String slName,
                    String fileName,
                    Calendar timestamp)
                      throws RegistryException

Add a domain shared library

Parameters:

slName - - name of the shared library

fileName - - component file name

Throws:

RegistryException

addComponent

void addComponent(String componentName,
                String fileName,
                Calendar timestamp)
                  throws RegistryException

Add a domain component

Parameters:

componentName - - name of the component

fileName - - component file name

Throws:

RegistryException

addServiceAssembly

void addServiceAssembly(String saName,
                      String fileName,
                      Calendar timestamp)
                        throws RegistryException

Add a service assembly to the domain.

Parameters:

saName - - service assembly name

fileName - - service assembly archive name

Throws:

RegistryException - on errors

setComponentState

void setComponentState(ComponentState state,
                     String componentName)
                       throws RegistryException

Set the state of a component for the target at runtime.

Parameters:

componentName - - component name

state - - the state to set.

Throws:

RegistryException - on errors

setComponentState

void setComponentState(String targetName,
                     ComponentState state,
                     String componentName)
                       throws RegistryException

Set the state of a component in a server/cluster.

Parameters:

targetName - - either the server-name or cluster-name

componentName - - component name

state - - the state to set.

Throws:

RegistryException - on errors

setComponentProperties

void setComponentProperties(String targetName,
                          Map<String,String> state,
                          String componentName)
                            throws RegistryException

Set the properties of a component in a server/cluster.

Parameters:

targetName - - either the server-name or cluster-name, this operation is a no-op when target = domain.

componentName - - component name

props - - the properties to set.

Throws:

RegistryException - on errors

setServiceUnitState

void setServiceUnitState(ServiceUnitState state,
                       String componentName,
                       String suName)
                         throws RegistryException

Set the state of a ServiceUnit for the runtime target.

Parameters:

componentName - - component name

suName - - service unit name

state - - the state to set.

Throws:

RegistryException - on errors

setServiceUnitState

void setServiceUnitState(String targetName,
                       ServiceUnitState state,
                       String componentName,
                       String suName)
                         throws RegistryException

Set the state of a ServiceUnit in a server / cluster.

Parameters:

targetName - - either the value 'domain', 'server' or the server-name or cluster-name.

componentName - - component name

suName - - service unit name

state - - the state to set.

Throws:

RegistryException - on errors

setServiceAssemblyState

void setServiceAssemblyState(ServiceAssemblyState state,
                           String saName)
                             throws RegistryException

Set the state of a ServiceAssembly for the runtime target.

Parameters:

state - - the state to set.

saName - - the service assembly name

Throws:

RegistryException - on errors

setServiceAssemblyState

void setServiceAssemblyState(String targetName,
                           ServiceAssemblyState state,
                           String saName)
                             throws RegistryException

Set the state of a ServiceAssembly in a server / cluster.

Parameters:

targetName - - either the value 'domain', 'server' or the server-name or cluster-name.

saName - - service assembly name

state - - the state to set.

Throws:

RegistryException - on errors

addServiceUnitToComponent

void addServiceUnitToComponent(String componentName,
                             ServiceUnitInfo suInfo)
                               throws RegistryException

Add a ServiceUnit to a Component for the runtime target

Parameters:

suInfo - - ServiceUnitInfo

componentName - - component name

Throws:

RegistryException - on errors

addServiceUnitToComponent

void addServiceUnitToComponent(String targetName,
                             String componentName,
                             ServiceUnitInfo suInfo)
                               throws RegistryException

Add a ServiceUnit to a Component

Parameters:

suInfo - - ServiceUnitInfo

targetName - - either the value 'domain', 'server' or the server-name or cluster-name.

componentName - - component name

Throws:

RegistryException - on errors

removeServiceUnitFromComponent

void removeServiceUnitFromComponent(String componentName,
                                  String suName)
                                    throws RegistryException

Remove a ServiceUnit from a Component for the runtime target

Parameters:

suName - - ServiceUnitInfo name

componentName - - component name

Throws:

RegistryException - on errors

removeServiceUnitFromComponent

void removeServiceUnitFromComponent(String targetName,
                                  String componentName,
                                  String suName)
                                    throws RegistryException

Remove a ServiceUnit from a Component

Parameters:

suName - - ServiceUnitInfo name

targetName - - the server-name or cluster-name.

componentName - - component name

Throws:

RegistryException - on errors

setComponentFileName

void setComponentFileName(String fileName,
                        String componentName)
                          throws RegistryException

Set the file name for the domain component.

Parameters:

fileName - - name of the component archive

componentName - - component name

Throws:

RegistryException

setSharedLibraryFileName

void setSharedLibraryFileName(String fileName,
                            String slName)
                              throws RegistryException

Set the file name for the domain shared library.

Parameters:

fileName - - name of the shared library archive

slName - - shared library name

Throws:

RegistryException

setServiceAssemblyFileName

void setServiceAssemblyFileName(String fileName,
                              String saName)
                                throws RegistryException

Set the file name for the domain service assembly.

Parameters:

fileName - - name of the service assembly archive

saName - - service assembly name

Throws:

RegistryException

setAttribute

void setAttribute(ConfigurationCategory type,
                String name,
                String value)
                  throws RegistryException

Set the value of a configuration attribute belonging to the specified category, for the runtime target.

Parameters:

type - - configuration category

name - - identification for the attribute

value - - string representation of the attribute value

Throws:

RegistryException - on errors in getting the attribute value

setAttribute

void setAttribute(String targetName,
                ConfigurationCategory type,
                String name,
                String value)
                  throws RegistryException

Get the value of a configuration attribute belonging to the specified category, for the runtime target.

Parameters:

targetName - - target instance/cluster name.

type - - configuration category

name - - identification for the attribute

value - - string representation of the attribute value

Throws:

RegistryException - on errors in getting the attribute value

deleteAttribute

void deleteAttribute(ConfigurationCategory type,
                   String name)
                     throws RegistryException

Delete the named attribute from the category if it exists, for the implicit target. The attribute is deleted only if it is overriden for the target, if target is "domain" the attribute is not deleted.

Parameters:

type - - configuration category

name - - identification for the attribute

Throws:

RegistryException - on errors in getting the attribute value

deleteAttribute

void deleteAttribute(String targetName,
                   ConfigurationCategory type,
                   String name)
                     throws RegistryException

Delete the named attribute from the category if it exists. The attribute is deleted only if it is overriden for the target, if target is "domain" the attribute is not deleted.

Parameters:

targetName - - target instance/cluster name.

type - - configuration category

name - - identification for the attribute

Throws:

RegistryException - on errors in getting the attribute value

setComponentUpgradeNumber

void setComponentUpgradeNumber(String componentName,
                             BigInteger upgradeNumber)
                               throws RegistryException

This method is used to set the upgrade-number attribute in the domain level entry for a component

Parameters:

componentName - the component name

upgradeNumber - the upgrade number

Throws:

RegistryException - if the upgrade number could not be set

setComponentAttribute

void setComponentAttribute(String componentName,
                         String name,
                         String value)
                           throws RegistryException

Set the value of a configuration attribute for a component installed on a target for the runtime target.

Parameters:

name - - identification for the attribute

value - - string representation of the attribute value

componentName - - identification for the component

Throws:

RegistryException - on errors in setting the attribute value

setComponentAttribute

void setComponentAttribute(String componentName,
                         String targetName,
                         String name,
                         String value)
                           throws RegistryException

Set the value of a configuration attribute for a component installed on a target,

Parameters:

targetName - - target instance/cluster name.

name - - identification for the attribute

value - - string representation of the attribute value

componentName - - identification for the component

Throws:

RegistryException - on errors in setting the attribute value

setComponentAttributes

void setComponentAttributes(String componentName,
                          Properties props)
                            throws RegistryException

Set the value of a configuration attribute for a component installed on a target for the runtime target.

Parameters:

props - - properties to set

componentName - - identification for the component

Throws:

RegistryException - on errors in setting the attribute value

setComponentAttributes

void setComponentAttributes(String componentName,
                          String targetName,
                          Properties props)
                            throws RegistryException

Set the value of a configuration attribute for a component installed on a target,

Parameters:

targetName - - target instance/cluster name.

props - - properties to set

componentName - - identification for the component

Throws:

RegistryException - on errors in setting the attribute value

addComponentApplicationVariables

void addComponentApplicationVariables(String componentName,
                                    ComponentInfo.Variable[] appVars)
                                      throws RegistryException

Add a set of application variables to the registry for the runtime target.

Parameters:

appVars - - list of application variables to be added to the registry

Throws:

RegistryException - on errors in adding the application variables.

addComponentApplicationVariables

void addComponentApplicationVariables(String componentName,
                                    String targetName,
                                    ComponentInfo.Variable[] appVars)
                                      throws RegistryException

Add a set of application variables to the registry for the specified target.

Parameters:

appVars - - list of application variables to be added to the registry

targetName - - target to be updated

Throws:

RegistryException - on errors in adding the application variables.

updateComponentApplicationVariables

void updateComponentApplicationVariables(String componentName,
                                       ComponentInfo.Variable[] appVars)
                                         throws RegistryException

Update a set of application variables to the registry for the runtime target.

Parameters:

appVars - - list of application variables to be updated

Throws:

RegistryException - on errors in updating the application variables.

updateComponentApplicationVariables

void updateComponentApplicationVariables(String componentName,
                                       String targetName,
                                       ComponentInfo.Variable[] appVars)
                                         throws RegistryException

Updated a set of application variables to the registry for the specified target.

Parameters:

appVars - - list of application variables to be updated

targetName - - target to be updated

Throws:

RegistryException - on errors in updating the application variables.

deleteComponentApplicationVariables

void deleteComponentApplicationVariables(String componentName,
                                       String[] names)
                                         throws RegistryException

Delete a set of application variables from the registry for the runtime target.

Parameters:

appVars - - list of application variables to be deleted from the registry

names - - the names of the variables to be deleted.

Throws:

RegistryException - on errors in deleting the application variables.

deleteComponentApplicationVariables

void deleteComponentApplicationVariables(String componentName,
                                       String targetName,
                                       String[] names)
                                         throws RegistryException

Add a set of application variables to the registry for the specified target.

Parameters:

appVars - - list of application variables to be deleted from the registry

targetName - - target to be updated

names - - the names of the variables to be deleted.

Throws:

RegistryException - on errors in deleting the application variables.

addComponentApplicationConfiguration

void addComponentApplicationConfiguration(String componentName,
                                        Properties appConfig)
                                          throws RegistryException

Add a named application configuration to the registry for the component for the implicit runtime target.

Parameters:

componentName - component identification

appConfig - named application configuration represented as properties

Throws:

RegistryException - on errors in adding the application configuration.

addComponentApplicationConfiguration

void addComponentApplicationConfiguration(String componentName,
                                        String targetName,
                                        Properties appConfig)
                                          throws RegistryException

Add a named application configuration to the registry for the component for the specified runtime target.

Parameters:

componentName - component identification

appConfig - named application configuration represented as properties

targetName - target name

Throws:

RegistryException - on errors in adding the application configuration.

updateComponentApplicationConfiguration

void updateComponentApplicationConfiguration(String componentName,
                                           Properties appConfig)
                                             throws RegistryException

Update a named application configuration set on a component for the implicit runtime target.

Parameters:

componentName - component identification

appConfig - named application configuration represented as properties

Throws:

RegistryException - on errors in updating the application configuration.

updateComponentApplicationConfiguration

void updateComponentApplicationConfiguration(String componentName,
                                           String targetName,
                                           Properties appConfig)
                                             throws RegistryException

Update a named application configuration set on a component for the specified runtime target.

Parameters:

componentName - component identification

appConfig - named application configuration represented as properties

targetName - target name

Throws:

RegistryException - on errors in updating the application configuration.

deleteComponentApplicationConfiguration

void deleteComponentApplicationConfiguration(String componentName,
                                           String appConfigName)
                                             throws RegistryException

Delete a named application configuration

Parameters:

appConfigName - name of the application configuration to delete.

componentName - component identification

Throws:

RegistryException - on errors in deleting the application configuration.

deleteComponentApplicationConfiguration

void deleteComponentApplicationConfiguration(String componentName,
                                           String targetName,
                                           String appConfigName)
                                             throws RegistryException

Delete a named application configuration

Parameters:

componentName - component identification

targetName - target name

appConfigName - the name of the configuration to be deleted.

Throws:

RegistryException - on errors in deleting the application configuration.