IBM WebSphere Application ServerTM
Release 7

com.ibm.websphere.management.configservice.tasks
Class InstallRARTask

java.lang.Object
  extended by com.ibm.websphere.management.configservice.tasks.InstallRARTask

public class InstallRARTask
extends java.lang.Object

This class defines tasks that relate to stand-alone RAR file installation.


Constructor Summary
InstallRARTask(ConfigService configService)
           
 
Method Summary
 java.util.Hashtable getRARInfo(Session session, java.lang.String nodeName, java.lang.String archivePath, java.util.Hashtable options)
           
 javax.management.ObjectName installResourceAdapter(Session session, java.lang.String nodeName, java.lang.String archivePath, java.util.Hashtable options)
          Installs a stand-alone RAR module and create a J2CResourceAdapter config data to represent the RAR module.
static boolean isJ2CRAExist(Session session, ConfigService configService, java.lang.String archivePath, boolean isolated, javax.management.ObjectName scope)
           
static boolean isJ2CRAExist(Session session, ConfigService configService, java.lang.String archivePath, boolean isolated, javax.management.ObjectName scope, javax.management.ObjectName orgRA)
           
static java.util.List<javax.management.ObjectName> listResources(Session session, ConfigService configService, java.lang.String type, java.lang.String archivePath, boolean recursive, javax.management.ObjectName scope)
           
static boolean validateHACapability(java.lang.String key)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InstallRARTask

public InstallRARTask(ConfigService configService)
Method Detail

installResourceAdapter

public javax.management.ObjectName installResourceAdapter(Session session,
                                                          java.lang.String nodeName,
                                                          java.lang.String archivePath,
                                                          java.util.Hashtable options)
                                                   throws ConfigServiceException,
                                                          ConnectorException
Installs a stand-alone RAR module and create a J2CResourceAdapter config data to represent the RAR module.

This task assumes that the RAR module is on the node already. In another word, this task doesn't distribute binary like the application install, and the RAR module binary is not be managed by the config repository.

Parameters:
session - session id.
nodeName - the name of the node.
archivePath - the absolute path of the RAR module on the node.
options - the optional properties user can specify. More specifically, following properties can be specified:
  • rar.name - the name of the created J2CResourceAdapter. If this property is not specified, the name of RAR module in RAR's deployment descriptor will be used.
  • rar.desc - the description of the created J2CResourceAdapter.
  • rar.archivePath - the path where the RAR will be extracted. If this property is not specified, the archive will be extracted to ${CONNECTOR_INSTALL_ROOT} directory. CONNECTOR_INSTALL_ROOT is a variable defined in variables.xml file.
  • rar.classpath - additional classpath for the created J2CResourceAdapter object.
  • rar.nativePath - additional native libaray path for the created J2CResourceAdapter object.
    Returns:
    the ObjectName of the created J2CResourceAdapter config data.
    Throws:
    ConfigServiceException
    ConnectorException

getRARInfo

public java.util.Hashtable getRARInfo(Session session,
                                      java.lang.String nodeName,
                                      java.lang.String archivePath,
                                      java.util.Hashtable options)
                               throws ConfigServiceException,
                                      ConnectorException
Throws:
ConfigServiceException
ConnectorException

validateHACapability

public static boolean validateHACapability(java.lang.String key)

isJ2CRAExist

public static boolean isJ2CRAExist(Session session,
                                   ConfigService configService,
                                   java.lang.String archivePath,
                                   boolean isolated,
                                   javax.management.ObjectName scope)
                            throws ConfigServiceException
Throws:
ConfigServiceException

isJ2CRAExist

public static boolean isJ2CRAExist(Session session,
                                   ConfigService configService,
                                   java.lang.String archivePath,
                                   boolean isolated,
                                   javax.management.ObjectName scope,
                                   javax.management.ObjectName orgRA)
                            throws ConfigServiceException
Throws:
ConfigServiceException

listResources

public static java.util.List<javax.management.ObjectName> listResources(Session session,
                                                                        ConfigService configService,
                                                                        java.lang.String type,
                                                                        java.lang.String archivePath,
                                                                        boolean recursive,
                                                                        javax.management.ObjectName scope)
                                                                 throws ConfigServiceException
Throws:
ConfigServiceException

IBM WebSphere Application ServerTM
Release 7