com.sun.jbi.management.facade

Class Facade

java.lang.Object

com.sun.jbi.management.facade.Facade

Direct Known Subclasses:

AdminService, ComponentConfiguration, ComponentExtension, ComponentLifeCycle, DeploymentService, InstallationService, Installer

public class Facade
extends Object

Base class with common funtionality for all facade mbean implementations.

Author:

Sun Microsystems, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONFIG_SCHEMA_PATH
protected static String	DOMAIN
protected static String	MASKED_FIELD_VALUE
protected static String	mComponentConfigSchema
protected EnvironmentContext	mEnvCtx
protected Logger	mLog
protected MBeanNames	mMBeanNames
protected MBeanServer	mMBeanSvr
protected ManagementContext	mMgtCtx
protected MessageBuilder	mMsgBuilder
protected PlatformContext	mPlatform
protected String	mTarget
protected StringTranslator	mTranslator
protected static String	PASSWORD
protected static String	SERVER
protected static HashMap	sTypeMap
protected static String	WORKSPACE_ROOT

Constructor Summary

Constructors

Constructor and Description
Facade(EnvironmentContext ctx, String target)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	archiveEqualityCheck(File f1, File f2, ArchiveType type, String entityName) Check if two files are identical.If the archives are not identical a Management exception is thrown indicating a different archive exists in the domain.
boolean	areAllInstancesUp(String clusterName)
protected void	componentInstallationCheck(String componentName, boolean throwExWhenInstalled) Check if a Component is installed on a target.
protected String	convertToString(Collection colxn) Convert the objects in the collection to string.
protected File	fromFileURL(String urlStr) Parses an installation zip url, strips file protocol details (if necessary) and returns a File reference.
protected List<String>	getAllTargets()
protected String	getComponentConfigurationData(String compName) Get the the "Configuration" element in the jbi.xml.
protected String	getComponentConfigurationNS(String compName) Get the namespace of the "Configuration" element in the jbi.xml, if one exists.
protected String	getComponentConfigurationSchema() Get the the "Configuration" element in the jbi.xml.
protected ObjectName	getComponentLifeCycleMBeanName(String componentName, ComponentType compType, String instanceName) Get the Component Lifecycle MBean name on an instance.
protected ComponentQuery	getComponentQuery() Get a reference to ComponentQuery.
protected ComponentQuery	getComponentQuery(String target) Get a reference to ComponentQuery.
protected ComponentState	getComponentState(String compName, String instanceName)
protected String	getComponentStateOnInstance(String compName, String instanceName) This operation invokes the getCurentState() operation on the ComponentLifeCycle MBean for a component on the instance, if the instance is running, if the instance is down the state of the Component is SHUTDOWN.
protected ComponentType	getComponentType(String componentName)
protected ObjectName	getFacadeInstallerMBeanName(String componentName) Get the Facade Installer MBean object name for a component.
protected ObjectName	getFacadeInstallerMBeanName(String componentName, ComponentType compType) Get the Facade Installer MBean object name for a component.
protected GenericQuery	getGenericQuery() Get a reference to GenericQuery.
protected MBeanServerConnection	getMBeanServerConnection(String serverName) Get an MBeanServer connection for the target
protected Registry	getRegistry() Get a reference to the JBI registry.
protected ObjectName	getRemoteAdminServiceObjectName(String instanceName)
protected Object	getRemoteAttribute(ObjectName mbeanName, String attribute, String serverName) Get attribute on the remote object with a return value.
protected Object	getRemoteAttributes(ObjectName mbeanName, String[] attributes, String serverName) Get attributes on the remote object with a return value.
protected ServiceAssemblyQuery	getServiceAssemblyQuery() Get a reference to registry Updater.
protected Updater	getUpdater() Get a reference to registry Updater.
protected void	handleClusteredInstanceFailures(String taskId, Map<String,Throwable> exceptionMap, int numInstances, String locStrKey) Handle Cluster installation failures.
protected static void	initPrimitiveTypeMap() Initialize the data structure which maps primitive types to their wrapper classes
protected void	instanceRunningCheck(String instanceName)
protected Object	invokeLocalOperation(ObjectName mbeanName, String op, Object[] params, String[] sign) Invoke a operation on a local MBean
protected Object	invokeRemoteOperation(ObjectName mbeanName, String op, Object[] params, String[] sign, String serverName) Invoke a operation on the remote object with a return value.
protected void	invokeRemoteVoidOperation(ObjectName mbeanName, String op, Object[] params, String[] sign, String serverName) Invoke a operation on the remote object w/o a return value.
protected boolean	isComponentInstalled(String compName)
protected boolean	isInstanceRunning(String instanceName)
protected boolean	isMBeanRegisteredOnInstance(ObjectName mbeanName, String serverName)
protected boolean	isSharedLibraryInstalled(String slName)
boolean	isTargetUp(String targetName) Checks to see if the Target (server, cluster) is up or down.
protected void	mbeanRegistrationCheck(String op, ObjectName mbeanName, String serverName) MBean registration check.
protected void	setRemoteAttribute(ObjectName mbeanName, Attribute attribute, String serverName) Set an attribute on the remote object with a return value.
protected Object	setRemoteAttributes(ObjectName mbeanName, AttributeList attributes, String serverName) Set an attribute on the remote object with a return value.
protected void	sharedLibraryInstallationCheck(String slName, boolean throwExWhenInstalled) Check if a SharedLibrary is installed on a target.
protected void	throwNotSupportedManagementException(String taskId)
protected String	toFileURL(String urlStr) Always returns a 208-compliant file URL based on the supplied urlStr.
protected void	unregisterComponentConfigurationMBean(String target, String compName) Unregister the Component Configuration MBean for the component.
protected void	unregisterComponentConfigurationMBean(String target, String compName, ComponentType compType) Unregister the Component Configuration MBean for the component.
protected void	unregisterComponentExtensionMBean(String target, String compName) Unregister the ComponentExtension MBean for the component.
protected void	unregisterComponentExtensionMBean(String target, String compName, ComponentType compType) Unregister the ComponentLifeCycle MBean for the component.
protected void	unregisterComponentLifeCycleMBean(String target, String compName) Unregister the ComponentLifeCycle MBean for the component.
protected void	unregisterComponentLifeCycleMBean(String target, String compName, ComponentType compType) Unregister the ComponentLifeCycle MBean for the component.
protected String	uploadFile(String serverName, String localFile) Upload a file to the specified target and return the absolute path to the file on the remote target
protected Archive	validateArchive(String archiveZipUrl, ArchiveType expectedType, String taskId) Validate the Archive

