|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.osgi.jmx.codec.BundleBatchActionResult
public class BundleBatchActionResult
This class represents the CODEC for the resulting composite data from the batch operations on the bundles in the FrameworkMBean. It serves as both the documentation of the type structure and as the codification of the mechanism to convert to/from the CompositeData.
The structure of the composite data is:
Success | Boolean |
Error | String |
Completed | Array of long |
BundleInError | long |
Remaining | Array of long |
Field Summary | |
---|---|
static javax.management.openmbean.CompositeType |
RESULT
The CompositeType which represents the result of batch operations on the FrameworkMBean |
Constructor Summary | |
---|---|
BundleBatchActionResult()
Construct a result signifying the successful completion of the batch operation. |
|
BundleBatchActionResult(javax.management.openmbean.CompositeData compositeData)
Construct a result representing the contents of the supplied CompositeData returned from a batch operation. |
|
BundleBatchActionResult(java.lang.String errorMessage,
long[] completed,
long bundleInError,
long[] remaining)
Construct a result indictating the failure of a batch operation. |
Method Summary | |
---|---|
javax.management.openmbean.CompositeData |
asCompositeData()
Answer the receiver encoded as CompositeData |
long |
getBundleInError()
Answer the bundle identifier which indicates the bundle that produced an error during the batch operation. |
long[] |
getCompleted()
If the operation failed, answer the list of bundle identifiers that successfully completed the batch operation. |
java.lang.String |
getErrorMessage()
Answer the error message indicating the error that occurred during the batch operation or null, if the operation was a success. |
long[] |
getRemaining()
If the operation was unsuccessful, answer the list of bundle identifiers of the bundles that were not processed during the batch operation. |
boolean |
isSuccess()
Answer true if the batch operation was successful, false otherwise. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final javax.management.openmbean.CompositeType RESULT
Constructor Detail |
---|
public BundleBatchActionResult()
public BundleBatchActionResult(javax.management.openmbean.CompositeData compositeData)
compositeData
- - the CompositeData representing the result of a batch
operation.public BundleBatchActionResult(java.lang.String errorMessage, long[] completed, long bundleInError, long[] remaining)
errorMessage
- - the message indicating the errorcompleted
- - the list of bundle identifiers indicating bundles that have
successfully completed the batch operationbundleInError
- - the identifier of the bundle which produced the errorremaining
- - the list of bundle identifiers which remain unprocessedMethod Detail |
---|
public javax.management.openmbean.CompositeData asCompositeData()
public long getBundleInError()
public long[] getCompleted()
public java.lang.String getErrorMessage()
public long[] getRemaining()
public boolean isSuccess()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |