org.apache.aries.jmx.codec

Class BatchInstallResult

java.lang.Object

org.apache.aries.jmx.codec.BatchResult

org.apache.aries.jmx.codec.BatchInstallResult

public class BatchInstallResult
extends BatchResult

BatchInstallResult represents codec for resulting CompositeData of FrameworkMBean installBundles methods. It converting batch install results to CompositeData toCompositeData() and from CompositeData to this BatchInstallResult from(CompositeData). It provides also constructors to build BatchInstallResult. Structure of compositeData as defined in compositeType @see FrameworkMBean.BATCH_INSTALL_RESULT_TYPE.

See Also:

BatchResult

Constructor Summary

Constructors

Constructor and Description
BatchInstallResult(long[] completedItems) Constructs new BatchInstallResult with completedItems array.
BatchInstallResult(long[] completedItems, java.lang.String error, java.lang.String[] remainingLocationItems, boolean success, java.lang.String bundleInError) Constructs new BatchInstallResult.
BatchInstallResult(long[] completedItems, java.lang.String error, java.lang.String[] remainingLocationItems, java.lang.String bundleInError) Constructs new BatchInstallResult.
BatchInstallResult(java.lang.String error) Constructs new BatchInstallResult with error message.

Method Summary

Modifier and Type	Method and Description
static BatchInstallResult	from(javax.management.openmbean.CompositeData data) Static factory method to create BatchInstallResult from CompositeData object.
java.lang.String	getBundleInError() Gets bundle in error location.
java.lang.String[]	getRemainingLocationItems() Gets remaining location items.
javax.management.openmbean.CompositeData	toCompositeData() Translates BatchInstallResult to CompositeData represented by compositeType FrameworkMBean.BATCH_INSTALL_RESULT_TYPE.

Methods inherited from class org.apache.aries.jmx.codec.BatchResult

getCompleted, getError, isSuccess

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BatchInstallResult

public BatchInstallResult(long[] completedItems)

Constructs new BatchInstallResult with completedItems array. Newly created object represents successful batch result.

Parameters:

completedItems - containing the list of bundles completing the batch operation.

BatchInstallResult

public BatchInstallResult(java.lang.String error)

Constructs new BatchInstallResult with error message. Newly created object represents failed batch result.

Parameters:

error - containing the error message of the batch operation.

BatchInstallResult

public BatchInstallResult(long[] completedItems,
                          java.lang.String error,
                          java.lang.String[] remainingLocationItems,
                          java.lang.String bundleInError)

Constructs new BatchInstallResult. Newly created object represents failed batch result.

Parameters:

completedItems - containing the list of bundles completing the batch operation.

error - containing the error message of the batch operation.

remainingLocationItems - remaining bundles unprocessed by the failing batch operation.

bundleInError - containing the bundle which caused the error during the batch operation.

BatchInstallResult

public BatchInstallResult(long[] completedItems,
                          java.lang.String error,
                          java.lang.String[] remainingLocationItems,
                          boolean success,
                          java.lang.String bundleInError)

Constructs new BatchInstallResult.

Parameters:

completedItems - containing the list of bundles completing the batch operation.

error - containing the error message of the batch operation.

remainingLocationItems - remaining bundles unprocessed by the failing batch operation.

success - indicates if this operation was successful.

bundleInError - containing the bundle which caused the error during the batch operation.

Method Detail

toCompositeData

public javax.management.openmbean.CompositeData toCompositeData()

Translates BatchInstallResult to CompositeData represented by compositeType FrameworkMBean.BATCH_INSTALL_RESULT_TYPE.

Returns:

translated BatchInstallResult to compositeData.

from

public static BatchInstallResult from(javax.management.openmbean.CompositeData data)

Static factory method to create BatchInstallResult from CompositeData object.

Parameters:

data - CompositeData instance.

Returns:

BatchInstallResult instance.

getRemainingLocationItems

public java.lang.String[] getRemainingLocationItems()

Gets remaining location items.

Returns:

array of String with locations.

getBundleInError

public java.lang.String getBundleInError()

Gets bundle in error location.

Returns:

the bundleInError.