Methods inherited from class java.lang.Object

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

Field Detail

mTarget

protected String mTarget

mEnvCtx

protected EnvironmentContext mEnvCtx

mMBeanSvr

protected MBeanServer mMBeanSvr

mMBeanNames

protected MBeanNames mMBeanNames

mMsgBuilder

protected MessageBuilder mMsgBuilder

mPlatform

protected PlatformContext mPlatform

mTranslator

protected StringTranslator mTranslator

mMgtCtx

protected ManagementContext mMgtCtx

mLog

protected Logger mLog

mComponentConfigSchema

protected static String mComponentConfigSchema

sTypeMap

protected static HashMap sTypeMap

DOMAIN

protected static final String DOMAIN

See Also:

Constant Field Values

SERVER

protected static final String SERVER

See Also:

Constant Field Values

WORKSPACE_ROOT

protected static final String WORKSPACE_ROOT

See Also:

Constant Field Values

MASKED_FIELD_VALUE

protected static final String MASKED_FIELD_VALUE

See Also:

Constant Field Values

PASSWORD

protected static final String PASSWORD

See Also:

Constant Field Values

CONFIG_SCHEMA_PATH

protected static final String CONFIG_SCHEMA_PATH

See Also:

Constant Field Values

Constructor Detail

Facade

