com.sun.jbi.management.registry.xml

Class GenericQueryImpl

java.lang.Object

com.sun.jbi.management.registry.xml.GenericQueryImpl

All Implemented Interfaces:

GenericQuery

public class GenericQueryImpl
extends Object
implements GenericQuery

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

Author:

Sun Microsystems, Inc.

Constructor Summary

Constructors

Constructor and Description
GenericQueryImpl(Jbi jbi, ManagementContext mgtCtx, boolean validate, RegistryImpl registry)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doesComponentDeployServiceAssembly(ComponentRefType componentRef, String serviceAssemblyName)
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)
DomainComponentType	getComponent(String componentName) Search for a domain Component with the specified componentName
ComponentRefType	getComponent(String componentName, String targetName)
String	getComponentArchive(String componentName) /**
ComponentDescriptor	getComponentDescriptor(String componentName) Get the wrapper for the JAXB model for the installation descriptor for a component.
String	getComponentFileName(String componentName) Get the file name for the domain component.
String	getComponentInstallationDescriptor(String componentName)
Jbi	getComponentJbi(String componentName)
ComponentState	getComponentState(String componentName, String targetName) Return the state of the component on the specified target.
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
ConfigType	getConfig(String targetName) Get a particular configuration for a target.
ConfigCategoryType	getConfigCategory(String targetName, ConfigurationCategory type) Get a particular configuration category in a target configuration.
String	getConfigName(String targetName)
InstalledComponentsListType	getInstalledEntities(String targetName)
Map	getPropertyMap(List<PropertyType> propertyList)
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)
DomainEntityType	getServiceAssembly(String saName) Search for a domain Service Assembly with the specified saName
ServiceAssemblyRefType	getServiceAssembly(String saName, String targetName) Get the ServiceAssemblyRef for a service assembly.
String	getServiceAssemblyArchive(String saName)
String	getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)
String	getServiceAssemblyFileName(String saName) Get the file name for the domain service assembly.
Jbi	getServiceAssemblyJbi(String serviceAssemblyName)
long	getServiceAssemblyTimestamp(String saName) Get the file name for the domain service assembly.
String	getServiceUnitDeploymentDescriptor(String serviceAssemblyName, String serviceUnitName)
DomainSharedLibraryType	getSharedLibrary(String slName) Search for a domain Shared Library with the specified slName
SharedLibraryRefType	getSharedLibrary(String slName, String targetName)
String	getSharedLibraryArchive(String sharedLibraryName)
String	getSharedLibraryFileName(String slName) Get the file name for the domain shared library.
String	getSharedLibraryInstallationDescriptor(String sharedLibraryName)
Jbi	getSharedLibraryJbi(String sharedLibraryName)
long	getSharedLibraryTimestamp(String slName) Get the file name 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) If a service assembly is registered in the registry and not in the repository it is removed from the repository.
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
void	removeComponentFromCache(String componentName)
void	removeServiceAssemblyFromCache(String serviceAssemblyName)
void	removeSharedLibraryFromCache(String sharedLibraryName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericQueryImpl

public GenericQueryImpl(Jbi jbi,
                ManagementContext mgtCtx,
                boolean validate,
                RegistryImpl registry)

Method Detail

getServersInstallingComponent

public List<String> getServersInstallingComponent(String componentName)
                                           throws RegistryException

Specified by:

getServersInstallingComponent in interface GenericQuery

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

public List<String> getServersInstallingSharedLibrary(String sharedLibraryName)
                                               throws RegistryException

Specified by:

getServersInstallingSharedLibrary in interface GenericQuery

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

public List<String> getServersDeployingServiceAssembly(String serviceAssemblyName)
                                                throws RegistryException

Specified by:

getServersDeployingServiceAssembly in interface GenericQuery

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

public List<String> getClustersInstallingComponent(String componentName)
                                            throws RegistryException

Specified by:

getClustersInstallingComponent in interface GenericQuery

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

public List<String> getClustersInstallingSharedLibrary(String sharedLibraryName)
                                                throws RegistryException

Specified by:

getClustersInstallingSharedLibrary in interface GenericQuery

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

public List<String> getClustersDeployingServiceAssembly(String serviceAssemblyName)
                                                 throws RegistryException

Specified by:

getClustersDeployingServiceAssembly in interface GenericQuery

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

public String getComponentInstallationDescriptor(String componentName)
                                          throws RegistryException

Specified by:

getComponentInstallationDescriptor in interface GenericQuery

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

public ComponentDescriptor getComponentDescriptor(String componentName)
                                           throws RegistryException

Get the wrapper for the JAXB model for the installation descriptor for a component.

Specified by:

getComponentDescriptor in interface GenericQuery

Parameters:

componentName - - component name

Returns:

the wrapper for the installation descriptor for the component.

Throws:

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

getComponentJbi

public Jbi getComponentJbi(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.

getSharedLibraryInstallationDescriptor

public String getSharedLibraryInstallationDescriptor(String sharedLibraryName)
                                              throws RegistryException

Specified by:

getSharedLibraryInstallationDescriptor in interface GenericQuery

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.

getSharedLibraryJbi

public Jbi getSharedLibraryJbi(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

public String getServiceAssemblyDeploymentDescriptor(String serviceAssemblyName)
                                              throws RegistryException

Specified by:

getServiceAssemblyDeploymentDescriptor in interface GenericQuery

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

public String getServiceUnitDeploymentDescriptor(String serviceAssemblyName,
                                        String serviceUnitName)
                                          throws RegistryException

Specified by:

getServiceUnitDeploymentDescriptor in interface GenericQuery

Parameters:

serviceAssemblyName - - service assembly name

serviceUnitName - - service unit name

Returns:

the deployment descriptor for the service unit.

Throws:

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

getServiceAssemblyJbi

public Jbi getServiceAssemblyJbi(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.

getServiceAssemblyArchive

public String getServiceAssemblyArchive(String saName)
                                 throws RegistryException

Specified by:

getServiceAssemblyArchive in interface GenericQuery

Parameters:

saName - - service assembly name

Returns:

the filename for the associated archive

Throws:

RegistryException - if a problem exists.

getComponentArchive

public String getComponentArchive(String componentName)
                           throws RegistryException

/**

Specified by:

getComponentArchive in interface GenericQuery

Parameters:

componentName - - component name

Returns:

the filename for the associated archive

Throws:

RegistryException - if a problem exists.

getSharedLibraryArchive

public String getSharedLibraryArchive(String sharedLibraryName)
                               throws RegistryException

Specified by:

getSharedLibraryArchive in interface GenericQuery

Parameters:

sharedLibraryName - - sharedLibrary name

Returns:

the filename for the associated archive

Throws:

RegistryException - if a problem exists.

isComponentInstalled

public boolean isComponentInstalled(String componentName)
                             throws RegistryException

Specified by:

isComponentInstalled in interface GenericQuery

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

public boolean isSharedLibraryInstalled(String sharedLibraryName)
                                 throws RegistryException

Specified by:

isSharedLibraryInstalled in interface GenericQuery

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

public boolean isServiceAssemblyDeployed(String serviceAssemblyName)
                                  throws RegistryException

Specified by:

isServiceAssemblyDeployed in interface GenericQuery

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.

getServers

public List<String> getServers()
                        throws RegistryException

Specified by:

getServers in interface GenericQuery

Returns:

a List of Servers in the registry

Throws:

RegistryException

getClusters

public List<String> getClusters()
                         throws RegistryException

Specified by:

getClusters in interface GenericQuery

Returns:

a List of Clusters in the registry

Throws:

RegistryException

removeComponentFromCache

public void removeComponentFromCache(String componentName)

removeServiceAssemblyFromCache

public void removeServiceAssemblyFromCache(String serviceAssemblyName)

removeSharedLibraryFromCache

public void removeSharedLibraryFromCache(String sharedLibraryName)

getComponentType

public ComponentType getComponentType(String componentName)
                               throws RegistryException

Specified by:

getComponentType in interface GenericQuery

Throws:

RegistryException

getComponentState

public ComponentState getComponentState(String componentName,
                               String targetName)
                                 throws RegistryException

Return the state of the component on the specified target.

Throws:

RegistryException

isComponentRegistered

public boolean isComponentRegistered(String componentName)
                              throws RegistryException

Specified by:

isComponentRegistered in interface GenericQuery

Returns:

true if the component is registered in the domain.

Throws:

RegistryException

isSharedLibraryRegistered

public boolean isSharedLibraryRegistered(String sharedLibraryName)
                                  throws RegistryException

Specified by:

isSharedLibraryRegistered in interface GenericQuery

Returns:

true if the Shared Library is registered in the domain.

Throws:

RegistryException

isServiceAssemblyRegistered

public boolean isServiceAssemblyRegistered(String serviceAssemblyName)
                                    throws RegistryException

If a service assembly is registered in the registry and not in the repository it is removed from the repository. If a service assembly is registered in the repository and not in the registry then the service assembly is removed from the domain entry as well as any other installed entry.

Specified by:

isServiceAssemblyRegistered in interface GenericQuery

Returns:

true if the service assembly is there in registry and repository

Throws:

RegistryException

getRegisteredServiceAssemblies

public List<String> getRegisteredServiceAssemblies()
                                            throws RegistryException

Specified by:

getRegisteredServiceAssemblies in interface GenericQuery

Returns:

a List of Service Assemblies registered in the domain.

Throws:

RegistryException

getRegisteredSharedLibraries

public List<String> getRegisteredSharedLibraries()
                                          throws RegistryException

Specified by:

getRegisteredSharedLibraries in interface GenericQuery

Returns:

a List of Shared Libraries registered in the domain.

Throws:

RegistryException

getRegisteredComponents

public List<String> getRegisteredComponents()
                                     throws RegistryException

Specified by:

getRegisteredComponents in interface GenericQuery

Returns:

a List of Components registered in the domain.

Throws:

RegistryException

isSystemComponent

public 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.

Specified by:

isSystemComponent in interface GenericQuery

Parameters:

componentName - the name of the component

Returns:

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

Throws:

RegistryException

isSystemSharedLibrary

public 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

Specified by:

isSystemSharedLibrary in interface GenericQuery

Parameters:

sharedLibraryName - the name of the shared library

Returns:

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

Throws:

RegistryException

doesComponentDeployServiceAssembly

public boolean doesComponentDeployServiceAssembly(ComponentRefType componentRef,
                                         String serviceAssemblyName)
                                           throws RegistryException

Throws:

RegistryException

getComponent

public DomainComponentType getComponent(String componentName)
                                 throws RegistryException

Search for a domain Component with the specified componentName

Returns:

the Component with the specified name null if not found

Throws:

RegistryException

getComponent

public ComponentRefType getComponent(String componentName,
                            String targetName)
                              throws RegistryException

Throws:

RegistryException

getSharedLibrary

public DomainSharedLibraryType getSharedLibrary(String slName)
                                         throws RegistryException

Search for a domain Shared Library with the specified slName

Returns:

the SharedLibrary with the specified name null if not found

Throws:

RegistryException

getSharedLibrary

public SharedLibraryRefType getSharedLibrary(String slName,
                                    String targetName)
                                      throws RegistryException

Throws:

RegistryException

getServiceAssembly

public DomainEntityType getServiceAssembly(String saName)
                                    throws RegistryException

Search for a domain Service Assembly with the specified saName

Returns:

the SharedLibrary with the specified name null if not found

Throws:

RegistryException

getServiceAssembly

public ServiceAssemblyRefType getServiceAssembly(String saName,
                                        String targetName)
                                          throws RegistryException

Get the ServiceAssemblyRef for a service assembly.

Parameters:

saName - - service assembly name

targetName - - server/cluster name

Throws:

RegistryException - on errors

getComponentFileName

public String getComponentFileName(String componentName)
                            throws RegistryException

Get the file name for the domain component.

Specified by:

getComponentFileName in interface GenericQuery

Parameters:

componentName - - component name

Throws:

RegistryException

getSharedLibraryFileName

public String getSharedLibraryFileName(String slName)
                                throws RegistryException

Get the file name for the domain shared library.

Specified by:

getSharedLibraryFileName in interface GenericQuery

Parameters:

slName - - shared library name

Throws:

RegistryException

getServiceAssemblyFileName

public String getServiceAssemblyFileName(String saName)
                                  throws RegistryException

Get the file name for the domain service assembly.

Specified by:

getServiceAssemblyFileName in interface GenericQuery

Parameters:

saName - - service assembly name

Throws:

RegistryException

getComponentTimestamp

public long getComponentTimestamp(String componentName)
                           throws RegistryException

Get the timestamp for the domain component.

Specified by:

getComponentTimestamp in interface GenericQuery

Parameters:

componentName - - component name

Throws:

RegistryException

getSharedLibraryTimestamp

public long getSharedLibraryTimestamp(String slName)
                               throws RegistryException

Get the file name for the domain shared library.

Specified by:

getSharedLibraryTimestamp in interface GenericQuery

Parameters:

slName - - shared library name

Throws:

RegistryException

getServiceAssemblyTimestamp

public long getServiceAssemblyTimestamp(String saName)
                                 throws RegistryException

Get the file name for the domain service assembly.

Specified by:

getServiceAssemblyTimestamp in interface GenericQuery

Parameters:

saName - - service assembly name

Throws:

RegistryException

getInstalledEntities

public InstalledComponentsListType getInstalledEntities(String targetName)
                                                 throws RegistryException

Throws:

RegistryException

getComponentUpgradeNumber

public 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

Specified by:

getComponentUpgradeNumber in interface GenericQuery

Parameters:

componentName - the componentName

Returns:

BigInteger the upgrade number

Throws:

RegistryException - if the upgrade number could not be retrieved

getAttribute

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

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

Specified by:

getAttribute in interface GenericQuery

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

public 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.

Specified by:

getAttribute in interface GenericQuery

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

isGlobalConfigurationDefined

public boolean isGlobalConfigurationDefined()

Determine if the domain configuration is present in the registry

Specified by:

isGlobalConfigurationDefined in interface GenericQuery

Returns:

true if the domain-config is defined in the registry

getConfigName

public String getConfigName(String targetName)

Returns:

the configuration name based on the target name

isAttributeOverriden

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

Determine if a configuration attribute is overriden by a target.

Specified by:

isAttributeOverriden in interface GenericQuery

Parameters:

targetName - - target instance/cluster name.

type - - configuration category

name - - identification for the attribute

Returns:

true if the attribute is overriden by a target

getPropertyMap

public Map getPropertyMap(List<PropertyType> propertyList)

Parameters:

propertyList - a list of PropertyType elements

Returns:

the properties in a category in map keyed by the property name.

getConfigCategory

public ConfigCategoryType getConfigCategory(String targetName,
                                   ConfigurationCategory type)

Get a particular configuration category in a target configuration.

Parameters:

targetName - - target instance/cluster name.

type - - configuration category

Returns:

the Configuration Category handle if found or null otherwise

getConfig

public ConfigType getConfig(String targetName)

Get a particular configuration for a target.

Parameters:

targetName - - target instance/cluster name.

Returns:

the Configuration for the target if found or null otherwise