com.evolveum.midpoint.schema.result

Class OperationResult

java.lang.Object

com.evolveum.midpoint.schema.result.OperationResult

All Implemented Interfaces:

DebugDumpable, Serializable, Cloneable

public class OperationResult
extends Object
implements Serializable, DebugDumpable, Cloneable

Nested Operation Result. This class provides information 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.

Author:

lazyman, Radovan Semancik

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_IMPLEMENTATION_CLASS
static String	CONTEXT_ITEM
static String	CONTEXT_OBJECT
static String	CONTEXT_OID
static String	CONTEXT_PROGRESS
static String	CONTEXT_RESOURCE
static String	CONTEXT_TASK
static String	PARAM_OBJECT
static String	PARAM_OID
static String	PARAM_OPTIONS
static String	PARAM_QUERY
static String	PARAM_TASK
static String	PARAM_TYPE
static String	RETURN_BACKGROUND_TASK_OID
static String	RETURN_COUNT

Constructor Summary

Constructors

Constructor and Description
OperationResult(String operation)
OperationResult(String operation, long token, String messageCode, String message)
OperationResult(String operation, Map<String,Serializable> params, Map<String,Serializable> context, Map<String,Serializable> returns, OperationResultStatus status, long token, String messageCode, String message, String localizationMessage, List<Serializable> localizationArguments, Throwable cause, List<OperationResult> subresults)
OperationResult(String operation, Map<String,Serializable> params, OperationResultStatus status, long token, String messageCode, String message)
OperationResult(String operation, Map<String,Serializable> params, OperationResultStatus status, long token, String messageCode, String message, List<OperationResult> subresults)
OperationResult(String operation, Map<String,Serializable> params, OperationResultStatus status, long token, String messageCode, String message, String localizationMessage, List<Serializable> localizationArguments, Throwable cause, List<OperationResult> subresults)
OperationResult(String operation, Map<String,Serializable> params, OperationResultStatus status, long token, String messageCode, String message, String localizationMessage, Throwable cause, List<OperationResult> subresults)
OperationResult(String operation, OperationResultStatus status, long token, String messageCode, String message)
OperationResult(String operation, OperationResultStatus status, long token, String messageCode, String message, Throwable cause)
OperationResult(String operation, OperationResultStatus status, String message)
OperationResult(String operation, OperationResultStatus status, String messageCode, String message)
OperationResult(String operation, String messageCode, String message)

Method Summary

Methods

Modifier and Type	Method and Description
void	addArbitraryCollectionAsParam(String paramName, Collection values)
void	addArbitraryObjectAsParam(String paramName, Object paramValue)
void	addCollectionOfSerializablesAsParam(String paramName, Collection<? extends Serializable> paramValue)
void	addCollectionOfSerializablesAsReturn(String name, Collection<? extends Serializable> value)
void	addContext(String contextName, Serializable value)
void	addParam(String paramName, Serializable paramValue)
void	addParams(String[] names, Serializable... objects)
void	addReturn(String returnName, Serializable value)
void	addSubresult(OperationResult subresult)
void	appendDetail(String detailLine)
void	cleanupResult() Removes all the successful minor results.
void	cleanupResult(Throwable e) Removes all the successful minor results.
OperationResult	clone()
void	computeStatus() Computes operation result status based on subtask status.
void	computeStatus(String errorMessage) Computes operation result status based on subtask status and sets an error message if the status is FATAL_ERROR.
void	computeStatus(String errorMessage, String warnMessage)
void	computeStatusComposite() Used when the result contains several composite sub-result that are of equivalent meaning.
void	computeStatusIfUnknown()
OperationResult	createMinorSubresult(String operation)
static OperationResult	createOperationResult(OperationResultType result)
OperationResultType	createOperationResultType()
OperationResult	createSubresult(String operation)
String	debugDump() Show the content of the object intended for diagnostics by system administrator.
String	debugDump(int indent)
String	dump(boolean withStack)
OperationResult	findSubresult(String operation)
List<OperationResult>	findSubresults(String operation)
String	getBackgroundTaskOid()
Throwable	getCause()
OperationResultStatus	getComputeStatus()
Map<String,Serializable>	getContext()
<T> T	getContext(Class<T> type, String contextName)
int	getCount()
List<String>	getDetail()
int	getHiddenRecordsCount()
OperationResult	getLastSubresult()
OperationResultStatus	getLastSubresultStatus()
List<Serializable>	getLocalizationArguments()
String	getLocalizationMessage()
String	getMessage()
String	getMessageCode() Contains mesage code based on module error catalog.
String	getOperation() Contains operation name.
Map<String,Serializable>	getParams() Method returns Map with operation parameters.
Serializable	getReturn(String returnName)
Map<String,Serializable>	getReturns()
OperationResultStatus	getStatus() Contains operation status as defined in OperationResultStatus
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).
void	incrementCount()
boolean	isAcceptable() Returns true if the result is acceptable for further processing.
boolean	isEmpty()
boolean	isError()
boolean	isFatalError()
boolean	isHandledError()
boolean	isInProgress()
boolean	isNotApplicable()
boolean	isPartialError()
boolean	isSuccess() Returns true if the result is success.
boolean	isSummarizeErrors()
boolean	isSummarizePartialErrors()
boolean	isSummarizeSuccesses()
boolean	isUnknown()
boolean	isWarning()
void	muteError() If the operation is an error then it will switch the status to EXPECTED_ERROR.
void	muteLastSubresultError()
void	recomputeStatus()
void	recomputeStatus(String message)
void	recomputeStatus(String errorMessage, String warningMessage)
void	record(CommonException exception) Records result from a common exception type.
void	recordFatalError(String message)
void	recordFatalError(String message, Throwable cause)
void	recordFatalError(Throwable cause)
void	recordHandledError(String message)
void	recordHandledError(String message, Throwable cause)
void	recordHandledError(Throwable cause)
void	recordInProgress()
void	recordNotApplicableIfUnknown()
void	recordPartialError(String message)
void	recordPartialError(String message, Throwable cause)
void	recordPartialError(Throwable cause)
void	recordStatus(OperationResultStatus status, String message)
void	recordStatus(OperationResultStatus status, String message, Throwable cause)
void	recordStatus(OperationResultStatus status, Throwable cause)
void	recordSuccess()
void	recordSuccessIfUnknown()
void	recordUnknown()
void	recordWarning(String message)
void	recordWarning(String message, Throwable cause)
void	recordWarning(Throwable cause)
void	removeLastSubresult()
boolean	representsHiddenRecords()
void	setBackgroundTaskOid(String oid)
void	setCount(int count)
void	setErrorsHandled() Set all error status in this result and all subresults as handled.
void	setHiddenRecordsCount(int hiddenRecordsCount)
void	setMessage(String message)
void	setStatus(OperationResultStatus status)
void	setSummarizeErrors(boolean summarizeErrors)
void	setSummarizePartialErrors(boolean summarizePartialErrors)
void	setSummarizeSuccesses(boolean summarizeSuccesses)
void	summarize()
void	summarize(boolean alsoSubresults)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_IMPLEMENTATION_CLASS

