IBM WebSphere Application ServerTM
Release 7

com.ibm.wsspi.management.metadata
Class ManagedObjectMetadataCollectorManagerFactory

java.lang.Object
  extended by com.ibm.wsspi.management.metadata.ManagedObjectMetadataCollectorManagerFactory

public class ManagedObjectMetadataCollectorManagerFactory
extends java.lang.Object

This is the factory class used to create instances of ManagedObjectMetadataCollectorManager.

See Also:
ManagedObjectMetadataCollectorManager

Constructor Summary
ManagedObjectMetadataCollectorManagerFactory()
           
 
Method Summary
static ManagedObjectMetadataCollectorManager createCollectorManager(java.util.Properties props)
          Invoke this method to obtain a ManagedObjectMetadataCollectorManager instance which does not send collected metadata to the Deployment Manager.
static ManagedObjectMetadataCollectorManager createCollectorManager(java.util.Properties props, com.ibm.websphere.management.AdminClient adminClient)
          Invoke this method to obtain a ManagedObjectMetadataCollectorManager instance which collects and stores node metadata properties directly to the specified local node's configuration directory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ManagedObjectMetadataCollectorManagerFactory

public ManagedObjectMetadataCollectorManagerFactory()
Method Detail

createCollectorManager

public static ManagedObjectMetadataCollectorManager createCollectorManager(java.util.Properties props,
                                                                           com.ibm.websphere.management.AdminClient adminClient)
                                                                    throws com.ibm.websphere.management.exception.AdminException
Invoke this method to obtain a ManagedObjectMetadataCollectorManager instance which collects and stores node metadata properties directly to the specified local node's configuration directory.

An AdminClient connected to the node's Deployment Manager optionally can be specified in the event that the node is a federated node so that the master config repository can be updated with the collected metadata as soon as possible.

If a null AdminClient reference is passed in, the Metadata Collector Manager will read the local profile's configuration to first determine whether the node is a federated node (versus a standalone node). If it is and if the node is not for the Deployment Manager itself, this factory will obtain address data from the configuration to create an AdminClient which is connected to the Deployment Manager. Any AdminClient properties specified in props will override any values which would otherwise be used. If security is enabled, AdminClient login properties must be provided in inputProps. If the specified local node is a standalone node or if the specified local node is the Deployment Manager's node, no AdminClient is created.

If an AdminClient reference cannot be obtained or it otherwise cannot communicate with the Deployment Manager, the federated node's node agent will send the data to the Deployment Manager after startup upon initial discovery of the Deployment Manager.

Users of this factory should provide an AdminClient connected to the Deployment Manager when reasonably possible because doing so will be more efficient than having the Collector Manager read through the profile's configuration repository to obtain Deployment Manager connection data.

If the caller does not want the metadata uploaded to the Deployment Manager, it should use the variant of this method which does not take an AdminClient.

Parameters:
props - A set of properties required to create a ManagedObjectMetadataCollectorManager instance. The expected properties are listed below:

  • ManagedObjectMetadataAccessor.WAS_REPOSITORY_ROOT (optional). The value of this property is root directory of the repository in which metadata is to be stored. If this value is not specified, the value for the property in the set of System properties is used if it exists. If the factory is running in a WebSphere server process, the repository root does not need to be specified.
  • ManagedObjectMetadataCollectorManager.CELL_NAME (optional). The value of this property is the name of the cell for which metadata is to be obtained. If the value does not exist in the set of input properties, the value for the property, "local.cell" in the set of System properties is used if set. This parameter does not need to be set if this factory is running in a server process or some process which sets up the System properties like the wsadmin script file.
  • ManagedObjectMetadataCollectorManager.NODE_NAME (optional). The value of this property is the name of the node for which metadata is to be obtained. If the value does not exist in the set of input properties, the value for the property, "local.node" in the set of System properties is used if set. This parameter does not need to be set if this factory is running in a server process or some process which sets up the System properties like the wsadmin script file.
  • ManagedObjectMetadataCollectorManager.WAS_INSTALL_ROOT (optional). The value of this property is the installation root directory for the node for which metadata is to be obtained. If the value does not exist in the set of input properties, the value for the property, "was.install.root" in the set of System properties is used if set. This parameter does not need to be set if this factory is running in a server process or some process which sets up the System properties like the wsadmin script file.
  • ManagedObjectMetadataCollectorManager.USER_INSTALL_ROOT (optional). The value of this property is the profile root directory for the node for which metadata is to be obtained. If the value does not exist in the set of input properties, the value for the property, "user.install.root" in the set of System properties is used if set. This parameter does not need to be set if this factory is running in a server process or some process which sets up the System properties like the wsadmin script file.

If no properties are set, the value for props can be null.

adminClient - An com.ibm.websphere.management.AdminClient reference. Collected metadata can optionally be sent immediately to the administrative server to be stored in the master configuration repository by providing an AdminClient connection. If the node on which data is being collected is a member of a Network Deployment cell, the AdminClient connection provided must be to the Deployment Manager process. If the value for adminClient is null, the metadata will not be sent to the Deployment Manager. The value for adminClient should be null if the repository root specified already points to the master config repository.
Throws:
com.ibm.websphere.management.exception.AdminException - Could not create a ManagedObjectMetadataCollectorManager instance.
See Also:
ManagedObjectMetadataCollectorManager.CELL_NAME, ManagedObjectMetadataCollectorManager.NODE_NAME, ManagedObjectMetadataCollectorManager.WAS_INSTALL_ROOT, createCollectorManager(Properties)

createCollectorManager

public static ManagedObjectMetadataCollectorManager createCollectorManager(java.util.Properties props)
                                                                    throws com.ibm.websphere.management.exception.AdminException
Invoke this method to obtain a ManagedObjectMetadataCollectorManager instance which does not send collected metadata to the Deployment Manager.

For a complete description of this method and of the props parameter, refer the description of createCollectorManager(Properties, AdminClient).

Throws:
com.ibm.websphere.management.exception.AdminException

IBM WebSphere Application ServerTM
Release 7