AppManagement MBean

Partial ObjectName:
WebSphere:*,type=AppManagement

MinimalAccessCheck:

     true

ResourceInstanceIdentifier:

     The resource being modified for the MBean is of type Application

     The instance is identified by the value of key Application in the MBean's Object Name >


MBean AppManagement

Management interface for application management functions.


Operation Summary

voidinstallApplication(java.lang.String localEarPath, java.util.Hashtable properties, java.lang.String workspaceID)
           Install an application taking the default application name.
voidinstallApplication(java.lang.String localEarPath, java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)
           Install an application explicitly specifying the application name.
voiduninstallApplication(java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)
           Uninstall an application.
java.util.VectorgetApplicationInfo(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID)
           Get the metadata information for an application.
java.util.VectorgetModuleInfo(java.lang.String appName, java.util.Hashtable prefs, java.lang.String uniqueModuleURI, java.lang.String workspaceID)
           Get the metadata information for a module.
voidsetApplicationInfo(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID, java.util.Vector tasks)
           Set the metatdata information for an application.
voidsetModuleInfo(java.lang.String appName, java.util.Hashtable prefs, java.lang.String uniqueModuleURI, java.lang.String workspaceID, java.util.Vector tasks)
           Set the metadata information for a module.
voidmoveModule(java.lang.String appName, java.lang.String uniqueModuleURI, javax.management.ObjectName objectName, java.lang.String workspaceID)
           Change the deployment target (server or cluster) for a module.
voidexportApplication(java.lang.String appName, java.lang.String pathName, java.util.Hashtable preferences, java.lang.String workspaceID)
           Export an application.
voidextractDDL(java.lang.String appName, java.lang.String ddlPrefix, java.lang.String dirName, java.util.Hashtable preferences, java.lang.String workspaceID)
           Extract the DDL from an application.
java.util.VectorlistSystemApplications(java.util.Hashtable preferences, java.lang.String workspaceID)
           List all system applications.
java.util.VectorlistApplications(java.util.Hashtable preferences, java.lang.String workspaceID)
           List all applications.
AppDeploymentTasklistModules(java.lang.String appName, java.util.Hashtable preferences, java.lang.String workspaceID)
           List the modules in an application.
java.util.VectorcompareSecurityPolicy(java.lang.String policyData, java.util.Hashtable preferences, java.lang.String workspaceID)
           Compare the was.
voidinstallStandaloneRAR(java.lang.String rarPath, java.util.Hashtable props, java.lang.String workspaceID)
           Install a standalone JCA Resource Adapter archive (RAR).
booleancheckIfAppExists(java.lang.String appName, java.util.Hashtable props, java.lang.String workspaceID)
           Check if an application exists.
voidredeployApplication(java.lang.String localEarPath, java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)
           Redeploy (update) an application.
voidremoveAllAppsFromNode(java.lang.String nodeName, java.lang.String nodeName, java.util.Hashtable properties, java.lang.String workspaceID)
           Remove all Applications from all servers of a node.
voidremoveAllAppsFromCluster(javax.management.ObjectName objectName, java.util.Hashtable properties, java.lang.String workspaceID)
           Remove all Applications from a cluster.
voidremoveAllAppsFromServer(javax.management.ObjectName objectName, java.util.Hashtable properties, java.lang.String workspaceID)
           Remove all Applications from a server.
voidchangeServerToCluster(javax.management.ObjectName serverName, javax.management.ObjectName clusterName, java.util.Hashtable properties, java.lang.String workspaceID)
           Process the application deployment changes needed when a server is changed to a cluster.
voidclusterMemberAdded(javax.management.ObjectName memberName, javax.management.ObjectName clusterName, java.util.Hashtable properties, java.lang.String workspaceID)
           Process the application deployment changes needed when a cluster member is added.
voidupdateAccessIDs(java.lang.String appName, java.lang.Boolean bAll, java.util.Hashtable prefs, java.lang.String workspaceID)
           Update access ID information in application bindings
voiddeleteUserAndGroupEntries(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID)
           Remove user/groups related binding information from the application.
java.lang.StringstartApplication(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID)
           Starts application on all targets.
java.lang.StringstartApplication(java.lang.String appName, java.lang.String targets, java.util.Hashtable prefs, java.lang.String workspaceID)
           Starts application on specified targets.
java.lang.StringstopApplication(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID)
           Stops application on all targets.
java.lang.StringstopApplication(java.lang.String appName, java.lang.String targets, java.util.Hashtable prefs, java.lang.String workspaceID)
           Stops application on specified targets.
