| com.sun.jbi.management.registry.Updater
All known Subclasses: com.sun.jbi.management.registry.xml.UpdaterImpl, com.sun.jbi.framework.ScaffoldRegistry,
| Updater | | public interface Updater (Code) | | This interface defines operations which clients can use to update the registry.
author:
Sun Microsystems, Inc. |
| Method Summary | |
| void | addCluster(String clusterNameRef)
| | void | addComponent(ComponentInfo componentInfo)
| | void | addComponent(String targetName, ComponentInfo componentInfo)
Add a component to a given target. | | void | addComponent(String componentName, String fileName, Calendar timestamp)
| | 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, com.sun.jbi.management.ComponentInfo.Variable[] appVars)
Add a set of application variables to the registry for the runtime target. | | void | addComponentApplicationVariables(String componentName, String targetName, com.sun.jbi.management.ComponentInfo.Variable[] appVars)
Add a set of application variables to the registry for the specified target. | | void | addServer(String serverNameRef)
| | void | addServiceAssembly(String saName)
| | void | addServiceAssembly(String targetName, String saName)
Add a service assembly to a given target. | | public void | addServiceAssembly(String saName, String fileName, Calendar timestamp)
Add a service assembly to the domain. | | void | addServiceUnitToComponent(String componentName, ServiceUnitInfo suInfo)
| | void | addServiceUnitToComponent(String targetName, String componentName, ServiceUnitInfo suInfo)
| | void | addSharedLibrary(ComponentInfo sharedLibraryInfo)
| | void | addSharedLibrary(String targetName, ComponentInfo sharedLibraryInfo)
Add a shared library to a given target. | | void | addSharedLibrary(String slName, String fileName, Calendar timestamp)
| | 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)
| | void | deleteComponentApplicationConfiguration(String componentName, String targetName, String appConfigName)
| | 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)
| | 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)
| | void | removeServiceUnitFromComponent(String targetName, String componentName, String suName)
| | void | removeSharedLibrary(String sharedLibraryName)
| | 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)
| | 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)
| | 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.
Parameters:
targetName - - either the server-name or cluster-name, this operation is a no-op when target = domain.
Parameters:
componentName - - component name
Parameters:
props - - the properties to set. | | void | setComponentState(ComponentState state, String componentName)
Set the state of a component for the target at runtime.
Parameters:
componentName - - component name
Parameters:
state - - the state to set. | | void | setComponentState(String targetName, ComponentState state, String componentName)
Set the state of a component in a server/cluster.
Parameters:
targetName - - either the server-name or cluster-name
Parameters:
componentName - - component name
Parameters:
state - - the state to set. | | void | setComponentUpgradeNumber(String componentName, java.math.BigInteger upgradeNumber)
| | 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.
Parameters:
componentName - - component name
Parameters:
suName - - service unit name
Parameters:
state - - the state to set. | | void | setServiceUnitState(String targetName, ServiceUnitState state, String componentName, String suName)
Set the state of a ServiceUnit in a server / cluster.
Parameters:
targetName - - either the value 'domain', 'server' or theserver-name or cluster-name.
Parameters:
componentName - - component name
Parameters:
suName - - service unit name
Parameters:
state - - the state to set. | | 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, com.sun.jbi.management.ComponentInfo.Variable[] appVars)
Update a set of application variables to the registry for the runtime target. | | void | updateComponentApplicationVariables(String componentName, String targetName, com.sun.jbi.management.ComponentInfo.Variable[] appVars)
Updated a set of application variables to the registry for the specified target. |
| addComponent | | void addComponent(String targetName, ComponentInfo componentInfo) throws RegistryException(Code) | | 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.
Parameters:
componentInfo - - component instance
throws:
RegistryException - on errors |
| addComponent | | void addComponent(String componentName, String fileName, Calendar timestamp) throws RegistryException(Code) | | Add a domain component
Parameters:
componentName - - name of the component
Parameters:
fileName - - component file name |
| addComponentApplicationConfiguration | | void addComponentApplicationConfiguration(String componentName, Properties appConfig) throws RegistryException(Code) | | Add a named application configuration to the registry for the component for the
implicit runtime target.
Parameters:
componentName - component identification
Parameters:
appConfig - named application configuration represented as properties
exception:
RegistryException - on errors in adding the application configuration. |
| addComponentApplicationConfiguration | | void addComponentApplicationConfiguration(String componentName, String targetName, Properties appConfig) throws RegistryException(Code) | | Add a named application configuration to the registry for the component for the
specified runtime target.
Parameters:
componentName - component identification
Parameters:
appConfig - named application configuration represented as properties
Parameters:
targetName - target name
exception:
RegistryException - on errors in adding the application configuration. |
| addComponentApplicationVariables | | void addComponentApplicationVariables(String componentName, com.sun.jbi.management.ComponentInfo.Variable[] appVars) throws RegistryException(Code) | | 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
exception:
RegistryException - on errors in adding the application variables. |
| addComponentApplicationVariables | | void addComponentApplicationVariables(String componentName, String targetName, com.sun.jbi.management.ComponentInfo.Variable[] appVars) throws RegistryException(Code) | | 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
Parameters:
targetName - - target to be updated
exception:
RegistryException - on errors in adding the application variables. |
| addServiceAssembly | | void addServiceAssembly(String targetName, String saName) throws RegistryException(Code) | | 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"}
Parameters:
saName - - service assembly name
throws:
RegistryException - on errors |
| addServiceAssembly | | public void addServiceAssembly(String saName, String fileName, Calendar timestamp) throws RegistryException(Code) | | Add a service assembly to the domain.
Parameters:
saName - - service assembly name
Parameters:
fileName - - service assembly archive name
throws:
RegistryException - on errors |
| addServiceUnitToComponent | | void addServiceUnitToComponent(String componentName, ServiceUnitInfo suInfo) throws RegistryException(Code) | | Add a ServiceUnit to a Component for the runtime target
Parameters:
suInfo - - ServiceUnitInfo
Parameters:
componentName - - component name
throws:
RegistryException - on errors |
| addServiceUnitToComponent | | void addServiceUnitToComponent(String targetName, String componentName, ServiceUnitInfo suInfo) throws RegistryException(Code) | | Add a ServiceUnit to a Component
Parameters:
suInfo - - ServiceUnitInfo
Parameters:
targetName - - either the value 'domain', 'server' or theserver-name or cluster-name.
Parameters:
componentName - - component name
throws:
RegistryException - on errors |
| addSharedLibrary | | void addSharedLibrary(String targetName, ComponentInfo sharedLibraryInfo) throws RegistryException(Code) | | 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"}
Parameters:
ComponentInfo - - shared library info
throws:
RegistryException - on errors |
| addSharedLibrary | | void addSharedLibrary(String slName, String fileName, Calendar timestamp) throws RegistryException(Code) | | Add a domain shared library
Parameters:
slName - - name of the shared library
Parameters:
fileName - - component file name |
| deleteAttribute | | void deleteAttribute(ConfigurationCategory type, String name) throws RegistryException(Code) | | 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
Parameters:
name - - identification for the attribute
exception:
RegistryException - on errors in getting the attribute value |
| deleteAttribute | | void deleteAttribute(String targetName, ConfigurationCategory type, String name) throws RegistryException(Code) | | 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.
Parameters:
type - - configuration category
Parameters:
name - - identification for the attribute
exception:
RegistryException - on errors in getting the attribute value |
| deleteComponentApplicationConfiguration | | void deleteComponentApplicationConfiguration(String componentName, String appConfigName) throws RegistryException(Code) | | Delete a named application configuration
Parameters:
appConfigName - name of the application configuration to delete.
Parameters:
componentName - component identification
exception:
RegistryException - on errors in deleting the application configuration. |
| deleteComponentApplicationConfiguration | | void deleteComponentApplicationConfiguration(String componentName, String targetName, String appConfigName) throws RegistryException(Code) | | Delete a named application configuration
Parameters:
componentName - component identification
Parameters:
targetName - target name
Parameters:
appConfigName - the name of the configuration to be deleted.
exception:
RegistryException - on errors in deleting the application configuration. |
| deleteComponentApplicationVariables | | void deleteComponentApplicationVariables(String componentName, String[] names) throws RegistryException(Code) | | 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
Parameters:
names - - the names of the variables to be deleted.
exception:
RegistryException - on errors in deleting the application variables. |
| deleteComponentApplicationVariables | | void deleteComponentApplicationVariables(String componentName, String targetName, String[] names) throws RegistryException(Code) | | 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
Parameters:
targetName - - target to be updated
Parameters:
names - - the names of the variables to be deleted.
exception:
RegistryException - on errors in deleting the application variables. |
| removeComponent | | void removeComponent(String targetName, String componentName) throws RegistryException(Code) | | Remove a component from a given target.
Parameters:
targetName - - {'domain', 'server', "instance-name", "cluster-name"}
Parameters:
componentName - - component name
throws:
RegistryException - on errors |
| removeServiceAssembly | | void removeServiceAssembly(String serviceAssemblyName) throws RegistryException(Code) | | 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(Code) | | Remove a service assembly from a given target.
Parameters:
serviceAssemblyName - - service assembly name
Parameters:
targetName - - {'domain', 'server', "instance-name", "cluster-name"}
throws:
RegistryException - on errors |
| removeServiceUnitFromComponent | | void removeServiceUnitFromComponent(String componentName, String suName) throws RegistryException(Code) | | Remove a ServiceUnit from a Component for the runtime target
Parameters:
suName - - ServiceUnitInfo name
Parameters:
componentName - - component name
throws:
RegistryException - on errors |
| removeServiceUnitFromComponent | | void removeServiceUnitFromComponent(String targetName, String componentName, String suName) throws RegistryException(Code) | | Remove a ServiceUnit from a Component
Parameters:
suName - - ServiceUnitInfo name
Parameters:
targetName - - the server-name or cluster-name.
Parameters:
componentName - - component name
throws:
RegistryException - on errors |
| removeSharedLibrary | | void removeSharedLibrary(String sharedLibraryName) throws RegistryException(Code) | | 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(Code) | | Remove a shared library from a given target.
Parameters:
targetName - - {'domain', 'server', "instance-name", "cluster-name"}
Parameters:
sharedLibraryName - - shared library name
throws:
RegistryException - on errors |
| setAttribute | | void setAttribute(ConfigurationCategory type, String name, String value) throws RegistryException(Code) | | Set the value of a configuration attribute belonging to the
specified category, for the runtime target.
Parameters:
type - - configuration category
Parameters:
name - - identification for the attribute
Parameters:
value - - string representation of the attribute value
exception:
RegistryException - on errors in getting the attribute value |
| setAttribute | | void setAttribute(String targetName, ConfigurationCategory type, String name, String value) throws RegistryException(Code) | | Get the value of a configuration attribute belonging to the
specified category, for the runtime target.
Parameters:
targetName - - target instance/cluster name.
Parameters:
type - - configuration category
Parameters:
name - - identification for the attribute
Parameters:
value - - string representation of the attribute value
exception:
RegistryException - on errors in getting the attribute value |
| setComponentAttribute | | void setComponentAttribute(String componentName, String name, String value) throws RegistryException(Code) | | Set the value of a configuration attribute for a component installed on a target
for the runtime target.
Parameters:
name - - identification for the attribute
Parameters:
value - - string representation of the attribute value
Parameters:
componentName - - identification for the component
exception:
RegistryException - on errors in setting the attribute value |
| setComponentAttribute | | void setComponentAttribute(String componentName, String targetName, String name, String value) throws RegistryException(Code) | | Set the value of a configuration attribute for a component installed on a target,
Parameters:
targetName - - target instance/cluster name.
Parameters:
name - - identification for the attribute
Parameters:
value - - string representation of the attribute value
Parameters:
componentName - - identification for the component
exception:
RegistryException - on errors in setting the attribute value |
| setComponentAttributes | | void setComponentAttributes(String componentName, Properties props) throws RegistryException(Code) | | Set the value of a configuration attribute for a component installed on a target
for the runtime target.
Parameters:
props - - properties to set
Parameters:
componentName - - identification for the component
exception:
RegistryException - on errors in setting the attribute value |
| setComponentAttributes | | void setComponentAttributes(String componentName, String targetName, Properties props) throws RegistryException(Code) | | Set the value of a configuration attribute for a component installed on a target,
Parameters:
targetName - - target instance/cluster name.
Parameters:
props - - properties to set
Parameters:
componentName - - identification for the component
exception:
RegistryException - on errors in setting the attribute value |
| setComponentFileName | | void setComponentFileName(String fileName, String componentName) throws RegistryException(Code) | | Set the file name for the domain component.
Parameters:
fileName - - name of the component archive
Parameters:
componentName - - component name |
| setComponentProperties | | void setComponentProperties(String targetName, Map<String, String> state, String componentName) throws RegistryException(Code) | | 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.
Parameters:
componentName - - component name
Parameters:
props - - the properties to set.
throws:
RegistryException - on errors |
| setComponentState | | void setComponentState(String targetName, ComponentState state, String componentName) throws RegistryException(Code) | | Set the state of a component in a server/cluster.
Parameters:
targetName - - either the server-name or cluster-name
Parameters:
componentName - - component name
Parameters:
state - - the state to set.
throws:
RegistryException - on errors |
| setComponentUpgradeNumber | | void setComponentUpgradeNumber(String componentName, java.math.BigInteger upgradeNumber) throws RegistryException(Code) | | This method is used to set the upgrade-number attribute in the domain
level entry for a component
Parameters:
componentName - the component name
Parameters:
upgradeNumber - the upgrade number
throws:
RegistryException - if the upgrade number could not be set |
| setServiceAssemblyFileName | | void setServiceAssemblyFileName(String fileName, String saName) throws RegistryException(Code) | | Set the file name for the domain service assembly.
Parameters:
fileName - - name of the service assembly archive
Parameters:
saName - - service assembly name |
| setServiceAssemblyState | | void setServiceAssemblyState(String targetName, ServiceAssemblyState state, String saName) throws RegistryException(Code) | | Set the state of a ServiceAssembly in a server / cluster.
Parameters:
targetName - - either the value 'domain', 'server' or theserver-name or cluster-name.
Parameters:
saName - - service assembly name
Parameters:
state - - the state to set.
throws:
RegistryException - on errors |
| setServiceUnitState | | void setServiceUnitState(ServiceUnitState state, String componentName, String suName) throws RegistryException(Code) | | Set the state of a ServiceUnit for the runtime target.
Parameters:
componentName - - component name
Parameters:
suName - - service unit name
Parameters:
state - - the state to set.
throws:
RegistryException - on errors |
| setServiceUnitState | | void setServiceUnitState(String targetName, ServiceUnitState state, String componentName, String suName) throws RegistryException(Code) | | Set the state of a ServiceUnit in a server / cluster.
Parameters:
targetName - - either the value 'domain', 'server' or theserver-name or cluster-name.
Parameters:
componentName - - component name
Parameters:
suName - - service unit name
Parameters:
state - - the state to set.
throws:
RegistryException - on errors |
| setSharedLibraryFileName | | void setSharedLibraryFileName(String fileName, String slName) throws RegistryException(Code) | | Set the file name for the domain shared library.
Parameters:
fileName - - name of the shared library archive
Parameters:
slName - - shared library name |
| updateComponentApplicationConfiguration | | void updateComponentApplicationConfiguration(String componentName, Properties appConfig) throws RegistryException(Code) | | Update a named application configuration set on a component
for the implicit runtime target.
Parameters:
componentName - component identification
Parameters:
appConfig - named application configuration represented as properties
exception:
RegistryException - on errors in updating the application configuration. |
| updateComponentApplicationConfiguration | | void updateComponentApplicationConfiguration(String componentName, String targetName, Properties appConfig) throws RegistryException(Code) | | Update a named application configuration set on a component
for the specified runtime target.
Parameters:
componentName - component identification
Parameters:
appConfig - named application configuration represented as properties
Parameters:
targetName - target name
exception:
RegistryException - on errors in updating the application configuration. |
| updateComponentApplicationVariables | | void updateComponentApplicationVariables(String componentName, com.sun.jbi.management.ComponentInfo.Variable[] appVars) throws RegistryException(Code) | | Update a set of application variables to the registry for the runtime target.
Parameters:
appVars - - list of application variables to be updated
exception:
RegistryException - on errors in updating the application variables. |
| updateComponentApplicationVariables | | void updateComponentApplicationVariables(String componentName, String targetName, com.sun.jbi.management.ComponentInfo.Variable[] appVars) throws RegistryException(Code) | | Updated a set of application variables to the registry for the specified target.
Parameters:
appVars - - list of application variables to be updated
Parameters:
targetName - - target to be updated
exception:
RegistryException - on errors in updating the application variables. |
|
|