public Facade(EnvironmentContext ctx,
      String target)
       throws ManagementException

Throws:

ManagementException

Method Detail

getComponentQuery

protected ComponentQuery getComponentQuery()
                                    throws ManagementException

Get a reference to ComponentQuery.

Throws:

ManagementException

getComponentQuery

protected ComponentQuery getComponentQuery(String target)
                                    throws ManagementException

Get a reference to ComponentQuery.

Throws:

ManagementException

getGenericQuery

protected GenericQuery getGenericQuery()
                                throws ManagementException

Get a reference to GenericQuery.

Throws:

ManagementException

getUpdater

protected Updater getUpdater()
                      throws ManagementException

Get a reference to registry Updater.

Throws:

ManagementException

getServiceAssemblyQuery

protected ServiceAssemblyQuery getServiceAssemblyQuery()
                                                throws ManagementException

Get a reference to registry Updater.

Throws:

ManagementException

getRegistry

protected Registry getRegistry()

Get a reference to the JBI registry.

getMBeanServerConnection

protected MBeanServerConnection getMBeanServerConnection(String serverName)
                                                  throws ManagementException

Get an MBeanServer connection for the target

Throws:

ManagementException

invokeRemoteVoidOperation

protected void invokeRemoteVoidOperation(ObjectName mbeanName,
                             String op,
                             Object[] params,
                             String[] sign,
                             String serverName)
                                  throws ManagementException

Invoke a operation on the remote object w/o a return value.

Throws:

ManagementException

invokeRemoteOperation

protected Object invokeRemoteOperation(ObjectName mbeanName,
                           String op,
                           Object[] params,
                           String[] sign,
                           String serverName)
                                throws ManagementException

Invoke a operation on the remote object with a return value.

Throws:

ManagementException

setRemoteAttribute

protected void setRemoteAttribute(ObjectName mbeanName,
                      Attribute attribute,
                      String serverName)
                           throws ManagementException

Set an attribute on the remote object with a return value.

Throws:

ManagementException

setRemoteAttributes

protected Object setRemoteAttributes(ObjectName mbeanName,
                         AttributeList attributes,
                         String serverName)
                              throws ManagementException

Set an attribute on the remote object with a return value.

Throws:

ManagementException

getRemoteAttributes

protected Object getRemoteAttributes(ObjectName mbeanName,
                         String[] attributes,
                         String serverName)
                              throws ManagementException

Get attributes on the remote object with a return value.

Throws:

ManagementException

getRemoteAttribute

protected Object getRemoteAttribute(ObjectName mbeanName,
                        String attribute,
                        String serverName)
                             throws ManagementException

Get attribute on the remote object with a return value.

Throws:

ManagementException

invokeLocalOperation

protected Object invokeLocalOperation(ObjectName mbeanName,
                          String op,
                          Object[] params,
                          String[] sign)
                               throws ManagementException

Invoke a operation on a local MBean

Throws:

ManagementException

getComponentType

protected ComponentType getComponentType(String componentName)
                                  throws ManagementException

Returns:

the ComponentType

Throws:

ManagementException

getComponentStateOnInstance

protected String getComponentStateOnInstance(String compName,
                                 String instanceName)
                                      throws ManagementException

This operation invokes the getCurentState() operation on the ComponentLifeCycle MBean for a component on the instance, if the instance is running, if the instance is down the state of the Component is SHUTDOWN.

Returns:

the state of the component on the instance.

Throws:

ManagementException

getComponentState

protected ComponentState getComponentState(String compName,
                               String instanceName)
                                    throws ManagementException

Returns:

the ComponentState on the instance.

Throws:

ManagementException

isComponentInstalled

protected boolean isComponentInstalled(String compName)
                                throws ManagementException

Returns:

true if the component is installed on the target.