public static final String CONTEXT_IMPLEMENTATION_CLASS

See Also:

Constant Field Values

CONTEXT_PROGRESS

public static final String CONTEXT_PROGRESS

See Also:

Constant Field Values

CONTEXT_OID

public static final String CONTEXT_OID

See Also:

Constant Field Values

CONTEXT_OBJECT

public static final String CONTEXT_OBJECT

See Also:

Constant Field Values

CONTEXT_ITEM

public static final String CONTEXT_ITEM

See Also:

Constant Field Values

CONTEXT_TASK

public static final String CONTEXT_TASK

See Also:

Constant Field Values

CONTEXT_RESOURCE

public static final String CONTEXT_RESOURCE

See Also:

Constant Field Values

PARAM_OID

public static final String PARAM_OID

See Also:

Constant Field Values

PARAM_TYPE

public static final String PARAM_TYPE

See Also:

Constant Field Values

PARAM_OPTIONS

public static final String PARAM_OPTIONS

See Also:

Constant Field Values

PARAM_TASK

public static final String PARAM_TASK

See Also:

Constant Field Values

PARAM_OBJECT

public static final String PARAM_OBJECT

See Also:

Constant Field Values

PARAM_QUERY

public static final String PARAM_QUERY

See Also:

Constant Field Values

RETURN_COUNT

public static final String RETURN_COUNT

See Also:

Constant Field Values

RETURN_BACKGROUND_TASK_OID

public static final String RETURN_BACKGROUND_TASK_OID

See Also:

Constant Field Values

Constructor Detail

OperationResult

public OperationResult(String operation)

OperationResult

public OperationResult(String operation,
               String messageCode,
               String message)

OperationResult

public OperationResult(String operation,
               long token,
               String messageCode,
               String message)

OperationResult

public OperationResult(String operation,
               OperationResultStatus status,
               String message)

OperationResult

public OperationResult(String operation,
               OperationResultStatus status,
               String messageCode,
               String message)

OperationResult

public OperationResult(String operation,
               OperationResultStatus status,
               long token,
               String messageCode,
               String message)

OperationResult

public OperationResult(String operation,
               OperationResultStatus status,
               long token,
               String messageCode,
               String message,
               Throwable cause)

OperationResult

public OperationResult(String operation,
               Map<String,Serializable> params,
               OperationResultStatus status,
               long token,
               String messageCode,
               String message)

OperationResult