voidpublishWSDL(java.lang.String appName, java.lang.String pathName, java.util.Hashtable preferences, java.lang.String workspaceID)
           Publish WebServices WSDL files to a zip file.
java.util.HashtablesearchJNDIReferences(java.util.List sList, java.lang.String nodes, java.util.Hashtable prefs, java.lang.String wID)
           Search list of Strings in all application.
voidupdateApplication(java.lang.String appName, java.lang.String contentURI, java.lang.String pathToContents, java.lang.String operation, java.util.Hashtable properties, java.lang.String sessionID)
           Update an application.
java.util.ListlistURIs(java.lang.String appName, java.lang.String moduleURI, java.util.Hashtable preferences, java.lang.String sessionID)
           List URIs in an application or an application module.
voidupdateCluster(java.lang.String[] appNames, java.lang.Integer timeout, java.util.Hashtable prefs, java.lang.String workspaceID)
           Update Cluster.
java.util.ListsearchResources(java.lang.String preferences, java.util.Hashtable preferences, java.lang.String wID)
           Search the resource reference defined in the specified application.
java.util.ListconvertRefToConfigID(java.lang.String preferences, java.util.List preferences, java.util.Hashtable preferences, java.lang.String wID)
           convert the list of resource reference to the config object id.
byte[]getApplicationContents(java.lang.String appName, java.lang.String localEarPath, java.util.Hashtable properties, java.lang.String workspaceID)
           Return byte array for contents of an application URI.
java.util.VectorlistApplications(java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)
           List application on a given target.
voidgetDistributionStatus(java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)
           Check distribution status for a given application i.
voidrenameApplication(java.lang.String appName, java.lang.String newAppName, java.util.Hashtable properties, java.lang.String workspaceID)
           Rename an application.

Notification Summary

websphere.admin.appmgmt
           Notification that an application management task has been processed.

Operation Detail

installApplication

public void installApplication(java.lang.String localEarPath, java.util.Hashtable properties, java.lang.String workspaceID)

     Install an application taking the default application name.

Parameters:

     localEarPath - Local Ear Path
     properties - Preferences needed for application installation
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


installApplication

public void installApplication(java.lang.String localEarPath, java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)

     Install an application explicitly specifying the application name.

Parameters:

     localEarPath - Local Ear Path
     appName - Application Name
     properties - Preferences needed for application installation
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


uninstallApplication

public void uninstallApplication(java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)

     Uninstall an application.

Parameters:

     appName - Application Name
     properties - Properties
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


getApplicationInfo

public java.util.Vector getApplicationInfo(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID)

     Get the metadata information for an application.

Parameters:

     appName - Application Name
     prefs - Properties
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


getModuleInfo

public java.util.Vector getModuleInfo(java.lang.String appName, java.util.Hashtable prefs, java.lang.String uniqueModuleURI, java.lang.String workspaceID)

     Get the metadata information for a module.

Parameters:

     appName - Application Name
     prefs - Properties
     uniqueModuleURI - Unique Module URI (modURI+ddURI)
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


setApplicationInfo

public void setApplicationInfo(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID, java.util.Vector tasks)

     Set the metatdata information for an application.

Parameters:

     appName - Application Name
     prefs - Properties
     workspaceID - WorkSpace ID
     tasks - Vector of AppDeploymentTask instances

Security Roles:

     administrator
     operator


setModuleInfo

public void setModuleInfo(java.lang.String appName, java.util.Hashtable prefs, java.lang.String uniqueModuleURI, java.lang.String workspaceID, java.util.Vector tasks)

     Set the metadata information for a module.

Parameters:

     appName - Application Name
     prefs - Properties
     uniqueModuleURI - Unique Module URI (modURI+ddURI)
     workspaceID - WorkSpace ID
     tasks - Vector of AppDeploymentTask instances

Security Roles:

     administrator
     operator


moveModule

public void moveModule(java.lang.String appName, java.lang.String uniqueModuleURI, javax.management.ObjectName objectName, java.lang.String workspaceID)

     Change the deployment target (server or cluster) for a module.

Parameters:

     appName - Application Name
     uniqueModuleURI - Unique Module URI (modURI+ddURI)
     objectName - Object Name for module destination (CNP)
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


exportApplication

public void exportApplication(java.lang.String appName, java.lang.String pathName, java.util.Hashtable preferences, java.lang.String workspaceID)

     Export an application.

Parameters:

     appName - Application Name
     pathName - The file name for export
     preferences - Preferences - contains Locale
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


extractDDL

