com.sun.jbi.management.registry

Interface GenericQuery

All Known Implementing Classes:

GenericQueryImpl

public interface GenericQuery

This interface encapsulates queries which are common to all targets ( domain / server / cluster ).

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAttribute(ConfigurationCategory type, String name) Get the value of a configuration attribute belonging to the specified category, for the runtime target.
String	getAttribute(String targetName, ConfigurationCategory type, String name) Get the value of a configuration attribute belonging to the specified category, for the specified target.
List<String>	getClusters()
List<String>	getClustersDeployingServiceAssembly(String serviceAssemblyName)
List<String>	getClustersInstallingComponent(String componentName)
List<String>	getClustersInstallingSharedLibrary(String sharedLibraryName)
String	getComponentArchive(String componentName)
ComponentDescriptor	getComponentDescriptor(String componentName)
String	getComponentFileName(String componentName) Get the file name for the domain component.
String	getComponentInstallationDescriptor(String componentName)
long	getComponentTimestamp(String componentName) Get the timestamp for the domain component.
ComponentType	getComponentType(String componentName)
BigInteger	getComponentUpgradeNumber(String componentName) This method is used to get the value of the attribute upgrade-number from the domain level entry for the component in the registry
List<String>	getRegisteredComponents()
List<String>	getRegisteredServiceAssemblies()
List<String>	getRegisteredSharedLibraries()
List<String>	getServers()
List<String>	getServersDeployingServiceAssembly(String serviceAssemblyName)
List<String>	getServersInstallingComponent(String componentName)
List<String>	getServersInstallingSharedLibrary(String sharedLibraryName)
String	getServiceAssemblyArchive(String serviceAssemblyName)
String	getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)
String	getServiceAssemblyFileName(String saName) Get the file name for the domain service assembly.
long	getServiceAssemblyTimestamp(String saName) Get the timestamp for the domain service assembly.
String	getServiceUnitDeploymentDescriptor(String serviceAssemblyName, String serviceUnitName)
String	getSharedLibraryArchive(String sharedLibraryName)
String	getSharedLibraryFileName(String slName) Get the file name for the domain shared library.
String	getSharedLibraryInstallationDescriptor(String sharedLibraryName)
long	getSharedLibraryTimestamp(String slName) Get the timestamp for the domain shared library.
boolean	isAttributeOverriden(String targetName, ConfigurationCategory type, String name) Determine if a configuration attribute is overriden by a target.
boolean	isComponentInstalled(String componentName)
boolean	isComponentRegistered(String componentName)
boolean	isGlobalConfigurationDefined() Determine if the domain configuration is present in the registry
boolean	isServiceAssemblyDeployed(String serviceAssemblyName)
boolean	isServiceAssemblyRegistered(String serviceAssemblyName)
boolean	isSharedLibraryInstalled(String sharedLibraryName)
boolean	isSharedLibraryRegistered(String sharedLibraryName)
boolean	isSystemComponent(String componentName) This method is used to find out if this is a schemaorg_apache_xmlbeans.system component.
boolean	isSystemSharedLibrary(String sharedLibraryName) This method is used to find out if this is a schemaorg_apache_xmlbeans.system shared library This method returns the value of schemaorg_apache_xmlbeans.system-install attribute for this shared library from the registry A shared library that has schemaorg_apache_xmlbeans.system-install set to true will have its install root under AS_INSTALL/jbi and it should not be deleted on uninstall

Method Detail

getServersInstallingComponent

List<String> getServersInstallingComponent(String componentName)
                                           throws RegistryException

Parameters:

componentName - - Component name

Returns:

a List of all servers installing a component. The List excludes all non-clustered servers.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getServersInstallingSharedLibrary

List<String> getServersInstallingSharedLibrary(String sharedLibraryName)
                                               throws RegistryException

Parameters:

sharedLibraryName - - Shared Library name

Returns:

a List of all servers installing a shared library. The List excludes all non-clustered servers.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getServersDeployingServiceAssembly

List<String> getServersDeployingServiceAssembly(String serviceAssemblyName)
                                                throws RegistryException

Parameters:

serviceAssemblyName - - Service Assembly name

Returns:

a List of all servers deploying a service assembly. The List excludes all non-clustered servers.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getClustersInstallingComponent

List<String> getClustersInstallingComponent(String componentName)
                                            throws RegistryException