Throws:

ManagementException

getFacadeInstallerMBeanName

protected ObjectName getFacadeInstallerMBeanName(String componentName)
                                          throws ManagementException

Get the Facade Installer MBean object name for a component.

Throws:

ManagementException

getFacadeInstallerMBeanName

protected ObjectName getFacadeInstallerMBeanName(String componentName,
                                     ComponentType compType)
                                          throws ManagementException

Get the Facade Installer MBean object name for a component.

Throws:

ManagementException

fromFileURL

protected File fromFileURL(String urlStr)

Parses an installation zip url, strips file protocol details (if necessary) and returns a File reference. This method is used to protect clients which do not understand file URIs (e.g. repository).

toFileURL

protected String toFileURL(String urlStr)

Always returns a 208-compliant file URL based on the supplied urlStr. If urlStr is already a valid file URL, this method is a NOP.

validateArchive

protected Archive validateArchive(String archiveZipUrl,
                      ArchiveType expectedType,
                      String taskId)
                           throws ManagementException

Validate the Archive

Returns:

the validated Archive

Throws:

ManagementException - if the archive is not valid or does not exist.

mbeanRegistrationCheck

protected void mbeanRegistrationCheck(String op,
                          ObjectName mbeanName,
                          String serverName)
                               throws ManagementException

MBean registration check.

Throws:

ManagementException

isMBeanRegisteredOnInstance

protected boolean isMBeanRegisteredOnInstance(ObjectName mbeanName,
                                  String serverName)
                                       throws ManagementException

Returns:

true if the MBean is registered on the instance, false otherwise

Throws:

ManagementException

isTargetUp

public boolean isTargetUp(String targetName)

Checks to see if the Target (server, cluster) is up or down.

Parameters:

targetName - name of the target (e.g., cluster1, server, etc.)

Returns:

true if Target is up, false if not

areAllInstancesUp

public boolean areAllInstancesUp(String clusterName)

Parameters:

clusterName - - cluster name

Returns:

true if all the instances in the cluster are up and running.

isInstanceRunning

protected boolean isInstanceRunning(String instanceName)
                             throws ManagementException

Returns:

true if the instance is running

Throws:

ManagementException

instanceRunningCheck

protected void instanceRunningCheck(String instanceName)
                             throws JBIException

Throws:

JBIException - if the instance is not running.

uploadFile

protected String uploadFile(String serverName,
                String localFile)
                     throws ManagementException

Upload a file to the specified target and return the absolute path to the file on the remote target

Throws:

ManagementException

sharedLibraryInstallationCheck

protected void sharedLibraryInstallationCheck(String slName,
                                  boolean throwExWhenInstalled)
                                       throws ManagementException

Check if a SharedLibrary is installed on a target.

Throws:

ManagementException

isSharedLibraryInstalled

protected boolean isSharedLibraryInstalled(String slName)
                                    throws ManagementException

Returns:

true if the shared library is installed on the target

Throws:

ManagementException

componentInstallationCheck

protected void componentInstallationCheck(String componentName,
                              boolean throwExWhenInstalled)
                                   throws ManagementException

Check if a Component is installed on a target.

Throws:

ManagementException

handleClusteredInstanceFailures

protected void handleClusteredInstanceFailures(String taskId,
                                   Map<String,Throwable> exceptionMap,
                                   int numInstances,
                                   String locStrKey)
                                        throws ManagementException

Handle Cluster installation failures. The exception map contains exceptions thrown by the instance, keyed by instance name. If there are as many exceptions as there are instances, it is a complete failure, build a composite exception and throw a exception with the composed management message. If there are fewer exceptions than instances, it is a partial success, log the exceptions as warnings.

Throws:

ManagementException

getRemoteAdminServiceObjectName

protected ObjectName getRemoteAdminServiceObjectName(String instanceName)

Returns:

the object name of the Deployment Service

getComponentLifeCycleMBeanName

