mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
Formatted Alfresco-style
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@22322 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
@@ -26,7 +26,6 @@ import java.util.Date;
|
|||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.StringTokenizer;
|
import java.util.StringTokenizer;
|
||||||
|
|
||||||
import org.alfresco.repo.cache.EhCacheAdapter;
|
|
||||||
import org.alfresco.repo.cache.SimpleCache;
|
import org.alfresco.repo.cache.SimpleCache;
|
||||||
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
||||||
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
|
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
|
||||||
@@ -49,464 +48,463 @@ import org.apache.commons.logging.LogFactory;
|
|||||||
*
|
*
|
||||||
* @author Nick Burch
|
* @author Nick Burch
|
||||||
*/
|
*/
|
||||||
public class ActionTrackingServiceImpl implements ActionTrackingService
|
public class ActionTrackingServiceImpl implements ActionTrackingService
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* The logger
|
* The logger
|
||||||
*/
|
*/
|
||||||
private static Log logger = LogFactory.getLog(ActionTrackingServiceImpl.class);
|
private static Log logger = LogFactory.getLog(ActionTrackingServiceImpl.class);
|
||||||
|
|
||||||
private SimpleCache<String, ExecutionDetails> executingActionsCache;
|
private SimpleCache<String, ExecutionDetails> executingActionsCache;
|
||||||
|
private TransactionService transactionService;
|
||||||
private TransactionService transactionService;
|
private RuntimeActionService runtimeActionService;
|
||||||
private RuntimeActionService runtimeActionService;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Doesn't need to be cluster unique, is just used
|
|
||||||
* to try to reduce the chance of clashes in the
|
|
||||||
* quickest and easiest way.
|
|
||||||
*/
|
|
||||||
private short nextExecutionId = 1;
|
|
||||||
private short wrapExecutionIdAfter = Short.MAX_VALUE/2;
|
|
||||||
|
|
||||||
/** How we separate bits of the cache key */
|
|
||||||
private static final char cacheKeyPartSeparator = '=';
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the transaction service
|
|
||||||
*
|
|
||||||
* @param transactionService the transaction service
|
|
||||||
*/
|
|
||||||
public void setTransactionService(TransactionService transactionService)
|
|
||||||
{
|
|
||||||
this.transactionService = transactionService;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the runtime action service
|
* Doesn't need to be cluster unique, is just used to try to reduce the
|
||||||
*
|
* chance of clashes in the quickest and easiest way.
|
||||||
* @param runtimeActionService the runtime action service
|
*/
|
||||||
*/
|
private short nextExecutionId = 1;
|
||||||
public void setRuntimeActionService(RuntimeActionService runtimeActionService)
|
private short wrapExecutionIdAfter = Short.MAX_VALUE / 2;
|
||||||
{
|
/** How we separate bits of the cache key */
|
||||||
this.runtimeActionService = runtimeActionService;
|
private static final char cacheKeyPartSeparator = '=';
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Sets the cache used to store details of
|
|
||||||
* currently executing actions, cluster wide.
|
|
||||||
*/
|
|
||||||
public void setExecutingActionsCache(SimpleCache<String, ExecutionDetails> executingActionsCache)
|
|
||||||
{
|
|
||||||
this.executingActionsCache = executingActionsCache;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/** Used by unit tests only */
|
|
||||||
protected void resetNextExecutionId() {
|
|
||||||
this.nextExecutionId = 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public void recordActionPending(Action action)
|
|
||||||
{
|
|
||||||
recordActionPending((ActionImpl)action);
|
|
||||||
}
|
|
||||||
public void recordActionPending(ActionImpl action)
|
|
||||||
{
|
|
||||||
// Set the status
|
|
||||||
action.setExecutionStatus(ActionStatus.Pending);
|
|
||||||
|
|
||||||
// Mark it as not having started quite yet
|
|
||||||
action.setExecutionStartDate(null);
|
|
||||||
|
|
||||||
// Have it put into the cache, so we can tell it
|
|
||||||
// is waiting to be run
|
|
||||||
placeActionInCache(action);
|
|
||||||
}
|
|
||||||
|
|
||||||
public void recordActionComplete(Action action)
|
|
||||||
{
|
|
||||||
recordActionComplete((ActionImpl)action);
|
|
||||||
}
|
|
||||||
private void recordActionComplete(ActionImpl action)
|
|
||||||
{
|
|
||||||
if (logger.isDebugEnabled() == true)
|
|
||||||
{
|
|
||||||
logger.debug("Action " + action + " has completed execution");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Mark it as having worked
|
|
||||||
action.setExecutionEndDate(new Date());
|
|
||||||
action.setExecutionStatus(ActionStatus.Completed);
|
|
||||||
action.setExecutionFailureMessage(null);
|
|
||||||
if(action.getNodeRef() != null)
|
|
||||||
{
|
|
||||||
runtimeActionService.saveActionImpl(action.getNodeRef(), action);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove it from the cache, as it's finished
|
|
||||||
String key = generateCacheKey(action);
|
|
||||||
executingActionsCache.remove(key);
|
|
||||||
}
|
|
||||||
|
|
||||||
public void recordActionExecuting(Action action)
|
/**
|
||||||
{
|
* Set the transaction service
|
||||||
recordActionExecuting((ActionImpl)action);
|
*
|
||||||
}
|
* @param transactionService the transaction service
|
||||||
private void recordActionExecuting(ActionImpl action)
|
*/
|
||||||
{
|
public void setTransactionService(TransactionService transactionService)
|
||||||
if (logger.isDebugEnabled() == true)
|
{
|
||||||
{
|
this.transactionService = transactionService;
|
||||||
logger.debug("Action " + action + " with provisional key " + generateCacheKey(action) + " has begun exection");
|
}
|
||||||
}
|
|
||||||
|
/**
|
||||||
// Grab what status it was before
|
* Set the runtime action service
|
||||||
ActionStatus previousStatus = action.getExecutionStatus();
|
*
|
||||||
|
* @param runtimeActionService the runtime action service
|
||||||
// Mark the action as starting
|
*/
|
||||||
action.setExecutionStartDate(new Date());
|
public void setRuntimeActionService(RuntimeActionService runtimeActionService)
|
||||||
action.setExecutionStatus(ActionStatus.Running);
|
{
|
||||||
|
this.runtimeActionService = runtimeActionService;
|
||||||
// If it's a synchronous execution, put it into the cache
|
}
|
||||||
if(previousStatus != ActionStatus.Pending)
|
|
||||||
{
|
/**
|
||||||
placeActionInCache(action);
|
* Sets the cache used to store details of currently executing actions,
|
||||||
}
|
* cluster wide.
|
||||||
else
|
*/
|
||||||
{
|
public void setExecutingActionsCache(SimpleCache<String, ExecutionDetails> executingActionsCache)
|
||||||
// If it's async, update the existing cache entry
|
{
|
||||||
String key = generateCacheKey(action);
|
this.executingActionsCache = executingActionsCache;
|
||||||
ExecutionDetails details = executingActionsCache.get(key);
|
}
|
||||||
|
|
||||||
// Check it's really there, warn + fix if not
|
/** Used by unit tests only */
|
||||||
if(details == null) {
|
protected void resetNextExecutionId()
|
||||||
logger.warn(
|
{
|
||||||
"Went to mark the start of execution of " +
|
this.nextExecutionId = 1;
|
||||||
action + " with key " + key +
|
}
|
||||||
" but it wasn't in the running actions cache! " +
|
|
||||||
"Your running actions cache is probably too small"
|
public void recordActionPending(Action action)
|
||||||
);
|
{
|
||||||
}
|
recordActionPending((ActionImpl) action);
|
||||||
|
}
|
||||||
// Update and save into the cache
|
|
||||||
details = buildExecutionDetails(action);
|
public void recordActionPending(ActionImpl action)
|
||||||
executingActionsCache.put(key, details);
|
{
|
||||||
}
|
// Set the status
|
||||||
}
|
action.setExecutionStatus(ActionStatus.Pending);
|
||||||
|
|
||||||
/**
|
// Mark it as not having started quite yet
|
||||||
* For an action that needs to go into the cache
|
action.setExecutionStartDate(null);
|
||||||
* (async action that is pending, or sync action
|
|
||||||
* that is running), assign an execution instance
|
// Have it put into the cache, so we can tell it
|
||||||
* and put into the cache
|
// is waiting to be run
|
||||||
*/
|
placeActionInCache(action);
|
||||||
private void placeActionInCache(ActionImpl action)
|
}
|
||||||
{
|
|
||||||
// Assign it a (unique) execution ID
|
public void recordActionComplete(Action action)
|
||||||
// (Keep checking to see if the key is used as we
|
{
|
||||||
// increase nextExecutionId until it isn't)
|
recordActionComplete((ActionImpl) action);
|
||||||
String key = null;
|
}
|
||||||
boolean assigned = false;
|
|
||||||
while(!assigned) {
|
private void recordActionComplete(ActionImpl action)
|
||||||
// Try
|
{
|
||||||
action.setExecutionInstance(nextExecutionId++);
|
if (logger.isDebugEnabled() == true)
|
||||||
key = generateCacheKey(action);
|
{
|
||||||
|
logger.debug("Action " + action + " has completed execution");
|
||||||
// Is it ok?
|
}
|
||||||
if(executingActionsCache.get(key) == null) {
|
|
||||||
assigned = true;
|
// Mark it as having worked
|
||||||
}
|
action.setExecutionEndDate(new Date());
|
||||||
|
action.setExecutionStatus(ActionStatus.Completed);
|
||||||
// Do we need to wrap?
|
action.setExecutionFailureMessage(null);
|
||||||
// (Wrap before absolutely needed, makes things simpler)
|
if (action.getNodeRef() != null)
|
||||||
if(nextExecutionId > wrapExecutionIdAfter) {
|
{
|
||||||
synchronized (this) {
|
runtimeActionService.saveActionImpl(action.getNodeRef(), action);
|
||||||
while(nextExecutionId > wrapExecutionIdAfter) {
|
}
|
||||||
nextExecutionId -= wrapExecutionIdAfter;
|
|
||||||
}
|
// Remove it from the cache, as it's finished
|
||||||
|
String key = generateCacheKey(action);
|
||||||
|
executingActionsCache.remove(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void recordActionExecuting(Action action)
|
||||||
|
{
|
||||||
|
recordActionExecuting((ActionImpl) action);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void recordActionExecuting(ActionImpl action)
|
||||||
|
{
|
||||||
|
if (logger.isDebugEnabled() == true)
|
||||||
|
{
|
||||||
|
logger.debug("Action " + action + " with provisional key " + generateCacheKey(action)
|
||||||
|
+ " has begun exection");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Grab what status it was before
|
||||||
|
ActionStatus previousStatus = action.getExecutionStatus();
|
||||||
|
|
||||||
|
// Mark the action as starting
|
||||||
|
action.setExecutionStartDate(new Date());
|
||||||
|
action.setExecutionStatus(ActionStatus.Running);
|
||||||
|
|
||||||
|
// If it's a synchronous execution, put it into the cache
|
||||||
|
if (previousStatus != ActionStatus.Pending)
|
||||||
|
{
|
||||||
|
placeActionInCache(action);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
// If it's async, update the existing cache entry
|
||||||
|
String key = generateCacheKey(action);
|
||||||
|
ExecutionDetails details = executingActionsCache.get(key);
|
||||||
|
|
||||||
|
// Check it's really there, warn + fix if not
|
||||||
|
if (details == null)
|
||||||
|
{
|
||||||
|
logger.warn("Went to mark the start of execution of " + action + " with key " + key
|
||||||
|
+ " but it wasn't in the running actions cache! "
|
||||||
|
+ "Your running actions cache is probably too small");
|
||||||
}
|
}
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Put it into the cache
|
|
||||||
ExecutionDetails details = buildExecutionDetails(action);
|
|
||||||
executingActionsCache.put(key, details);
|
|
||||||
|
|
||||||
if (logger.isDebugEnabled() == true)
|
|
||||||
{
|
|
||||||
logger.debug("Action " + action + " with key " + key + " placed into execution cache");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
// Update and save into the cache
|
||||||
* Schedule the recording of the action failure to occur
|
details = buildExecutionDetails(action);
|
||||||
* in another transaction
|
executingActionsCache.put(key, details);
|
||||||
*/
|
}
|
||||||
public void recordActionFailure(Action action, Throwable exception)
|
}
|
||||||
{
|
|
||||||
if (logger.isDebugEnabled() == true)
|
|
||||||
{
|
|
||||||
if(exception instanceof ActionCancelledException)
|
|
||||||
{
|
|
||||||
logger.debug("Will shortly record completed cancellation of action " + action);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
logger.debug("Will shortly record failure of action " + action + " due to " + exception.getMessage());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Record when it finished
|
|
||||||
((ActionImpl)action).setExecutionEndDate(new Date());
|
|
||||||
|
|
||||||
// Record it as Failed or Cancelled, depending on the exception
|
|
||||||
if(exception instanceof ActionCancelledException)
|
|
||||||
{
|
|
||||||
((ActionImpl)action).setExecutionStatus(ActionStatus.Cancelled);
|
|
||||||
((ActionImpl)action).setExecutionFailureMessage(null);
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
((ActionImpl)action).setExecutionStatus(ActionStatus.Failed);
|
|
||||||
((ActionImpl)action).setExecutionFailureMessage(exception.getMessage());
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove it from the cache, as it's no longer running
|
|
||||||
String key = generateCacheKey(action);
|
|
||||||
executingActionsCache.remove(key);
|
|
||||||
|
|
||||||
// Do we need to update the persisted details?
|
/**
|
||||||
if(action.getNodeRef() != null)
|
* For an action that needs to go into the cache (async action that is
|
||||||
{
|
* pending, or sync action that is running), assign an execution instance
|
||||||
// Take a local copy of the details
|
* and put into the cache
|
||||||
// (That way, if someone has a reference to the
|
*/
|
||||||
// action and plays with it, we still save the
|
private void placeActionInCache(ActionImpl action)
|
||||||
// correct information)
|
{
|
||||||
final String actionId = action.getId();
|
// Assign it a (unique) execution ID
|
||||||
final Date startedAt = action.getExecutionStartDate();
|
// (Keep checking to see if the key is used as we
|
||||||
final Date endedAt = action.getExecutionEndDate();
|
// increase nextExecutionId until it isn't)
|
||||||
final String message = action.getExecutionFailureMessage();
|
String key = null;
|
||||||
final NodeRef actionNode = action.getNodeRef();
|
boolean assigned = false;
|
||||||
|
while (!assigned)
|
||||||
// Have the details updated on the action as soon
|
{
|
||||||
// as the transaction has finished rolling back
|
// Try
|
||||||
AlfrescoTransactionSupport.bindListener(
|
action.setExecutionInstance(nextExecutionId++);
|
||||||
new TransactionListenerAdapter() {
|
key = generateCacheKey(action);
|
||||||
public void afterRollback()
|
|
||||||
{
|
// Is it ok?
|
||||||
transactionService.getRetryingTransactionHelper().doInTransaction(
|
if (executingActionsCache.get(key) == null)
|
||||||
new RetryingTransactionCallback<Object>()
|
{
|
||||||
{
|
assigned = true;
|
||||||
public Object execute() throws Throwable
|
|
||||||
{
|
|
||||||
// Update the action as the system user
|
|
||||||
return AuthenticationUtil.runAs(new RunAsWork<Action>() {
|
|
||||||
public Action doWork() throws Exception
|
|
||||||
{
|
|
||||||
// Grab the latest version of the action
|
|
||||||
ActionImpl action = (ActionImpl)
|
|
||||||
runtimeActionService.createAction(actionNode);
|
|
||||||
|
|
||||||
// Update it
|
|
||||||
action.setExecutionStartDate(startedAt);
|
|
||||||
action.setExecutionEndDate(endedAt);
|
|
||||||
action.setExecutionStatus(ActionStatus.Failed);
|
|
||||||
action.setExecutionFailureMessage(message);
|
|
||||||
runtimeActionService.saveActionImpl(actionNode, action);
|
|
||||||
|
|
||||||
if (logger.isDebugEnabled() == true)
|
|
||||||
{
|
|
||||||
logger.debug("Recorded failure of action " + actionId + ", node " + actionNode + " due to " + message);
|
|
||||||
}
|
|
||||||
|
|
||||||
// All done
|
|
||||||
return action;
|
|
||||||
}
|
|
||||||
}, AuthenticationUtil.SYSTEM_USER_NAME);
|
|
||||||
}
|
|
||||||
}, false, true
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public boolean isCancellationRequested(CancellableAction action)
|
// Do we need to wrap?
|
||||||
{
|
// (Wrap before absolutely needed, makes things simpler)
|
||||||
// If the action isn't in the cache, but is of
|
if (nextExecutionId > wrapExecutionIdAfter)
|
||||||
// status executing, then put it back into the
|
{
|
||||||
// cache and warn
|
synchronized (this)
|
||||||
// (Probably means the cache is too small)
|
{
|
||||||
String key = generateCacheKey(action);
|
while (nextExecutionId > wrapExecutionIdAfter)
|
||||||
ExecutionDetails details = getExecutionDetails(buildExecutionSummary(key));
|
{
|
||||||
if(details == null) {
|
nextExecutionId -= wrapExecutionIdAfter;
|
||||||
Exception e = new Exception("Cancellation status missing from cache");
|
}
|
||||||
e.fillInStackTrace();
|
}
|
||||||
|
}
|
||||||
logger.warn(
|
}
|
||||||
"Unable to check cancellation status for running action " +
|
|
||||||
action + " with execution key " + key +
|
|
||||||
" as it wasn't in the running actions cache! " +
|
|
||||||
"Your running actions cache is probably too small",
|
|
||||||
e
|
|
||||||
);
|
|
||||||
|
|
||||||
// Re-generate
|
|
||||||
details = buildExecutionDetails(action);
|
|
||||||
|
|
||||||
// Re-save into the cache, so it's there for
|
|
||||||
// next time
|
|
||||||
executingActionsCache.put(key, details);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check the cached details, and see if cancellation
|
|
||||||
// has been requested
|
|
||||||
return details.isCancelRequested();
|
|
||||||
}
|
|
||||||
|
|
||||||
public void requestActionCancellation(CancellableAction action)
|
// Put it into the cache
|
||||||
{
|
ExecutionDetails details = buildExecutionDetails(action);
|
||||||
requestActionCancellation(
|
executingActionsCache.put(key, details);
|
||||||
generateCacheKey(action)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
public void requestActionCancellation(ExecutionSummary executionSummary)
|
|
||||||
{
|
|
||||||
requestActionCancellation(
|
|
||||||
generateCacheKey(executionSummary)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private void requestActionCancellation(String actionKey)
|
|
||||||
{
|
|
||||||
// See if the action is in the cache
|
|
||||||
ExecutionDetails details = executingActionsCache.get(actionKey);
|
|
||||||
|
|
||||||
if(details == null) {
|
|
||||||
// It isn't in the cache, so nothing to do
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Since it is, update the cancelled flag on it
|
|
||||||
details.requestCancel();
|
|
||||||
|
|
||||||
// Save the flag to the cache
|
|
||||||
executingActionsCache.put(actionKey, details);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
if (logger.isDebugEnabled() == true)
|
||||||
public List<ExecutionSummary> getAllExecutingActions() {
|
{
|
||||||
Collection<String> actions = executingActionsCache.getKeys();
|
logger.debug("Action " + action + " with key " + key + " placed into execution cache");
|
||||||
List<ExecutionSummary> details = new ArrayList<ExecutionSummary>(actions.size());
|
}
|
||||||
for(String key : actions) {
|
}
|
||||||
details.add( buildExecutionSummary(key) );
|
|
||||||
}
|
|
||||||
return details;
|
|
||||||
}
|
|
||||||
|
|
||||||
public List<ExecutionSummary> getExecutingActions(Action action) {
|
/**
|
||||||
Collection<String> actions = executingActionsCache.getKeys();
|
* Schedule the recording of the action failure to occur in another
|
||||||
List<ExecutionSummary> details = new ArrayList<ExecutionSummary>();
|
* transaction
|
||||||
String match = action.getActionDefinitionName() + cacheKeyPartSeparator +
|
*/
|
||||||
action.getId() + cacheKeyPartSeparator;
|
public void recordActionFailure(Action action, Throwable exception)
|
||||||
for(String key : actions) {
|
{
|
||||||
if(key.startsWith(match)) {
|
if (logger.isDebugEnabled() == true)
|
||||||
details.add( buildExecutionSummary(key) );
|
{
|
||||||
}
|
if (exception instanceof ActionCancelledException)
|
||||||
}
|
{
|
||||||
return details;
|
logger.debug("Will shortly record completed cancellation of action " + action);
|
||||||
}
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
logger.debug("Will shortly record failure of action " + action + " due to "
|
||||||
|
+ exception.getMessage());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public List<ExecutionSummary> getExecutingActions(String type) {
|
// Record when it finished
|
||||||
Collection<String> actions = executingActionsCache.getKeys();
|
((ActionImpl) action).setExecutionEndDate(new Date());
|
||||||
List<ExecutionSummary> details = new ArrayList<ExecutionSummary>();
|
|
||||||
String match = type + cacheKeyPartSeparator;
|
|
||||||
for(String key : actions) {
|
|
||||||
if(key.startsWith(match)) {
|
|
||||||
details.add( buildExecutionSummary(key) );
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return details;
|
|
||||||
}
|
|
||||||
|
|
||||||
public ExecutionDetails getExecutionDetails(ExecutionSummary executionSummary) {
|
// Record it as Failed or Cancelled, depending on the exception
|
||||||
ExecutionDetails details = executingActionsCache.get(
|
if (exception instanceof ActionCancelledException)
|
||||||
generateCacheKey(executionSummary)
|
{
|
||||||
);
|
((ActionImpl) action).setExecutionStatus(ActionStatus.Cancelled);
|
||||||
if(details != null) {
|
((ActionImpl) action).setExecutionFailureMessage(null);
|
||||||
details.setExecutionSummary(executionSummary);
|
}
|
||||||
}
|
else
|
||||||
return details;
|
{
|
||||||
}
|
((ActionImpl) action).setExecutionStatus(ActionStatus.Failed);
|
||||||
|
((ActionImpl) action).setExecutionFailureMessage(exception.getMessage());
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
// Remove it from the cache, as it's no longer running
|
||||||
* Generates the cache key for the specified action.
|
String key = generateCacheKey(action);
|
||||||
*/
|
executingActionsCache.remove(key);
|
||||||
protected static String generateCacheKey(Action action)
|
|
||||||
{
|
|
||||||
return
|
|
||||||
action.getActionDefinitionName() + cacheKeyPartSeparator +
|
|
||||||
action.getId() + cacheKeyPartSeparator +
|
|
||||||
((ActionImpl)action).getExecutionInstance()
|
|
||||||
;
|
|
||||||
}
|
|
||||||
protected static String generateCacheKey(ExecutionSummary summary)
|
|
||||||
{
|
|
||||||
return
|
|
||||||
summary.getActionType() + cacheKeyPartSeparator +
|
|
||||||
summary.getActionId() + cacheKeyPartSeparator +
|
|
||||||
summary.getExecutionInstance()
|
|
||||||
;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Builds up the details to be stored in a cache
|
|
||||||
* for a specific action
|
|
||||||
*/
|
|
||||||
protected static ExecutionDetails buildExecutionDetails(Action action)
|
|
||||||
{
|
|
||||||
// Where are we running?
|
|
||||||
if(machineName == null) {
|
|
||||||
try {
|
|
||||||
InetAddress localhost = InetAddress.getLocalHost();
|
|
||||||
machineName = localhost.getHostAddress() + " : " +
|
|
||||||
localhost.getHostName();
|
|
||||||
} catch(UnknownHostException e) {
|
|
||||||
machineName = "(machine details unavailable - server IP not known)";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Generate
|
|
||||||
return new ExecutionDetails(
|
|
||||||
buildExecutionSummary(action),
|
|
||||||
action.getNodeRef(), machineName,
|
|
||||||
action.getExecutionStartDate(), false
|
|
||||||
);
|
|
||||||
}
|
|
||||||
private static String machineName = null;
|
|
||||||
|
|
||||||
/**
|
// Do we need to update the persisted details?
|
||||||
* Turns a cache key back into its constituent
|
if (action.getNodeRef() != null)
|
||||||
* parts, for easier access.
|
{
|
||||||
*/
|
// Take a local copy of the details
|
||||||
protected static ExecutionSummary buildExecutionSummary(String key)
|
// (That way, if someone has a reference to the
|
||||||
{
|
// action and plays with it, we still save the
|
||||||
StringTokenizer st = new StringTokenizer(key, new String(new char[]{cacheKeyPartSeparator}));
|
// correct information)
|
||||||
String actionType = st.nextToken();
|
final String actionId = action.getId();
|
||||||
String actionId = st.nextToken();
|
final Date startedAt = action.getExecutionStartDate();
|
||||||
int executionInstance = Integer.parseInt(st.nextToken());
|
final Date endedAt = action.getExecutionEndDate();
|
||||||
|
final String message = action.getExecutionFailureMessage();
|
||||||
return new ExecutionSummary(actionType, actionId, executionInstance);
|
final NodeRef actionNode = action.getNodeRef();
|
||||||
}
|
|
||||||
protected static ExecutionSummary buildExecutionSummary(Action action)
|
// Have the details updated on the action as soon
|
||||||
{
|
// as the transaction has finished rolling back
|
||||||
return new ExecutionSummary(
|
AlfrescoTransactionSupport.bindListener(new TransactionListenerAdapter()
|
||||||
action.getActionDefinitionName(),
|
{
|
||||||
action.getId(),
|
public void afterRollback()
|
||||||
((ActionImpl)action).getExecutionInstance()
|
{
|
||||||
);
|
transactionService.getRetryingTransactionHelper().doInTransaction(
|
||||||
}
|
new RetryingTransactionCallback<Object>()
|
||||||
|
{
|
||||||
|
public Object execute() throws Throwable
|
||||||
|
{
|
||||||
|
// Update the action as the system user
|
||||||
|
return AuthenticationUtil.runAs(new RunAsWork<Action>()
|
||||||
|
{
|
||||||
|
public Action doWork() throws Exception
|
||||||
|
{
|
||||||
|
// Grab the latest version of the
|
||||||
|
// action
|
||||||
|
ActionImpl action = (ActionImpl) runtimeActionService
|
||||||
|
.createAction(actionNode);
|
||||||
|
|
||||||
|
// Update it
|
||||||
|
action.setExecutionStartDate(startedAt);
|
||||||
|
action.setExecutionEndDate(endedAt);
|
||||||
|
action.setExecutionStatus(ActionStatus.Failed);
|
||||||
|
action.setExecutionFailureMessage(message);
|
||||||
|
runtimeActionService.saveActionImpl(actionNode, action);
|
||||||
|
|
||||||
|
if (logger.isDebugEnabled() == true)
|
||||||
|
{
|
||||||
|
logger.debug("Recorded failure of action "
|
||||||
|
+ actionId + ", node " + actionNode
|
||||||
|
+ " due to " + message);
|
||||||
|
}
|
||||||
|
|
||||||
|
// All done
|
||||||
|
return action;
|
||||||
|
}
|
||||||
|
}, AuthenticationUtil.SYSTEM_USER_NAME);
|
||||||
|
}
|
||||||
|
}, false, true);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public boolean isCancellationRequested(CancellableAction action)
|
||||||
|
{
|
||||||
|
// If the action isn't in the cache, but is of
|
||||||
|
// status executing, then put it back into the
|
||||||
|
// cache and warn
|
||||||
|
// (Probably means the cache is too small)
|
||||||
|
String key = generateCacheKey(action);
|
||||||
|
ExecutionDetails details = getExecutionDetails(buildExecutionSummary(key));
|
||||||
|
if (details == null)
|
||||||
|
{
|
||||||
|
Exception e = new Exception("Cancellation status missing from cache");
|
||||||
|
e.fillInStackTrace();
|
||||||
|
|
||||||
|
logger.warn("Unable to check cancellation status for running action " + action
|
||||||
|
+ " with execution key " + key + " as it wasn't in the running actions cache! "
|
||||||
|
+ "Your running actions cache is probably too small", e);
|
||||||
|
|
||||||
|
// Re-generate
|
||||||
|
details = buildExecutionDetails(action);
|
||||||
|
|
||||||
|
// Re-save into the cache, so it's there for
|
||||||
|
// next time
|
||||||
|
executingActionsCache.put(key, details);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check the cached details, and see if cancellation
|
||||||
|
// has been requested
|
||||||
|
return details.isCancelRequested();
|
||||||
|
}
|
||||||
|
|
||||||
|
public void requestActionCancellation(CancellableAction action)
|
||||||
|
{
|
||||||
|
requestActionCancellation(generateCacheKey(action));
|
||||||
|
}
|
||||||
|
|
||||||
|
public void requestActionCancellation(ExecutionSummary executionSummary)
|
||||||
|
{
|
||||||
|
requestActionCancellation(generateCacheKey(executionSummary));
|
||||||
|
}
|
||||||
|
|
||||||
|
private void requestActionCancellation(String actionKey)
|
||||||
|
{
|
||||||
|
// See if the action is in the cache
|
||||||
|
ExecutionDetails details = executingActionsCache.get(actionKey);
|
||||||
|
|
||||||
|
if (details == null)
|
||||||
|
{
|
||||||
|
// It isn't in the cache, so nothing to do
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Since it is, update the cancelled flag on it
|
||||||
|
details.requestCancel();
|
||||||
|
|
||||||
|
// Save the flag to the cache
|
||||||
|
executingActionsCache.put(actionKey, details);
|
||||||
|
}
|
||||||
|
|
||||||
|
public List<ExecutionSummary> getAllExecutingActions()
|
||||||
|
{
|
||||||
|
Collection<String> actions = executingActionsCache.getKeys();
|
||||||
|
List<ExecutionSummary> details = new ArrayList<ExecutionSummary>(actions.size());
|
||||||
|
for (String key : actions)
|
||||||
|
{
|
||||||
|
details.add(buildExecutionSummary(key));
|
||||||
|
}
|
||||||
|
return details;
|
||||||
|
}
|
||||||
|
|
||||||
|
public List<ExecutionSummary> getExecutingActions(Action action)
|
||||||
|
{
|
||||||
|
Collection<String> actions = executingActionsCache.getKeys();
|
||||||
|
List<ExecutionSummary> details = new ArrayList<ExecutionSummary>();
|
||||||
|
String match = action.getActionDefinitionName() + cacheKeyPartSeparator + action.getId()
|
||||||
|
+ cacheKeyPartSeparator;
|
||||||
|
for (String key : actions)
|
||||||
|
{
|
||||||
|
if (key.startsWith(match))
|
||||||
|
{
|
||||||
|
details.add(buildExecutionSummary(key));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return details;
|
||||||
|
}
|
||||||
|
|
||||||
|
public List<ExecutionSummary> getExecutingActions(String type)
|
||||||
|
{
|
||||||
|
Collection<String> actions = executingActionsCache.getKeys();
|
||||||
|
List<ExecutionSummary> details = new ArrayList<ExecutionSummary>();
|
||||||
|
String match = type + cacheKeyPartSeparator;
|
||||||
|
for (String key : actions)
|
||||||
|
{
|
||||||
|
if (key.startsWith(match))
|
||||||
|
{
|
||||||
|
details.add(buildExecutionSummary(key));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return details;
|
||||||
|
}
|
||||||
|
|
||||||
|
public ExecutionDetails getExecutionDetails(ExecutionSummary executionSummary)
|
||||||
|
{
|
||||||
|
ExecutionDetails details = executingActionsCache.get(generateCacheKey(executionSummary));
|
||||||
|
if (details != null)
|
||||||
|
{
|
||||||
|
details.setExecutionSummary(executionSummary);
|
||||||
|
}
|
||||||
|
return details;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generates the cache key for the specified action.
|
||||||
|
*/
|
||||||
|
protected static String generateCacheKey(Action action)
|
||||||
|
{
|
||||||
|
return action.getActionDefinitionName() + cacheKeyPartSeparator + action.getId()
|
||||||
|
+ cacheKeyPartSeparator + ((ActionImpl) action).getExecutionInstance();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected static String generateCacheKey(ExecutionSummary summary)
|
||||||
|
{
|
||||||
|
return summary.getActionType() + cacheKeyPartSeparator + summary.getActionId()
|
||||||
|
+ cacheKeyPartSeparator + summary.getExecutionInstance();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds up the details to be stored in a cache for a specific action
|
||||||
|
*/
|
||||||
|
protected static ExecutionDetails buildExecutionDetails(Action action)
|
||||||
|
{
|
||||||
|
// Where are we running?
|
||||||
|
if (machineName == null)
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
InetAddress localhost = InetAddress.getLocalHost();
|
||||||
|
machineName = localhost.getHostAddress() + " : " + localhost.getHostName();
|
||||||
|
}
|
||||||
|
catch (UnknownHostException e)
|
||||||
|
{
|
||||||
|
machineName = "(machine details unavailable - server IP not known)";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Generate
|
||||||
|
return new ExecutionDetails(buildExecutionSummary(action), action.getNodeRef(),
|
||||||
|
machineName, action.getExecutionStartDate(), false);
|
||||||
|
}
|
||||||
|
|
||||||
|
private static String machineName = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Turns a cache key back into its constituent parts, for easier access.
|
||||||
|
*/
|
||||||
|
protected static ExecutionSummary buildExecutionSummary(String key)
|
||||||
|
{
|
||||||
|
StringTokenizer st = new StringTokenizer(key, new String(
|
||||||
|
new char[] { cacheKeyPartSeparator }));
|
||||||
|
String actionType = st.nextToken();
|
||||||
|
String actionId = st.nextToken();
|
||||||
|
int executionInstance = Integer.parseInt(st.nextToken());
|
||||||
|
|
||||||
|
return new ExecutionSummary(actionType, actionId, executionInstance);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected static ExecutionSummary buildExecutionSummary(Action action)
|
||||||
|
{
|
||||||
|
return new ExecutionSummary(action.getActionDefinitionName(), action.getId(),
|
||||||
|
((ActionImpl) action).getExecutionInstance());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user