Parameters:

componentName - - Component name

Returns:

a List of all clusters installing a component.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getClustersInstallingSharedLibrary

List<String> getClustersInstallingSharedLibrary(String sharedLibraryName)
                                                throws RegistryException

Parameters:

sharedLibraryName - - Shared Library name

Returns:

a List of all clusters installing a shared library.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getClustersDeployingServiceAssembly

List<String> getClustersDeployingServiceAssembly(String serviceAssemblyName)
                                                 throws RegistryException

Parameters:

serviceAssemblyName - - Service Assembly name

Returns:

a List of all clusters deploying a service assembly. The List excludes all non-clustered servers.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getComponentInstallationDescriptor

String getComponentInstallationDescriptor(String componentName)
                                          throws RegistryException

Parameters:

componentName - - component name

Returns:

the Installation descriptor for the component.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getComponentDescriptor

ComponentDescriptor getComponentDescriptor(String componentName)
                                           throws RegistryException

Parameters:

componentName - - component name

Returns:

wrapper for the Installation descriptor for the component.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getSharedLibraryInstallationDescriptor

String getSharedLibraryInstallationDescriptor(String sharedLibraryName)
                                              throws RegistryException

Parameters:

sharedLibraryName - - shared library name

Returns:

the Installation descriptor for the shared library.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getServiceAssemblyDeploymentDescriptor

String getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)
                                              throws RegistryException

Parameters:

serviceAssemblyName - - service assembly name

Returns:

the Installation descriptor for the component.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getServiceUnitDeploymentDescriptor

String getServiceUnitDeploymentDescriptor(String serviceAssemblyName,
                                        String serviceUnitName)
                                          throws RegistryException

Parameters:

serviceAssemblyName - - service assembly name

serviceUnitName - - service unit name

Returns:

the Installation descriptor for the service unit.

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getServiceAssemblyArchive

String getServiceAssemblyArchive(String serviceAssemblyName)
                                 throws RegistryException

Parameters:

serviceAssemblyName - - service assembly name

Returns:

the filename for the associated archive

Throws:

RegistryException - if a problem exists.

getComponentArchive

String getComponentArchive(String componentName)
                           throws RegistryException

Parameters:

componentName - - component name

Returns:

the filename for the associated archive

Throws:

RegistryException - if a problem exists.

getSharedLibraryArchive

String getSharedLibraryArchive(String sharedLibraryName)
                               throws RegistryException

Parameters:

sharedLibraryName - - sharedLibrary name

Returns:

the filename for the associated archive

Throws:

RegistryException - if a problem exists.

isComponentInstalled

boolean isComponentInstalled(String componentName)
                             throws RegistryException

Returns:

true if a component is installed on one or more servers / clusters

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

isSharedLibraryInstalled

boolean isSharedLibraryInstalled(String sharedLibraryName)
                                 throws RegistryException

Returns:

true if a shared library is installed on one or more servers / clusters

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

isServiceAssemblyDeployed

boolean isServiceAssemblyDeployed(String serviceAssemblyName)
                                  throws RegistryException

Returns:

true if a service assembly is deployed on one or more servers / clusters

Throws:

RegistryException - if a read lock cannot be acquired to access the in-memory Registry.

getComponentType

ComponentType getComponentType(String componentName)
                               throws RegistryException

Throws:

RegistryException

getServers

List<String> getServers()
                        throws RegistryException

Returns:

a list of Servers from the registry

Throws:

RegistryException

getClusters

List<String> getClusters()
                         throws RegistryException

Returns:

a list of Clusters from the registry

Throws:

RegistryException

isSharedLibraryRegistered

boolean isSharedLibraryRegistered(String sharedLibraryName)
                                  throws RegistryException

Returns:

true if the Shared Library is registered in the domain.

Throws:

RegistryException

isServiceAssemblyRegistered

boolean isServiceAssemblyRegistered(String serviceAssemblyName)
                                    throws RegistryException

Returns:

true if the Service Assembly is registered in the domain.

Throws:

RegistryException

isComponentRegistered

boolean isComponentRegistered(String componentName)
                              throws RegistryException

Returns:

true if the component is registered in the domain.

Throws:

RegistryException

getRegisteredServiceAssemblies

List<String> getRegisteredServiceAssemblies()
                                            throws RegistryException

Returns:

a List of Service Assemblies registered in the domain.

Throws:

RegistryException

getRegisteredSharedLibraries

List<String> getRegisteredSharedLibraries()
                                          throws RegistryException

Returns:

a List of Shared Libraries registered in the domain.

Throws:

RegistryException

getRegisteredComponents

List<String> getRegisteredComponents()
                                     throws RegistryException

Returns:

a List of Components registered in the domain.

Throws:

RegistryException

isSystemComponent

boolean isSystemComponent(String componentName)
                          throws RegistryException

This method is used to find out if this is a schemaorg_apache_xmlbeans.system component. This method returns the value of schemaorg_apache_xmlbeans.system-install attribute for this component from the registry A component that has schemaorg_apache_xmlbeans.system-install set to true will have its install root under AS_INSTALL/jbi and it should not be deleted on unload of the component's uninstaller.

Parameters:

componentName - the name of the component

Returns:

boolean true if schemaorg_apache_xmlbeans.system-install is true, false otherwise

Throws:

RegistryException

isSystemSharedLibrary

boolean isSystemSharedLibrary(String sharedLibraryName)
                              throws RegistryException

This method is used to find out if this is a schemaorg_apache_xmlbeans.system shared library This method returns the value of schemaorg_apache_xmlbeans.system-install attribute for this shared library from the registry A shared library that has schemaorg_apache_xmlbeans.system-install set to true will have its install root under AS_INSTALL/jbi and it should not be deleted on uninstall

Parameters:

sharedLibraryName - the name of the shared library

Returns:

boolean true if schemaorg_apache_xmlbeans.system-install is true, false otherwise

Throws:

RegistryException

getComponentFileName

String getComponentFileName(String componentName)
                            throws RegistryException

Get the file name for the domain component.

Parameters:

componentName - - component name

Throws:

RegistryException

getSharedLibraryFileName

String getSharedLibraryFileName(String slName)
                                throws RegistryException

Get the file name for the domain shared library.

Parameters:

slName - - shared library name

Throws:

RegistryException

getServiceAssemblyFileName

String getServiceAssemblyFileName(String saName)
                                  throws RegistryException

Get the file name for the domain service assembly.

Parameters:

saName - - service assembly name

Throws:

RegistryException

getComponentTimestamp

long getComponentTimestamp(String componentName)
                           throws RegistryException

Get the timestamp for the domain component.

Parameters:

componentName - - component name

Throws:

RegistryException

getSharedLibraryTimestamp

long getSharedLibraryTimestamp(String slName)
                               throws RegistryException

Get the timestamp for the domain shared library.

Parameters:

slName - - shared library name

Throws:

RegistryException

getServiceAssemblyTimestamp

long getServiceAssemblyTimestamp(String saName)
                                 throws RegistryException

Get the timestamp for the domain service assembly.

Parameters:

saName - - service assembly name

Throws:

RegistryException

getComponentUpgradeNumber

BigInteger getComponentUpgradeNumber(String componentName)
                                     throws RegistryException

This method is used to get the value of the attribute upgrade-number from the domain level entry for the component in the registry

Parameters:

componentName - the componentName

Returns:

BigInteger the upgrade number

Throws:

RegistryException - if the upgrade number could not be retrieved

getAttribute

String getAttribute(ConfigurationCategory type,
                  String name)
                    throws RegistryException

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

Parameters:

type - - configuration category

name - - identification for the attribute

Returns:

the String representation of the attributes value

Throws:

RegistryException - on errors in getting the attribute value

getAttribute

String getAttribute(String targetName,
                  ConfigurationCategory type,
                  String name)
                    throws RegistryException

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

Parameters:

targetName - - target instance/cluster name.

type - - configuration category

name - - identification for the attribute

Returns:

the String representation of the attributes value

Throws:

RegistryException - on errors in getting the attribute value

isAttributeOverriden

boolean isAttributeOverriden(String targetName,
                           ConfigurationCategory type,
                           String name)

Determine if a configuration attribute is overriden by a target.

Parameters:

targetName - - target instance/cluster name.

type - - configuration category

name - - identification for the attribute

Returns:

true if the attribute is overriden by a target

isGlobalConfigurationDefined

boolean isGlobalConfigurationDefined()

Determine if the domain configuration is present in the registry

Returns:

true if the domain-config is defined in the registry