protected ObjectName getComponentLifeCycleMBeanName(String componentName,
                                        ComponentType compType,
                                        String instanceName)
                                             throws ManagementException

Get the Component Lifecycle MBean name on an instance.

Throws:

JBIException - when the component is not installed on the target the instance is not up AdminService MBean is not registered on the remote instance.

ManagementException

unregisterComponentLifeCycleMBean

protected void unregisterComponentLifeCycleMBean(String target,
                                     String compName)
                                          throws JBIException

Unregister the ComponentLifeCycle MBean for the component.

Parameters:

target - - the target value of the facade MBean

Throws:

JBIException

unregisterComponentLifeCycleMBean

protected void unregisterComponentLifeCycleMBean(String target,
                                     String compName,
                                     ComponentType compType)
                                          throws JBIException

Unregister the ComponentLifeCycle MBean for the component.

Parameters:

target - - the target value of the facade MBean

Throws:

JBIException

unregisterComponentExtensionMBean

protected void unregisterComponentExtensionMBean(String target,
                                     String compName)
                                          throws JBIException

Unregister the ComponentExtension MBean for the component.

Parameters:

target - - the target value of the facade MBean

Throws:

JBIException

unregisterComponentExtensionMBean

protected void unregisterComponentExtensionMBean(String target,
                                     String compName,
                                     ComponentType compType)
                                          throws JBIException

Unregister the ComponentLifeCycle MBean for the component.

Parameters:

target - - the target value of the facade MBean

Throws:

JBIException

unregisterComponentConfigurationMBean

protected void unregisterComponentConfigurationMBean(String target,
                                         String compName)
                                              throws JBIException

Unregister the Component Configuration MBean for the component.

Parameters:

target - - the target value of the facade MBean

Throws:

JBIException

unregisterComponentConfigurationMBean

protected void unregisterComponentConfigurationMBean(String target,
                                         String compName,
                                         ComponentType compType)
                                              throws JBIException

Unregister the Component Configuration MBean for the component.

Parameters:

target - - the target value of the facade MBean

Throws:

JBIException

throwNotSupportedManagementException

protected void throwNotSupportedManagementException(String taskId)
                                             throws ManagementException

Throws:

ManagementException

initPrimitiveTypeMap

protected static void initPrimitiveTypeMap()

Initialize the data structure which maps primitive types to their wrapper classes

convertToString

protected String convertToString(Collection colxn)

Convert the objects in the collection to string.

Parameters:

set - a non-empty set

getAllTargets

protected List<String> getAllTargets()
                              throws ManagementException

Returns:

a list of all the targets in the domain

Throws:

ManagementException

archiveEqualityCheck

protected void archiveEqualityCheck(File f1,
                        File f2,
                        ArchiveType type,
                        String entityName)
                             throws ManagementException

Check if two files are identical.If the archives are not identical a Management exception is thrown indicating a different archive exists in the domain.

Parameters:

f1 - - file to compare

f2 - - file to compare

type - - type of archives

entityName - - component / shared library / service assembly name

Throws:

ManagementException - if the two archives are not identical.

getComponentConfigurationNS

protected String getComponentConfigurationNS(String compName)

Get the namespace of the "Configuration" element in the jbi.xml, if one exists. Return an empty string if a "Configuration" emenet is not defined.

Parameters:

compName - - component name

Returns:

the configuration element namespace

getComponentConfigurationData

protected String getComponentConfigurationData(String compName)

Get the the "Configuration" element in the jbi.xml. If the Configuration element is missing in the jbi.xml a null value is returned

Parameters:

compName - - component name

Returns:

the configuration xml string

getComponentConfigurationSchema

protected String getComponentConfigurationSchema()
                                          throws ManagementException

Get the the "Configuration" element in the jbi.xml. If the Configuration element is missing in the jbi.xml a null value is returned

Parameters:

compName - - component name

Returns:

the configuration schema string

Throws:

ManagementException