public void extractDDL(java.lang.String appName, java.lang.String ddlPrefix, java.lang.String dirName, java.util.Hashtable preferences, java.lang.String workspaceID)

     Extract the DDL from an application.

Parameters:

     appName - Application Name
     ddlPrefix - prefix for ddl file
     dirName - The dir name for extracting ddl files
     preferences - Preferences - contains Locale
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listSystemApplications

public java.util.Vector listSystemApplications(java.util.Hashtable preferences, java.lang.String workspaceID)

     List all system applications.

Parameters:

     preferences - Preferences - contains Locale
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listApplications

public java.util.Vector listApplications(java.util.Hashtable preferences, java.lang.String workspaceID)

     List all applications.

Parameters:

     preferences - Preferences - contains Locale
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


listModules

public AppDeploymentTask listModules(java.lang.String appName, java.util.Hashtable preferences, java.lang.String workspaceID)

     List the modules in an application.

Parameters:

     appName - Application Name
     preferences - Preferences - contains Locale
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


compareSecurityPolicy

public java.util.Vector compareSecurityPolicy(java.lang.String policyData, java.util.Hashtable preferences, java.lang.String workspaceID)

     Compare the was.policy file in the application with the system filter.policy.

Parameters:

     policyData - Policy data
     preferences - Preferences - contains Locale
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


installStandaloneRAR

public void installStandaloneRAR(java.lang.String rarPath, java.util.Hashtable props, java.lang.String workspaceID)

     Install a standalone JCA Resource Adapter archive (RAR).

Parameters:

     rarPath - RAR File name
     props - Properties - contains Locale, RAR deployment info
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


checkIfAppExists

public boolean checkIfAppExists(java.lang.String appName, java.util.Hashtable props, java.lang.String workspaceID)

     Check if an application exists.

Parameters:

     appName - App Name
     props - preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


redeployApplication

public void redeployApplication(java.lang.String localEarPath, java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)

     Redeploy (update) an application.

Parameters:

     localEarPath - Local Ear Path
     appName - Application Name
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


removeAllAppsFromNode

public void removeAllAppsFromNode(java.lang.String nodeName, java.lang.String nodeName, java.util.Hashtable properties, java.lang.String workspaceID)

     Remove all Applications from all servers of a node.

Parameters:

     nodeName - Node Name
     nodeName - Cell Name
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


removeAllAppsFromCluster

public void removeAllAppsFromCluster(javax.management.ObjectName objectName, java.util.Hashtable properties, java.lang.String workspaceID)

     Remove all Applications from a cluster.

Parameters:

     objectName - ObjectName for cluster
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


removeAllAppsFromServer

public void removeAllAppsFromServer(javax.management.ObjectName objectName, java.util.Hashtable properties, java.lang.String workspaceID)

     Remove all Applications from a server.

Parameters:

     objectName - ObjectName for server
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


changeServerToCluster

public void changeServerToCluster(javax.management.ObjectName serverName, javax.management.ObjectName clusterName, java.util.Hashtable properties, java.lang.String workspaceID)

     Process the application deployment changes needed when a server is changed to a cluster.

Parameters:

     serverName - ObjectName for server
     clusterName - ObjectName for cluster
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


clusterMemberAdded

public void clusterMemberAdded(javax.management.ObjectName memberName, javax.management.ObjectName clusterName, java.util.Hashtable properties, java.lang.String workspaceID)

     Process the application deployment changes needed when a cluster member is added.

Parameters:

     memberName - ObjectName for member
     clusterName - ObjectName for cluster
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


updateAccessIDs

public void updateAccessIDs(java.lang.String appName, java.lang.Boolean bAll, java.util.Hashtable prefs, java.lang.String workspaceID)

     Update access ID information in application bindings

Parameters:

     appName - App Name
     bAll - If All are updated
     prefs - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


deleteUserAndGroupEntries

public void deleteUserAndGroupEntries(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID)

     Remove user/groups related binding information from the application.

Parameters:

     appName - App Name
     prefs - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


startApplication

public java.lang.String startApplication(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID)

     Starts application on all targets.

Parameters:

     appName - App Name
     prefs - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


startApplication

public java.lang.String startApplication(java.lang.String appName, java.lang.String targets, java.util.Hashtable prefs, java.lang.String workspaceID)

     Starts application on specified targets.

Parameters:

     appName - App Name
     targets - Targets
     prefs - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


stopApplication

public java.lang.String stopApplication(java.lang.String appName, java.util.Hashtable prefs, java.lang.String workspaceID)

     Stops application on all targets.

