|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.evolveum.midpoint.common.result.OperationResult
public class OperationResult
Nested Operation Result. This class provides informations for better error handling in complex operations. It contains a status (success, failure, warning, ...) and an error message. It also contains a set of sub-results - results on inner operations. This object can be used by GUI to display smart (and interactive) error information. It can also be used by the client code to detect deeper problems in the invocations, retry or otherwise compensate for the errors or decide how severe the error was and it is possible to proceed.
Field Summary | |
---|---|
static java.lang.String |
CONTEXT_IMPLEMENTATION_CLASS
|
static java.lang.String |
CONTEXT_OBJECT
|
static java.lang.String |
CONTEXT_OID
|
static java.lang.String |
CONTEXT_PROGRESS
|
static java.lang.String |
CONTEXT_PROPERTY
|
static java.lang.String |
CONTEXT_TASK
|
static java.lang.String |
PARAM_OBJECT
|
static java.lang.String |
PARAM_OID
|
static java.lang.String |
PARAM_TASK
|
Constructor Summary | |
---|---|
OperationResult(java.lang.String operation)
|
|
OperationResult(java.lang.String operation,
long token,
java.lang.String messageCode,
java.lang.String message)
|
|
OperationResult(java.lang.String operation,
java.util.Map<java.lang.String,java.lang.Object> params,
OperationResultStatus status,
long token,
java.lang.String messageCode,
java.lang.String message)
|
|
OperationResult(java.lang.String operation,
java.util.Map<java.lang.String,java.lang.Object> params,
OperationResultStatus status,
long token,
java.lang.String messageCode,
java.lang.String message,
java.util.List<OperationResult> subresults)
|
|
OperationResult(java.lang.String operation,
java.util.Map<java.lang.String,java.lang.Object> params,
OperationResultStatus status,
long token,
java.lang.String messageCode,
java.lang.String message,
java.lang.String localizationMessage,
java.util.List<java.lang.Object> localizationArguments,
java.lang.Throwable cause,
java.util.List<OperationResult> subresults)
|
|
OperationResult(java.lang.String operation,
java.util.Map<java.lang.String,java.lang.Object> params,
OperationResultStatus status,
long token,
java.lang.String messageCode,
java.lang.String message,
java.lang.String localizationMessage,
java.lang.Throwable cause,
java.util.List<OperationResult> subresults)
|
|
OperationResult(java.lang.String operation,
OperationResultStatus status,
long token,
java.lang.String messageCode,
java.lang.String message)
|
|
OperationResult(java.lang.String operation,
OperationResultStatus status,
long token,
java.lang.String messageCode,
java.lang.String message,
java.lang.Throwable cause)
|
|
OperationResult(java.lang.String operation,
OperationResultStatus status,
java.lang.String message)
|
|
OperationResult(java.lang.String operation,
OperationResultStatus status,
java.lang.String messageCode,
java.lang.String message)
|
|
OperationResult(java.lang.String operation,
java.lang.String messageCode,
java.lang.String message)
|
Method Summary | ||
---|---|---|
void |
addContext(java.lang.String contextName,
java.lang.Object value)
|
|
void |
addParam(java.lang.String paramName,
java.lang.Object paramValue)
|
|
void |
addParams(java.lang.String[] names,
java.lang.Object... objects)
|
|
void |
addSubresult(OperationResult subresult)
|
|
void |
appendDetail(java.lang.String detailLine)
|
|
void |
computeStatus()
Computes operation result status based on subtask status. |
|
void |
computeStatus(java.lang.String errorMessage)
Computes operation result status based on subtask status and sets an error message if the status is FATAL_ERROR. |
|
void |
computeStatus(java.lang.String errorMessage,
java.lang.String warnMessage)
|
|
static OperationResult |
createOperationResult(OperationResultType result)
|
|
OperationResultType |
createOperationResultType()
|
|
OperationResult |
createSubresult(java.lang.String operation)
|
|
java.lang.String |
dump()
Show the content of the object intended for diagnostics by developer. |
|
java.lang.String |
dump(boolean withStack)
|
|
java.lang.Throwable |
getCause()
|
|
java.util.Map<java.lang.String,java.lang.Object> |
getContext()
|
|
|
getContext(java.lang.Class<T> type,
java.lang.String contextName)
|
|
java.util.List<java.lang.String> |
getDetail()
|
|
java.util.List<java.lang.Object> |
getLocalizationArguments()
|
|
java.lang.String |
getLocalizationMessage()
|
|
java.lang.String |
getMessage()
|
|
java.lang.String |
getMessageCode()
Contains mesage code based on module error catalog. |
|
java.lang.String |
getOperation()
Contains operation name. |
|
java.util.Map<java.lang.String,java.lang.Object> |
getParams()
Method returns Map with operation parameters. |
|
java.lang.Object |
getReturnValue()
|
|
OperationResultStatus |
getStatus()
Contains operation status as defined in OperationResultStatus |
|
java.util.List<OperationResult> |
getSubresults()
Method returns list of operation subresults @{link OperationResult . |
|
long |
getToken()
|
|
boolean |
hasUnknownStatus()
Returns true if result status is UNKNOWN or any of the subresult status is unknown (recursive). |
|
boolean |
isAcceptable()
Returns true if the result is acceptable for further processing. |
|
boolean |
isError()
|
|
boolean |
isSuccess()
Returns true if the result is success. |
|
boolean |
isUnknown()
|
|
boolean |
isWarning()
|
|
void |
recomputeStatus()
|
|
void |
recomputeStatus(java.lang.String message)
|
|
void |
recomputeStatus(java.lang.String errorMessage,
java.lang.String warningMessage)
|
|
void |
record(CommonException exception)
Records result from a common exception type. |
|
void |
recordFatalError(java.lang.String message)
|
|
void |
recordFatalError(java.lang.String message,
java.lang.Throwable cause)
|
|
void |
recordFatalError(java.lang.Throwable cause)
|
|
void |
recordPartialError(java.lang.String message)
|
|
void |
recordPartialError(java.lang.String message,
java.lang.Throwable cause)
|
|
void |
recordPartialError(java.lang.Throwable cause)
|
|
void |
recordStatus(OperationResultStatus status,
java.lang.String message)
|
|
void |
recordStatus(OperationResultStatus status,
java.lang.String message,
java.lang.Throwable cause)
|
|
void |
recordStatus(OperationResultStatus status,
java.lang.Throwable cause)
|
|
void |
recordSuccess()
|
|
void |
recordSuccessIfUnknown()
|
|
void |
recordWarning(java.lang.String message)
|
|
void |
recordWarning(java.lang.String message,
java.lang.Throwable cause)
|
|
void |
recordWarning(java.lang.Throwable cause)
|
|
void |
setReturnValue(java.lang.Object returnValue)
|
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CONTEXT_IMPLEMENTATION_CLASS
public static final java.lang.String CONTEXT_PROGRESS
public static final java.lang.String CONTEXT_OID
public static final java.lang.String CONTEXT_OBJECT
public static final java.lang.String CONTEXT_PROPERTY
public static final java.lang.String PARAM_OID
public static final java.lang.String PARAM_TASK
public static final java.lang.String PARAM_OBJECT
public static final java.lang.String CONTEXT_TASK
Constructor Detail |
---|
public OperationResult(java.lang.String operation)
public OperationResult(java.lang.String operation, java.lang.String messageCode, java.lang.String message)
public OperationResult(java.lang.String operation, long token, java.lang.String messageCode, java.lang.String message)
public OperationResult(java.lang.String operation, OperationResultStatus status, java.lang.String message)
public OperationResult(java.lang.String operation, OperationResultStatus status, java.lang.String messageCode, java.lang.String message)
public OperationResult(java.lang.String operation, OperationResultStatus status, long token, java.lang.String messageCode, java.lang.String message)
public OperationResult(java.lang.String operation, OperationResultStatus status, long token, java.lang.String messageCode, java.lang.String message, java.lang.Throwable cause)
public OperationResult(java.lang.String operation, java.util.Map<java.lang.String,java.lang.Object> params, OperationResultStatus status, long token, java.lang.String messageCode, java.lang.String message)
public OperationResult(java.lang.String operation, java.util.Map<java.lang.String,java.lang.Object> params, OperationResultStatus status, long token, java.lang.String messageCode, java.lang.String message, java.util.List<OperationResult> subresults)
public OperationResult(java.lang.String operation, java.util.Map<java.lang.String,java.lang.Object> params, OperationResultStatus status, long token, java.lang.String messageCode, java.lang.String message, java.lang.String localizationMessage, java.lang.Throwable cause, java.util.List<OperationResult> subresults)
public OperationResult(java.lang.String operation, java.util.Map<java.lang.String,java.lang.Object> params, OperationResultStatus status, long token, java.lang.String messageCode, java.lang.String message, java.lang.String localizationMessage, java.util.List<java.lang.Object> localizationArguments, java.lang.Throwable cause, java.util.List<OperationResult> subresults)
Method Detail |
---|
public OperationResult createSubresult(java.lang.String operation)
public java.lang.String getOperation()
String
constant in module interface with description and possible parameters. It
can be used for further processing. It will be used as key for
translation in admin-gui.
public java.util.List<OperationResult> getSubresults()
OperationResult
.
public void addSubresult(OperationResult subresult)
public OperationResultStatus getStatus()
OperationResultStatus
public boolean isSuccess()
public boolean isWarning()
public boolean isAcceptable()
public boolean isUnknown()
public boolean isError()
public void computeStatus(java.lang.String errorMessage)
errorMessage
- error messagepublic void computeStatus(java.lang.String errorMessage, java.lang.String warnMessage)
public void computeStatus()
public void recomputeStatus()
public void recomputeStatus(java.lang.String message)
public void recomputeStatus(java.lang.String errorMessage, java.lang.String warningMessage)
public void recordSuccessIfUnknown()
public java.util.Map<java.lang.String,java.lang.Object> getParams()
Map
with operation parameters. Parameters keys are
described in module interface for every operation.
public void addParam(java.lang.String paramName, java.lang.Object paramValue)
public void addParams(java.lang.String[] names, java.lang.Object... objects)
public java.util.Map<java.lang.String,java.lang.Object> getContext()
public <T> T getContext(java.lang.Class<T> type, java.lang.String contextName)
public void addContext(java.lang.String contextName, java.lang.Object value)
public java.lang.Object getReturnValue()
public void setReturnValue(java.lang.Object returnValue)
public long getToken()
public java.lang.String getMessageCode()
public java.lang.String getMessage()
public java.lang.String getLocalizationMessage()
public java.util.List<java.lang.Object> getLocalizationArguments()
public java.lang.Throwable getCause()
public void recordSuccess()
public void recordFatalError(java.lang.Throwable cause)
public void recordPartialError(java.lang.Throwable cause)
public void recordWarning(java.lang.Throwable cause)
public void recordStatus(OperationResultStatus status, java.lang.Throwable cause)
public void recordFatalError(java.lang.String message, java.lang.Throwable cause)
public void recordPartialError(java.lang.String message, java.lang.Throwable cause)
public void recordWarning(java.lang.String message, java.lang.Throwable cause)
public void recordStatus(OperationResultStatus status, java.lang.String message, java.lang.Throwable cause)
public void recordFatalError(java.lang.String message)
public void recordPartialError(java.lang.String message)
public void recordWarning(java.lang.String message)
public void record(CommonException exception)
exception
- common exceptionpublic void recordStatus(OperationResultStatus status, java.lang.String message)
public boolean hasUnknownStatus()
public void appendDetail(java.lang.String detailLine)
public java.util.List<java.lang.String> getDetail()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String dump()
Dumpable
dump
in interface Dumpable
public java.lang.String dump(boolean withStack)
public static OperationResult createOperationResult(OperationResultType result)
public OperationResultType createOperationResultType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |