org.rhq.core.pluginapi.bundle

Class BundleHandoverResponse

java.lang.Object

org.rhq.core.pluginapi.bundle.BundleHandoverResponse

public class BundleHandoverResponse
extends Object

A response object returned by plugin component classes implementing BundleHandoverFacet.handleContent(BundleHandoverRequest).

Author:

Thomas Segismont

See Also:

BundleHandoverFacet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BundleHandoverResponse.FailureType

Method Summary

Methods

Modifier and Type	Method and Description
static BundleHandoverResponse	failure(BundleHandoverResponse.FailureType failureType)
static BundleHandoverResponse	failure(BundleHandoverResponse.FailureType failureType, String message)
static BundleHandoverResponse	failure(BundleHandoverResponse.FailureType failureType, String message, Throwable throwable)
BundleHandoverResponse.FailureType	getFailureType()
String	getMessage()
Throwable	getThrowable()
boolean	isSuccess()
static BundleHandoverResponse	success()
static BundleHandoverResponse	success(String message)

Methods inherited from class java.lang.Object

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

Method Detail

success

public static BundleHandoverResponse success()

success

public static BundleHandoverResponse success(String message)

failure

public static BundleHandoverResponse failure(BundleHandoverResponse.FailureType failureType)

Throws:

IllegalArgumentException - if failureType is null

failure

public static BundleHandoverResponse failure(BundleHandoverResponse.FailureType failureType,
                             String message)

Throws:

IllegalArgumentException - if failureType is null

failure

public static BundleHandoverResponse failure(BundleHandoverResponse.FailureType failureType,
                             String message,
                             Throwable throwable)

Throws:

IllegalArgumentException - if failureType is null

isSuccess

public boolean isSuccess()

Returns:

true if "handover" finished successfully, false otherwise

getMessage

public String getMessage()

Returns:

a message supplied by the resource component, null by default

getThrowable

public Throwable getThrowable()

Returns:

the throwable caught by the resource component, null by default

getFailureType

public BundleHandoverResponse.FailureType getFailureType()

Returns:

the type of failure if isSuccess() returns false, null otherwise