de.aristaflow.adept2.core.logmanager.logs

Interface ExecutionHistoryWriteAccess

public interface ExecutionHistoryWriteAccess

This interface defines methods for write access to the execution history.

Author:

Patrick Schmidt

Method Summary

Modifier and Type	Method and Description
void	archiveInstance(SessionToken session, java.util.UUID instanceLogID) Archives the data of the designated instance to a separate archive.
void	logInstanceChanged(SessionToken session, long timestamp, Instance instance)
void	logInstanceFailed(SessionToken session, long timestamp, Instance instance, long errorCode, java.lang.String errorState, java.lang.String errorMessage)
void	logInstanceFinished(SessionToken session, long timestamp, Instance instance)
void	logInstanceResumed(SessionToken session, long timestamp, Instance instance)
void	logInstanceStarted(SessionToken session, long timestamp, Instance instance)
void	logInstanceSuspended(SessionToken session, long timestamp, Instance instance)
void	logNodeActivated(SessionToken session, long timestamp, Instance instance, int nodeID, int iteration)
void	logNodeDeselected(SessionToken session, long timestamp, Instance instance, int nodeID, int iteration)
void	logNodeFailed(SessionToken session, long timestamp, java.lang.Long clientDelay, Instance instance, int nodeID, int iteration, long errorCode, java.lang.String errorState, java.lang.String errorMessage)
void	logNodeFinished(SessionToken session, long timestamp, java.lang.Long clientDelay, Instance instance, int nodeID, java.util.Map<java.lang.String,java.lang.String> nodeName, int iteration, java.net.URI[] executionManagerURIs)
void	logNodePromoted(SessionToken session, long timestamp, Instance instance, int nodeId, int iteration, ProcessConstants.NodeState promState) Logs that the activity identified by the designated instance, node and node iteration has been promoted.
void	logNodeResetHard(SessionToken session, long timestamp, Instance instance, int nodeId, int iteration, java.lang.String savepoint) Logs that the activity identified by the designated instance, node and node iteration has been reset to the designated savepoint.
void	logNodeResetSoft(SessionToken session, long timestamp, java.lang.Long clientDelay, Instance instance, int nodeID, int iteration)
void	logNodeResetTo(SessionToken session, long timestamp, java.lang.Long clientDelay, Instance instance, int nodeId, int iteration, java.lang.String savepoint) Logs that the activity identified by the designated instance, node and node iteration has been reset itself to the designated savepoint.
void	logNodeResumed(SessionToken session, long timestamp, Instance instance, int nodeID, int iteration)
void	logNodeSelected(SessionToken session, long timestamp, Instance instance, int nodeID, int iteration)
void	logNodeSkipped(SessionToken session, long timestamp, Instance instance, int nodeID, int iteration)
void	logNodeStarted(SessionToken session, long timestamp, Instance instance, int nodeID, java.util.Map<java.lang.String,java.lang.String> nodeName, int iteration)
void	logNodeSuppressed(SessionToken session, long timestamp, Instance instance, int nodeId, int iteration, ProcessConstants.NodeState prevState) Logs that the activity identified by the designated instance, node and node iteration has been suppressed.
void	logNodeSuspended(SessionToken session, long timestamp, java.lang.Long clientDelay, Instance instance, int nodeID, int iteration)
void	logSavepointFlushed(SessionToken session, long timestamp, java.lang.Long clientDelay, Instance instance, int nodeId, int iteration, java.lang.String savepoint) Logs that the activity identified by the designated instance, node and node iteration has flushed its data with the designated savepoint ID.

Method Detail

logInstanceStarted

void logInstanceStarted(SessionToken session,
                        long timestamp,
                        Instance instance)
                 throws DataSourceException

Throws:

DataSourceException

logInstanceSuspended

void logInstanceSuspended(SessionToken session,
                          long timestamp,
                          Instance instance)
                   throws DataSourceException

Throws:

DataSourceException

logInstanceResumed

void logInstanceResumed(SessionToken session,
                        long timestamp,
                        Instance instance)
                 throws DataSourceException

Throws:

DataSourceException

logInstanceFinished

void logInstanceFinished(SessionToken session,
                         long timestamp,
                         Instance instance)
                  throws DataSourceException

Throws:

DataSourceException

logInstanceFailed

void logInstanceFailed(SessionToken session,
                       long timestamp,
                       Instance instance,
                       long errorCode,
                       java.lang.String errorState,
                       java.lang.String errorMessage)
                throws DataSourceException

Throws:

DataSourceException

logInstanceChanged

void logInstanceChanged(SessionToken session,
                        long timestamp,
                        Instance instance)
                 throws DataSourceException

Throws:

DataSourceException

logNodeActivated

void logNodeActivated(SessionToken session,
                      long timestamp,
                      Instance instance,
                      int nodeID,
                      int iteration)
               throws DataSourceException

Throws:

DataSourceException

logNodeSelected

void logNodeSelected(SessionToken session,
                     long timestamp,
                     Instance instance,
                     int nodeID,
                     int iteration)
              throws DataSourceException

Throws:

DataSourceException

logNodeDeselected

void logNodeDeselected(SessionToken session,
                       long timestamp,
                       Instance instance,
                       int nodeID,
                       int iteration)
                throws DataSourceException

Throws:

DataSourceException

logNodeStarted

void logNodeStarted(SessionToken session,
                    long timestamp,
                    Instance instance,
                    int nodeID,
                    java.util.Map<java.lang.String,java.lang.String> nodeName,
                    int iteration)
             throws DataSourceException

Throws:

DataSourceException

logNodeSuspended

void logNodeSuspended(SessionToken session,
                      long timestamp,
                      java.lang.Long clientDelay,
                      Instance instance,
                      int nodeID,
                      int iteration)
               throws DataSourceException

Throws:

DataSourceException

logNodeResumed

void logNodeResumed(SessionToken session,
                    long timestamp,
                    Instance instance,
                    int nodeID,
                    int iteration)
             throws DataSourceException

Throws:

DataSourceException

logNodeResetSoft

void logNodeResetSoft(SessionToken session,
                      long timestamp,
                      java.lang.Long clientDelay,
                      Instance instance,
                      int nodeID,
                      int iteration)
               throws DataSourceException

Throws:

DataSourceException

logNodeResetTo

void logNodeResetTo(SessionToken session,
                    long timestamp,
                    java.lang.Long clientDelay,
                    Instance instance,
                    int nodeId,
                    int iteration,
                    java.lang.String savepoint)
             throws DataSourceException

Logs that the activity identified by the designated instance, node and node iteration has been reset itself to the designated savepoint.

Parameters:

session - The session which is used to check for access rights on this method.

timestamp - The time for the log entry.

clientDelay - The delay (in ms) that occurred between the termination of an activity and the actual signalling to the execution manager.

instance - The process instance of the reset activity.

nodeId - The node of the reset activity.

iteration - The current iteration count of the reset node.

savepoint - The ID of the savepoint to which to reset.

Throws:

DataSourceException - If there are problems accessing and writing the underlying storage, a DataSourceException will be thrown.

logNodeResetHard

void logNodeResetHard(SessionToken session,
                      long timestamp,
                      Instance instance,
                      int nodeId,
                      int iteration,
                      java.lang.String savepoint)
               throws DataSourceException

Logs that the activity identified by the designated instance, node and node iteration has been reset to the designated savepoint.

Parameters:

session - The session which is used to check for access rights on this method.

timestamp - The time for the log entry.

instance - The process instance of the reset activity.

nodeId - The node of the reset activity.

iteration - The current iteration count of the reset node.

savepoint - The ID of the savepoint to which to reset. Use null to reset to the initial state..

Throws:

DataSourceException - If there are problems accessing and writing the underlying storage, a DataSourceException will be thrown.

logNodeSkipped

