/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2006-2009 Sun Microsystems, Inc.
|
* Portions Copyright 2013-2014 ForgeRock AS.
|
*/
|
package org.opends.server.backends.task;
|
|
import java.util.Map;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
import org.opends.server.api.DirectoryThread;
|
import org.forgerock.i18n.slf4j.LocalizedLogger;
|
|
import static org.opends.messages.BackendMessages.*;
|
import static org.opends.server.util.StaticUtils.*;
|
|
/**
|
* This class defines a thread that will be used to execute a scheduled task
|
* within the server and provide appropriate notification that the task is
|
* complete.
|
*/
|
public class TaskThread extends DirectoryThread
|
{
|
private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
|
|
|
|
/** Indicates whether a request has been made for this thread to exit. */
|
private volatile boolean exitRequested;
|
|
/** The thread ID for this task thread. */
|
private int threadID;
|
|
/** The reference to the scheduler with which this thread is associated. */
|
private TaskScheduler taskScheduler;
|
|
/**
|
* The object that will be used for signaling the thread when there is new
|
* work to perform.
|
*/
|
private final Object notifyLock;
|
|
|
|
/**
|
* Creates a new task thread with the provided information.
|
*
|
* @param taskScheduler The reference to the task scheduler with which this
|
* thread is associated.
|
* @param threadID The ID assigned to this task thread.
|
*/
|
public TaskThread(TaskScheduler taskScheduler, int threadID)
|
{
|
super("Task Thread " + threadID);
|
|
|
this.taskScheduler = taskScheduler;
|
this.threadID = threadID;
|
|
notifyLock = new Object();
|
exitRequested = false;
|
|
setAssociatedTask(null);
|
}
|
|
|
|
/**
|
* Retrieves the task currently being processed by this thread, if it is
|
* active.
|
*
|
* @return The task currently being processed by this thread, or
|
* <CODE>null</CODE> if it is not processing any task.
|
*/
|
public Task getTask()
|
{
|
return getAssociatedTask();
|
}
|
|
|
|
/**
|
* Provides a new task for processing by this thread. This does not do any
|
* check to ensure that no task is already in process.
|
*
|
* @param task The task to be processed.
|
*/
|
public void setTask(Task task)
|
{
|
setAssociatedTask(task);
|
|
synchronized (notifyLock)
|
{
|
notifyLock.notify();
|
}
|
}
|
|
|
|
/**
|
* Attempts to interrupt processing on the task in progress.
|
*
|
* @param interruptState The state to use for the task if it is
|
* successfully interrupted.
|
* @param interruptReason The human-readable reason that the task is to be
|
* interrupted.
|
* @param exitThread Indicates whether this thread should exit when
|
* processing on the active task has completed.
|
*/
|
public void interruptTask(TaskState interruptState, LocalizableMessage interruptReason,
|
boolean exitThread)
|
{
|
if (getAssociatedTask() != null)
|
{
|
try
|
{
|
getAssociatedTask().interruptTask(interruptState, interruptReason);
|
}
|
catch (Exception e)
|
{
|
logger.traceException(e);
|
}
|
}
|
|
if (exitThread)
|
{
|
exitRequested = true;
|
}
|
}
|
|
|
|
/**
|
* Operates in a loop, sleeping until there is no work to do, then
|
* processing the task and returning to the scheduler for more work.
|
*/
|
@Override
|
public void run()
|
{
|
while (! exitRequested)
|
{
|
if (getAssociatedTask() == null)
|
{
|
try
|
{
|
synchronized (notifyLock)
|
{
|
notifyLock.wait(5000);
|
}
|
}
|
catch (InterruptedException ie)
|
{
|
logger.traceException(ie);
|
}
|
|
continue;
|
}
|
|
TaskState taskState = getAssociatedTask().getTaskState();
|
try
|
{
|
if (!TaskState.isDone(taskState))
|
{
|
Task task = getAssociatedTask();
|
|
logger.info(NOTE_TASK_STARTED, task.getDisplayName(), task.getTaskID());
|
|
taskState = task.execute();
|
|
logger.info(NOTE_TASK_FINISHED, task.getDisplayName(),
|
task.getTaskID(), taskState.getDisplayName());
|
}
|
}
|
catch (Exception e)
|
{
|
logger.traceException(e);
|
|
Task task = getAssociatedTask();
|
logger.error(ERR_TASK_EXECUTE_FAILED, task.getTaskEntry().getName(), stackTraceToSingleLineString(e));
|
task.setTaskState(TaskState.STOPPED_BY_ERROR);
|
}
|
|
Task completedTask = getAssociatedTask();
|
setAssociatedTask(null);
|
if (! taskScheduler.threadDone(this, completedTask, taskState))
|
{
|
exitRequested = true;
|
break;
|
}
|
}
|
|
if (getAssociatedTask() != null)
|
{
|
Task task = getAssociatedTask();
|
TaskState taskState = TaskState.STOPPED_BY_SHUTDOWN;
|
taskScheduler.threadDone(this, task, taskState);
|
}
|
}
|
|
|
|
/**
|
* Retrieves any relevant debug information with which this tread is
|
* associated so they can be included in debug messages.
|
*
|
* @return debug information about this thread as a string.
|
*/
|
@Override
|
public Map<String, String> getDebugProperties()
|
{
|
Map<String, String> properties = super.getDebugProperties();
|
|
if (getAssociatedTask() != null)
|
{
|
properties.put("task", getAssociatedTask().toString());
|
}
|
|
return properties;
|
}
|
}
|
