com.ibm.wsspi.management.metadata

Interface ManagedObjectMetadataCollectorManager



  • public interface ManagedObjectMetadataCollectorManager
    The Managed Object Metadata Collector Manager drives the metadata collection process for a profile. The collector manager is invoked at strategic times, such as profile augmentation and deployment manager / node agent / standalone server startup. Given a deployment manager AdminClient reference, the collector manager will send metadata upstream to the deployment manager, which will then copy the metadata into the master configuration repository. The metadata will then be available to the Administrative Console--including plug-in's--and deployment manager runtime code for making administrative decisions based on the metadata.

    It is the responsibility of each WebSphere extension product to invoke the collector manager as a profile action when that extension is added to or removed from a profile. See ManagedObjectMetadataCollector for the pre-defined actions used to augment and remove extensions.

    See Also:
    ManagedObjectMetadataCollector
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CELL_NAME
      Constant for the property name which is used to specify the cell name from which a ManagedObjectMetaDataCollectorManager instance being created is to obtain metadata.
      static java.lang.String NODE_NAME
      Constant for the property name which is used to specify the node name from which a ManagedObjectMetaDataCollectorManager instance being created is to obtain metadata.
      static java.lang.String USER_INSTALL_ROOT
      Constant for the property name which is used to specify the root directory of the WebSphere profile for which node metadata is being collected.
      static java.lang.String WAS_INSTALL_ROOT
      Constant for the property name which is used to specify the WebSphere installation root directory for the node for which metadata is being collected.
      static java.lang.String WAS_REPOSITORY_ROOT
      Constant for the property name which is used to specify the WebSphere repository root.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.util.Properties updateMetadata(java.lang.String action, java.util.Hashtable actionParameters)
      Collect all node capabilities and save them in the node's configuration repository and optionally send them to the Deployment Manager to save in the master configuration repository.
    • Method Detail

      • updateMetadata

        java.util.Properties updateMetadata(java.lang.String action,
                                          java.util.Hashtable actionParameters)
                                            throws com.ibm.websphere.management.exception.AdminException
        Collect all node capabilities and save them in the node's configuration repository and optionally send them to the Deployment Manager to save in the master configuration repository.
        Parameters:
        action - The action being performed. The action is passed to metadata collectors and they will update the metadata in the context of the specified action
        actionParameters - Parameters related to the specified action. This parameter is for input only. A null value indicates that there are no action parameters set.
        Returns:
        The set of collected metadata properties.
        Throws:
        com.ibm.websphere.management.exception.AdminException - if an error occurred during metadata collection process, or an attempt was made to send collected metadata to the Deployment Manager and the attempt failed.
IBM WebSphere Application ServerTM
Release 8.5