public OperationResult(String operation,
               Map<String,Serializable> params,
               OperationResultStatus status,
               long token,
               String messageCode,
               String message,
               List<OperationResult> subresults)

OperationResult

public OperationResult(String operation,
               Map<String,Serializable> params,
               OperationResultStatus status,
               long token,
               String messageCode,
               String message,
               String localizationMessage,
               Throwable cause,
               List<OperationResult> subresults)

OperationResult

public OperationResult(String operation,
               Map<String,Serializable> params,
               OperationResultStatus status,
               long token,
               String messageCode,
               String message,
               String localizationMessage,
               List<Serializable> localizationArguments,
               Throwable cause,
               List<OperationResult> subresults)

OperationResult

public OperationResult(String operation,
               Map<String,Serializable> params,
               Map<String,Serializable> context,
               Map<String,Serializable> returns,
               OperationResultStatus status,
               long token,
               String messageCode,
               String message,
               String localizationMessage,
               List<Serializable> localizationArguments,
               Throwable cause,
               List<OperationResult> subresults)

Method Detail

createSubresult

public OperationResult createSubresult(String operation)

createMinorSubresult

public OperationResult createMinorSubresult(String operation)

getOperation

public String getOperation()

Contains operation name. Operation name must be defined as 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.

Returns:

always return non null, non empty string

getCount

public int getCount()

setCount

public void setCount(int count)

incrementCount

public void incrementCount()

getHiddenRecordsCount

public int getHiddenRecordsCount()

setHiddenRecordsCount

public void setHiddenRecordsCount(int hiddenRecordsCount)

representsHiddenRecords

public boolean representsHiddenRecords()

isSummarizeErrors

public boolean isSummarizeErrors()

setSummarizeErrors

public void setSummarizeErrors(boolean summarizeErrors)

isSummarizePartialErrors

public boolean isSummarizePartialErrors()

setSummarizePartialErrors

public void setSummarizePartialErrors(boolean summarizePartialErrors)

isSummarizeSuccesses

public boolean isSummarizeSuccesses()

setSummarizeSuccesses

public void setSummarizeSuccesses(boolean summarizeSuccesses)

isEmpty

public boolean isEmpty()

getSubresults

public List<OperationResult> getSubresults()

