AdminOperations MBean

Partial ObjectName:
WebSphere:*,type=AdminOperations


MBean AdminOperations

Management interface for a miscellaneous set of admin functions


Operation Summary

voidmergeConfigDataOnDmgr(java.util.Properties nodeProperties, java.util.Properties adminProperties)
           Process config files that were sent by node.
voidcheckNodeAndDmgrCompatibility(java.util.Properties nodeProperties)
           Invokes dmgr side extension checkers to ensure node to be federated is compatible with the dmgr
voidrenameNodeOnDmgr(java.lang.String oldNode, java.lang.String newNode, java.lang.String shortName)
           rename node.
voiddoUnMergeConfigDataOnDmgr(java.util.Properties nodeProperties)
           Process config files that were sent by node.
voidaddNode(java.lang.String cellHost, java.lang.String cellPort)
           Add this node to a specified cell.
voidaddNodeWithOptions(java.lang.String cellHost, java.lang.String cellPort, java.lang.String options)
           Add this node to a specified cell.
voidremoveNode()
           Remove this node from the cell.
voidremoveNodeWithOptions(java.lang.String options)
           Remove this node from the cell.
java.lang.StringexpandVariable(java.lang.String variable)
           Expand the variable supplied and return the variable value in the current runtime context.
javax.management.AttributeListgetResourceAdapterFromRAR(java.lang.String rarPath, java.util.Hashtable props)
           Returns a list of JMX attributes corresponding to the Resource Adapter created from the RAR file specified.
voidextractArchive(java.lang.String archivePath, java.lang.String dest, int flag)
           Extracts the archive to destination directory specified.
voidconfigChanged(ConfigRepositoryEvent event)
           config is changed
java.lang.ObjectgetTokenForNodeFederationOrRemoval()
           Method to make sure that only one addNode or removeNode is being done at a time.
java.lang.ObjectgetTokenForNodeFederationOrRemoval(java.lang.String version)
           Method to make sure that only one addNode or removeNode is being done at a time.
booleancompleteNodeFederationOrRemoval(java.lang.Object token)
           Clears the addNode/removeNode flag which was set in {@link #beginNodeFederationOrRemoval}.
voidforceNodeFederationOrRemovalTokenReset()
           Forces the synchronization token for addNode and removeNode to be reset so that additional operations can be performed.
voidupdateMetadataForNode(java.lang.String nodeName, java.util.Properties nodeProperties)
           Update managed object metadata for the specified node.
java.util.PropertiescollectMetadataForThisNode()
           Collect managed object metadata for this MBean's node.
java.util.Hashtable_getAppDistributionStatus(java.lang.String appName, java.util.Hashtable options)
           Get app distribution status on a node
java.util.HashtablegetRARInfo(java.lang.String , java.util.Hashtable props)
           Returns a list of default attribute value of specified RAR.

Operation Detail

mergeConfigDataOnDmgr

public void mergeConfigDataOnDmgr(java.util.Properties nodeProperties, java.util.Properties adminProperties)

     Process config files that were sent by node.

Parameters:

     nodeProperties - Metadata for node being added.
     adminProperties - client side options, etc.

Security Roles:

     administrator
     operator


checkNodeAndDmgrCompatibility

public void checkNodeAndDmgrCompatibility(java.util.Properties nodeProperties)

     Invokes dmgr side extension checkers to ensure node to be federated is compatible with the dmgr

Parameters:

     nodeProperties - Metadata for node being added.

Security Roles:

     administrator
     operator


renameNodeOnDmgr

public void renameNodeOnDmgr(java.lang.String oldNode, java.lang.String newNode, java.lang.String shortName)

     rename node.

Parameters:

     oldNode - old node
     newNode - new node
     shortName - node short name

Security Roles:

     administrator
     operator


doUnMergeConfigDataOnDmgr

public void doUnMergeConfigDataOnDmgr(java.util.Properties nodeProperties)

     Process config files that were sent by node.

Parameters:

     nodeProperties - Metadata for node being removed.

Security Roles:

     administrator
     operator


addNode

public void addNode(java.lang.String cellHost, java.lang.String cellPort)

     Add this node to a specified cell.

Parameters:

     cellHost - Name of the host on which the Deployment Manager is executing.
     cellPort - Number of the JMX port on which the Deployment Manager is listening.

Security Roles:

     administrator
     operator


addNodeWithOptions

public void addNodeWithOptions(java.lang.String cellHost, java.lang.String cellPort, java.lang.String options)

     Add this node to a specified cell.

Parameters:

     cellHost - Name of the host on which the Deployment Manager is executing.
     cellPort - Number of the JMX port on which the Deployment Manager is listening.
     options - Options to use for addNode; these are the same as the command line options.

Security Roles:

     administrator
     operator


removeNode

public void removeNode()

     Remove this node from the cell.

Security Roles:

     administrator
     operator


removeNodeWithOptions

public void removeNodeWithOptions(java.lang.String options)

     Remove this node from the cell.

Parameters:

     options - Options to use for removeNode; these are the same as the command line options.

Security Roles:

     administrator
     operator


expandVariable

public java.lang.String expandVariable(java.lang.String variable)

     Expand the variable supplied and return the variable value in the current runtime context.

Parameters:

     variable - The variable string to be expanded.

Security Roles:

     administrator
     operator


getResourceAdapterFromRAR

public javax.management.AttributeList getResourceAdapterFromRAR(java.lang.String rarPath, java.util.Hashtable props)

     Returns a list of JMX attributes corresponding to the Resource Adapter created from the RAR file specified.

Parameters:

     rarPath - The RAR file path local to the node where MBean is running.
     props - The hashtable .

Security Roles:

     administrator
     operator


extractArchive

public void extractArchive(java.lang.String archivePath, java.lang.String dest, int flag)

     Extracts the archive to destination directory specified.

Parameters:

     archivePath - The archive file path local to the node where MBean is running.
     dest - The destination path local to the node where MBean is running.
     flag - Expansion flags

Security Roles:

     administrator
     operator


configChanged

public void configChanged(ConfigRepositoryEvent event)

     config is changed

Parameters:

     event - Config repository event

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getTokenForNodeFederationOrRemoval

public java.lang.Object getTokenForNodeFederationOrRemoval()

     Method to make sure that only one addNode or removeNode is being done at a time. If one is currently in progress, this method returns false, and the addNode or removeNode should fail. If it is not in progress, this method will return true, and the {@link #completeNodeFederationOrRemoval} method should be called when finished so other add/removeNodes can be performed. A token is returned.

Security Roles:

     administrator
     operator


getTokenForNodeFederationOrRemoval

public java.lang.Object getTokenForNodeFederationOrRemoval(java.lang.String version)

     Method to make sure that only one addNode or removeNode is being done at a time. If one is currently in progress, this method returns false, and the addNode or removeNode should fail. If it is not in progress, this method will return true, and the {@link #completeNodeFederationOrRemoval} method should be called when finished so other add/removeNodes can be performed. A token is returned.

Parameters:

     version - WebSphere version of node we are trying to add.

Security Roles:

     administrator
     operator


completeNodeFederationOrRemoval

public boolean completeNodeFederationOrRemoval(java.lang.Object token)

     Clears the addNode/removeNode flag which was set in {@link #beginNodeFederationOrRemoval}. Returns true if the token was accepted, false otherwise.

Parameters:

     token - Token obtained from getTokenForNodeFederationOrRemoval method.

Security Roles:

     administrator
     operator


forceNodeFederationOrRemovalTokenReset

public void forceNodeFederationOrRemovalTokenReset()

     Forces the synchronization token for addNode and removeNode to be reset so that additional operations can be performed. This should only be necessary if addNode was exited prematurely and you don't want to wait 30 minutes (token expiration time).

Security Roles:

     administrator
     operator


updateMetadataForNode

public void updateMetadataForNode(java.lang.String nodeName, java.util.Properties nodeProperties)

     Update managed object metadata for the specified node.

Parameters:

     nodeName - Name of the node on which the metadata has been gathered.

ResourceInstanceIdentifier

     The resource being modified for the MBean is of type Node

     The instance is identified by the value of the parameter
     nodeProperties - The node metadata gathered by a Managed Object Metadata Collector Manager.

Security Roles:

     administrator
     operator


collectMetadataForThisNode

public java.util.Properties collectMetadataForThisNode()

     Collect managed object metadata for this MBean's node.

Security Roles:

     administrator
     operator


_getAppDistributionStatus

public java.util.Hashtable _getAppDistributionStatus(java.lang.String appName, java.util.Hashtable options)

     Get app distribution status on a node

Parameters:

     appName - App Name

ResourceInstanceIdentifier

     The resource being modified for the MBean is of type Application

     The instance is identified by the value of the parameter
     options - Options

Security Roles:

     administrator
     operator


getRARInfo

public java.util.Hashtable getRARInfo(java.lang.String , java.util.Hashtable props)

     Returns a list of default attribute value of specified RAR.

Parameters:

      - The RAR file path local to the node where MBean is running.
     props - The hashtable

Security Roles:

     administrator
     operator


Copyright IBM Corporation 2002, 2012