Parameters:

     appName - App Name
     prefs - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


stopApplication

public java.lang.String stopApplication(java.lang.String appName, java.lang.String targets, java.util.Hashtable prefs, java.lang.String workspaceID)

     Stops application on specified targets.

Parameters:

     appName - App Name
     targets - Targets
     prefs - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


publishWSDL

public void publishWSDL(java.lang.String appName, java.lang.String pathName, java.util.Hashtable preferences, java.lang.String workspaceID)

     Publish WebServices WSDL files to a zip file.

Parameters:

     appName - Application Name
     pathName - The path name for the zip file which contains published wsdl files
     preferences - Preferences - contains Locale and soap addresss prefixes for each module (if any)
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


searchJNDIReferences

public java.util.Hashtable searchJNDIReferences(java.util.List sList, java.lang.String nodes, java.util.Hashtable prefs, java.lang.String wID)

     Search list of Strings in all application.

Parameters:

     sList - list of the strings
     nodes - The node name list
     prefs - Preferences - contains Locale and soap addresss prefixes for each module (if any)
     wID - WorkSpace ID

Security Roles:

     administrator
     operator


updateApplication

public void updateApplication(java.lang.String appName, java.lang.String contentURI, java.lang.String pathToContents, java.lang.String operation, java.util.Hashtable properties, java.lang.String sessionID)

     Update an application.

Parameters:

     appName - Application Name
     contentURI - Content URI
     pathToContents - Path to update contents that is local to the server
     operation - Update operation - add, delete, update, addupdate
     properties - Preferences
     sessionID - Session ID

Security Roles:

     administrator
     operator


listURIs

public java.util.List listURIs(java.lang.String appName, java.lang.String moduleURI, java.util.Hashtable preferences, java.lang.String sessionID)

     List URIs in an application or an application module.

Parameters:

     appName - Application Name
     moduleURI - Module file URI e.g. Increment.jar
     preferences - Preferences - contains Locale
     sessionID - Session ID

Security Roles:

     administrator
     operator
     configurator
     monitor
     deployer
     adminsecuritymanager


updateCluster

public void updateCluster(java.lang.String[] appNames, java.lang.Integer timeout, java.util.Hashtable prefs, java.lang.String workspaceID)

     Update Cluster.

Parameters:

     appNames - Application Names
     timeout - timeout for each node's response
     prefs - Properties
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


searchResources

public java.util.List searchResources(java.lang.String preferences, java.util.Hashtable preferences, java.lang.String wID)

     Search the resource reference defined in the specified application.

Parameters:

     preferences - application name
     preferences - Preferences - contains Locale
     wID - WorkSpace ID

Security Roles:

     administrator
     operator


convertRefToConfigID

public java.util.List convertRefToConfigID(java.lang.String preferences, java.util.List preferences, java.util.Hashtable preferences, java.lang.String wID)

     convert the list of resource reference to the config object id.

Parameters:

     preferences - application name
     preferences - List of the resource oobject
     preferences - Preferences - contains Locale
     wID - WorkSpace ID

Security Roles:

     administrator
     operator


getApplicationContents

public byte[] getApplicationContents(java.lang.String appName, java.lang.String localEarPath, java.util.Hashtable properties, java.lang.String workspaceID)

     Return byte array for contents of an application URI.

Parameters:

     appName - Application Name
     localEarPath - URI
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


listApplications

public java.util.Vector listApplications(java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)

     List application on a given target.

Parameters:

     appName - targetScope
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


getDistributionStatus

public void getDistributionStatus(java.lang.String appName, java.util.Hashtable properties, java.lang.String workspaceID)

     Check distribution status for a given application i.e. is application distributed and expanded on all the nodes.

Parameters:

     appName - Application Name
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


renameApplication

public void renameApplication(java.lang.String appName, java.lang.String newAppName, java.util.Hashtable properties, java.lang.String workspaceID)

     Rename an application.

Parameters:

     appName - Existing application name. The name can be in the form of a composite name (ie: <APPNAME>-edition<EDITION>) when in a Virtual Enterprise (VE) environment.
     newAppName - New application name. The name can be in the form of a composite name (ie: <APPNAME>-edition<EDITION>) when in a Virtual Enterprise (VE) environment.
     properties - Preferences
     workspaceID - WorkSpace ID

Security Roles:

     administrator
     operator


Notification Detail

websphere.admin.appmgmt

     Notification that an application management task has been processed. Details about the specific task are available in the notification data.

Severity:

3  (Major, Severe)


Copyright IBM Corporation 2002, 2012