Method returns list of operation subresults @{link OperationResult.

Returns:

never returns null

getLastSubresult

public OperationResult getLastSubresult()

Returns:

last subresult, or null if there are no subresults.

removeLastSubresult

public void removeLastSubresult()

getLastSubresultStatus

public OperationResultStatus getLastSubresultStatus()

Returns:

last subresult status, or null if there are no subresults.

addSubresult

public void addSubresult(OperationResult subresult)

findSubresult

public OperationResult findSubresult(String operation)

findSubresults

public List<OperationResult> findSubresults(String operation)

getStatus

public OperationResultStatus getStatus()

Contains operation status as defined in OperationResultStatus

Returns:

never returns null

setStatus

public void setStatus(OperationResultStatus status)

isSuccess

public boolean isSuccess()

Returns true if the result is success. This returns true if the result is absolute success. Presence of partial failures or warnings fail this test.

Returns:

true if the result is success.

isWarning

public boolean isWarning()

isAcceptable

public boolean isAcceptable()

Returns true if the result is acceptable for further processing. In other words: if there were no fatal errors. Warnings and partial errors are acceptable. Yet, this test also fails if the operation state is not known.

Returns:

true if the result is acceptable for further processing.

isUnknown

public boolean isUnknown()

isInProgress

public boolean isInProgress()

isError

public boolean isError()

isFatalError

public boolean isFatalError()

isPartialError

public boolean isPartialError()

isHandledError

public boolean isHandledError()

isNotApplicable

public boolean isNotApplicable()

setErrorsHandled

public void setErrorsHandled()

Set all error status in this result and all subresults as handled.

computeStatus

public void computeStatus(String errorMessage)

Computes operation result status based on subtask status and sets an error message if the status is FATAL_ERROR.

Parameters:

errorMessage - error message

computeStatus

public void computeStatus(String errorMessage,
                 String warnMessage)

computeStatus

public void computeStatus()

Computes operation result status based on subtask status.

computeStatusComposite

public void computeStatusComposite()

Used when the result contains several composite sub-result that are of equivalent meaning. If all of them fail the result will be fatal error as well. If only some of them fail the result will be partial error. Handled error is considered a success.

getComputeStatus

public OperationResultStatus getComputeStatus()

computeStatusIfUnknown

public void computeStatusIfUnknown()

recomputeStatus

public void recomputeStatus()

recomputeStatus

public void recomputeStatus(String message)

recomputeStatus

public void recomputeStatus(String errorMessage,
                   String warningMessage)

recordSuccessIfUnknown

public void recordSuccessIfUnknown()

recordNotApplicableIfUnknown

public void recordNotApplicableIfUnknown()

getParams

public Map<String,Serializable> getParams()

Method returns Map with operation parameters. Parameters keys are described in module interface for every operation.

Returns:

never returns null

addParam

public void addParam(String paramName,
            Serializable paramValue)

addArbitraryObjectAsParam

public void addArbitraryObjectAsParam(String paramName,
                             Object paramValue)

addCollectionOfSerializablesAsParam

public void addCollectionOfSerializablesAsParam(String paramName,
                                       Collection<? extends Serializable> paramValue)

addCollectionOfSerializablesAsReturn

public void addCollectionOfSerializablesAsReturn(String name,
                                        Collection<? extends Serializable> value)

addArbitraryCollectionAsParam

public void addArbitraryCollectionAsParam(String paramName,
                                 Collection values)

addParams

public void addParams(String[] names,
             Serializable... objects)

getContext

public Map<String,Serializable> getContext()

getContext

public <T> T getContext(Class<T> type,
               String contextName)

addContext

public void addContext(String contextName,
              Serializable value)

getReturns

public Map<String,Serializable> getReturns()

addReturn

public void addReturn(String returnName,
             Serializable value)

getReturn

public Serializable getReturn(String returnName)

getToken

public long getToken()

Returns:

Contains random long number, for better searching in logs.

getMessageCode

public String getMessageCode()

Contains mesage code based on module error catalog.

Returns:

Can return null.

getMessage

public String getMessage()

Returns:

Method returns operation result message. Message is required. It will be key for translation in admin-gui.

setMessage

public void setMessage(String message)

getLocalizationMessage

public String getLocalizationMessage()

Returns:

Method returns message key for translation, can be null.

getLocalizationArguments

public List<Serializable> getLocalizationArguments()

Returns:

Method returns arguments if needed for localization, can be null.

getCause

public Throwable getCause()

Returns:

Method returns operation result exception. Not required, can be null.

recordSuccess

public void recordSuccess()

recordInProgress

public void recordInProgress()

recordUnknown

public void recordUnknown()

recordFatalError

public void recordFatalError(Throwable cause)

muteError

public void muteError()

If the operation is an error then it will switch the status to EXPECTED_ERROR. This is used if the error is expected and properly handled.

muteLastSubresultError

public void muteLastSubresultError()

recordPartialError

public void recordPartialError(Throwable cause)

recordWarning

public void recordWarning(Throwable cause)

recordStatus

public void recordStatus(OperationResultStatus status,
                Throwable cause)

recordFatalError

public void recordFatalError(String message,
                    Throwable cause)

recordPartialError

public void recordPartialError(String message,
                      Throwable cause)

recordWarning

public void recordWarning(String message,
                 Throwable cause)

recordHandledError

public void recordHandledError(String message)

recordHandledError

public void recordHandledError(String message,
                      Throwable cause)

recordHandledError

public void recordHandledError(Throwable cause)

recordStatus

public void recordStatus(OperationResultStatus status,
                String message,
                Throwable cause)

recordFatalError

public void recordFatalError(String message)

recordPartialError

public void recordPartialError(String message)

recordWarning

public void recordWarning(String message)

record

public void record(CommonException exception)

Records result from a common exception type. This automatically determines status and also sets appropriate message.

Parameters:

exception - common exception

recordStatus

public void recordStatus(OperationResultStatus status,
                String message)

hasUnknownStatus

public boolean hasUnknownStatus()

Returns true if result status is UNKNOWN or any of the subresult status is unknown (recursive). May come handy in tests to check if all the operations fill out the status as they should.

appendDetail

public void appendDetail(String detailLine)

getDetail

public List<String> getDetail()

toString

public String toString()

Overrides:

toString in class Object

createOperationResult

public static OperationResult createOperationResult(OperationResultType result)

createOperationResultType

public OperationResultType createOperationResultType()

summarize

public void summarize()

summarize

public void summarize(boolean alsoSubresults)

cleanupResult

public void cleanupResult()

Removes all the successful minor results. Also checks if the result is roughly consistent and complete. (e.g. does not have unknown operation status, etc.)

cleanupResult

public void cleanupResult(Throwable e)

Removes all the successful minor results. Also checks if the result is roughly consistent and complete. (e.g. does not have unknown operation status, etc.) The argument "e" is for easier use of the cleanup in the exceptions handlers. The original exception is passed to the IAE that this method produces for easier debugging.

debugDump

public String debugDump()

Description copied from interface: DebugDumpable

Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.

Specified by:

debugDump in interface DebugDumpable

Returns:

content of the object intended for diagnostics by system administrator.

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

dump

public String dump(boolean withStack)

setBackgroundTaskOid

public void setBackgroundTaskOid(String oid)

getBackgroundTaskOid

public String getBackgroundTaskOid()

clone

public OperationResult clone()

Overrides:

clone in class Object