void logNodeSkipped(SessionToken session,
                    long timestamp,
                    Instance instance,
                    int nodeID,
                    int iteration)
             throws DataSourceException

Throws:

DataSourceException

logNodeFinished

void logNodeFinished(SessionToken session,
                     long timestamp,
                     java.lang.Long clientDelay,
                     Instance instance,
                     int nodeID,
                     java.util.Map<java.lang.String,java.lang.String> nodeName,
                     int iteration,
                     @Deprecated
                     java.net.URI[] executionManagerURIs)
              throws DataSourceException

Throws:

DataSourceException

logNodeFailed

void logNodeFailed(SessionToken session,
                   long timestamp,
                   java.lang.Long clientDelay,
                   Instance instance,
                   int nodeID,
                   int iteration,
                   long errorCode,
                   java.lang.String errorState,
                   java.lang.String errorMessage)
            throws DataSourceException

Throws:

DataSourceException

logNodeSuppressed

void logNodeSuppressed(SessionToken session,
                       long timestamp,
                       Instance instance,
                       int nodeId,
                       int iteration,
                       ProcessConstants.NodeState prevState)
                throws DataSourceException

Logs that the activity identified by the designated instance, node and node iteration has been suppressed.

Parameters:

session - The session which is used to check for access rights on this method.

timestamp - The time for the log entry.

instance - The process instance of the suppressed activity.

nodeId - The node of the suppressed activity.

iteration - The current iteration count of the suppressed node.

prevState - The previous (normal) state the activity had before being suppressed.

Throws:

DataSourceException - If there are problems accessing and writing the underlying storage, a DataSourceException will be thrown.

logNodePromoted

void logNodePromoted(SessionToken session,
                     long timestamp,
                     Instance instance,
                     int nodeId,
                     int iteration,
                     ProcessConstants.NodeState promState)
              throws DataSourceException

Logs that the activity identified by the designated instance, node and node iteration has been promoted.

Parameters:

session - The session which is used to check for access rights on this method.

timestamp - The time for the log entry.

instance - The process instance of the promoted activity.

nodeId - The node of the promoted activity.

iteration - The current iteration count of the promoted node.

promState - The (normal) state of the activity after promoting it. This is the state it had before suppression.

Throws:

DataSourceException - If there are problems accessing and writing the underlying storage, a DataSourceException will be thrown.

logSavepointFlushed

void logSavepointFlushed(SessionToken session,
                         long timestamp,
                         java.lang.Long clientDelay,
                         Instance instance,
                         int nodeId,
                         int iteration,
                         java.lang.String savepoint)
                  throws DataSourceException

Logs that the activity identified by the designated instance, node and node iteration has flushed its data with the designated savepoint ID.

Parameters:

session - The session which is used to check for access rights on this method.

timestamp - The time for the log entry.

clientDelay - The delay that may have occurred between the client flushing the savepoint and the arrival of the flusing at the server. This delay is usually caused by the server being unavailable and the client intermediately storing the values.

instance - The process instance of the flushing activity.

nodeId - The node of the flushing activity.

iteration - The current iteration count of the executed node.

savepoint - The ID of the savepoint that has been flushed. This must not be null, but it may be the empty string.

Throws:

DataSourceException - If there are problems accessing and writing the underyling storage, a DataSourceException will be thrown.

archiveInstance

void archiveInstance(SessionToken session,
                     java.util.UUID instanceLogID)
              throws DataSourceException

Archives the data of the designated instance to a separate archive. After this, the corresponding data will be deleted from this execution history. So no more access to any history entries concerning this instance is allowed after archiving.
Note that this method must only be called for terminated or finally failed instances! This cannot be checked here and therefore has to be ensured by the caller by using the archive methods of the process manager appropriately. Also only the data of the designated instance will be archived, child or parent instances of the designated instance are not considered.

Parameters:

session - The session which is used to check for access rights on this method.

instanceLogID - The log ID (!!) of the instance to archive all execution history entries.

Throws:

DataSourceException - If there are problems accessing the data source, a DataSourceException will be thrown.