com.evolveum.midpoint.provisioning.api
Class ResourceOperationDescription

java.lang.Object
  extended by com.evolveum.midpoint.provisioning.api.ResourceOperationDescription
All Implemented Interfaces:
DebugDumpable, Dumpable

public class ResourceOperationDescription
extends Object
implements Dumpable, DebugDumpable

Describes an attempt to apply a change to a specific resource object.

Author:
Radovan Semancik

Field Summary
 
Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING
 
Constructor Summary
ResourceOperationDescription()
           
 
Method Summary
 void checkConsistence()
           
 String debugDump()
          Show the content of the object intended for diagnostics by system administrator.
 String debugDump(int indent)
           
 String dump()
          Show the content of the object intended for diagnostics by developer.
 int getAttemptNumber()
           
 PrismObject<? extends ResourceObjectShadowType> getCurrentShadow()
          Shadow describing the object that was the target of the operation.
 ObjectDelta<? extends ResourceObjectShadowType> getObjectDelta()
          The operation that was about to execute and that has failed.
 PrismObject<ResourceType> getResource()
           
 OperationResult getResult()
          Result of the failed operation.
 String getSourceChannel()
           
 boolean isAsynchronous()
          True if the operation is asynchronous.
 void setAsynchronous(boolean asynchronous)
           
 void setAttemptNumber(int attemptNumber)
           
 void setCurrentShadow(PrismObject<? extends ResourceObjectShadowType> currentShadow)
           
 void setObjectDelta(ObjectDelta<? extends ResourceObjectShadowType> objectDelta)
           
 void setResource(PrismObject<ResourceType> resource)
           
 void setResult(OperationResult result)
           
 void setSourceChannel(String sourceChannel)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResourceOperationDescription

public ResourceOperationDescription()
Method Detail

getObjectDelta

public ObjectDelta<? extends ResourceObjectShadowType> getObjectDelta()
The operation that was about to execute and that has failed.


setObjectDelta

public void setObjectDelta(ObjectDelta<? extends ResourceObjectShadowType> objectDelta)

getCurrentShadow

public PrismObject<? extends ResourceObjectShadowType> getCurrentShadow()
Shadow describing the object that was the target of the operation. It may a "temporary" shadow that is not yet bound to a specific resource object (e.g. in case of add operation).


setCurrentShadow

public void setCurrentShadow(PrismObject<? extends ResourceObjectShadowType> currentShadow)

getSourceChannel

public String getSourceChannel()

setSourceChannel

public void setSourceChannel(String sourceChannel)

getResource

public PrismObject<ResourceType> getResource()

setResource

public void setResource(PrismObject<ResourceType> resource)

getResult

public OperationResult getResult()
Result of the failed operation.


setResult

public void setResult(OperationResult result)

isAsynchronous

public boolean isAsynchronous()
True if the operation is asynchronous. I.e. true if the operation cannot provide direct return value and therefore the invocation of the listener is the only way how to pass operation return value to the upper layers. This may be useful e.g. for decided whether log the message and what log level to use (it can be assumed that the error gets logged at least once for synchronous operations, but this may be the only chance to properly log it for asynchronous operations).


setAsynchronous

public void setAsynchronous(boolean asynchronous)

getAttemptNumber

public int getAttemptNumber()

setAttemptNumber

public void setAttemptNumber(int attemptNumber)

checkConsistence

public void checkConsistence()

toString

public String toString()
Overrides:
toString in class Object

dump

public String dump()
Description copied from interface: Dumpable
Show the content of the object intended for diagnostics by developer. The content may be multi-line, in case of hierarchical objects it may be intended. The use of this method may not be efficient. It is not supposed to be used in normal operation. However, it is very useful in tests or in case of dumping objects in severe error situations.

Specified by:
dump in interface Dumpable
Returns:
content of the object intended for diagnostics.

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


Copyright © 2013 evolveum. All Rights Reserved.