oracle.axia.api.management.deployment

Interface DeploymentServiceMBean

public interface DeploymentServiceMBean

The MBean exposer of DeploymentService, will include installBundle, startBundle, stopBundle, uninstallBundle, deployBundle, undeployBundle,updateBundle and listDeployedBundles operations.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	deployBundle(java.lang.String bundleLocation, int startLevel) Install and start a bundle.
java.lang.String[]	installBundle(java.lang.String bundleLocation, int startLevel) Install a bundle.
java.lang.String[]	installManagementAgentBundle(java.lang.String bundleLocation) Install a management agent bundle.
java.util.List<java.util.Map<java.lang.String,java.io.Serializable>>	listDeployedBundles() List deployed bundles.
void	startBundle(java.lang.String bundleName, java.lang.String bundleVersion) Start a bundle.
void	stopBundle(java.lang.String bundleName, java.lang.String bundleVersion) Stop a bundle.
void	undeployBundle(java.lang.String bundleName, java.lang.String bundleVersion) Stop and uninstall a bundle.
void	uninstallBundle(java.lang.String bundleName, java.lang.String bundleVersion) Uninstall a bundle.
void	updateBundle(java.lang.String bundleName, java.lang.String bundleVersion, java.lang.String bundleLocation) Update a bundle.

Method Detail

deployBundle

java.lang.String[] deployBundle(java.lang.String bundleLocation,
                                int startLevel)
                         throws javax.management.MBeanException,
                                javax.management.OperationsException,
                                javax.management.RuntimeOperationsException

Install and start a bundle.

Parameters:

bundleLocation - the path of the file which will be deployed

startLevel - the startLevel assigned to the bundle

Returns:

String[] the array of application's Bundle-SymbolicName and Bundle-Version

Throws:

javax.management.MBeanException

javax.management.OperationsException

javax.management.RuntimeOperationsException

undeployBundle

void undeployBundle(java.lang.String bundleName,
                    java.lang.String bundleVersion)
             throws javax.management.MBeanException,
                    javax.management.OperationsException,
                    javax.management.RuntimeOperationsException

Stop and uninstall a bundle.

Parameters:

bundleName - the name of the bundle which will be undeployed

bundleVersion - the version of the bundle which will be undeployed

Throws:

javax.management.MBeanException

javax.management.OperationsException

javax.management.RuntimeOperationsException

installBundle

java.lang.String[] installBundle(java.lang.String bundleLocation,
                                 int startLevel)
                          throws javax.management.MBeanException,
                                 javax.management.OperationsException,
                                 javax.management.RuntimeOperationsException

Install a bundle.

Parameters:

bundleLocation - the path of the file which will be installed

startLevel - the startLevel assigned to the bundle

Returns:

String[] the array of application's Bundle-SymbolicName and Bundle-Version

Throws:

javax.management.MBeanException

javax.management.OperationsException

javax.management.RuntimeOperationsException

installManagementAgentBundle

java.lang.String[] installManagementAgentBundle(java.lang.String bundleLocation)
                                         throws javax.management.MBeanException,
                                                javax.management.OperationsException,
                                                javax.management.RuntimeOperationsException

Install a management agent bundle. This operation will update the provisioning.start.bundle entry in the initial provisioning file to point to this newly installed management agent bundle. Note that managed servers must be restarted for the new management agent bundle to be started and used, even if the bundle is installed in online mode.

Parameters:

bundleLocation - the path of the file which will be installed

Returns:

String[] the array of application's Bundle-SymbolicName and Bundle-Version

Throws:

javax.management.MBeanException - MBean exception occurred.

javax.management.OperationsException - Operations exception occurred.

javax.management.RuntimeOperationsException - Runtime operations exception occurred.

startBundle

void startBundle(java.lang.String bundleName,
                 java.lang.String bundleVersion)
          throws javax.management.MBeanException,
                 javax.management.OperationsException,
                 javax.management.RuntimeOperationsException

Start a bundle.

Parameters:

bundleName - the name of the bundle which will be started

bundleVersion - the version of the bundle which will be started

Throws:

javax.management.MBeanException

javax.management.OperationsException

javax.management.RuntimeOperationsException

stopBundle

void stopBundle(java.lang.String bundleName,
                java.lang.String bundleVersion)
         throws javax.management.MBeanException,
                javax.management.OperationsException,
                javax.management.RuntimeOperationsException

Stop a bundle.

Parameters:

bundleName - the name of the bundle which will be stoped

bundleVersion - the version of the bundle which will be stoped

Throws:

javax.management.MBeanException

javax.management.OperationsException

javax.management.RuntimeOperationsException

uninstallBundle

void uninstallBundle(java.lang.String bundleName,
                     java.lang.String bundleVersion)
              throws javax.management.MBeanException,
                     javax.management.OperationsException,
                     javax.management.RuntimeOperationsException

Uninstall a bundle.

Parameters:

bundleName - the name of the bundle which will be uninstalled

bundleVersion - the version of the bundle which will be uninstalled

Throws:

javax.management.MBeanException

javax.management.OperationsException

javax.management.RuntimeOperationsException

updateBundle

void updateBundle(java.lang.String bundleName,
                  java.lang.String bundleVersion,
                  java.lang.String bundleLocation)
           throws javax.management.MBeanException,
                  javax.management.OperationsException,
                  javax.management.RuntimeOperationsException

Update a bundle.

Parameters:

bundleName - the name of the bundle which will be updated

bundleVersion - the version of the bundle which will be updated

bundleLocation - the path of the file which will be used to update

Throws:

javax.management.MBeanException

javax.management.OperationsException

javax.management.RuntimeOperationsException

listDeployedBundles

java.util.List<java.util.Map<java.lang.String,java.io.Serializable>> listDeployedBundles()
                                                                                  throws javax.management.MBeanException,
                                                                                         javax.management.OperationsException,
                                                                                         javax.management.RuntimeOperationsException

List deployed bundles.

Returns:

a list of map keeping bundle info for each deployed bundle, the string type of value could be retrieved from this map by using key: symbolic-name, version, fragment-host, deploy-state, start-level

Throws:

javax.management.MBeanException

javax.management.OperationsException

javax.management.RuntimeOperationsException