com.aspc.commander.process

Class ProcessManager

java.lang.Object

com.aspc.commander.process.ProcessManager

public final class ProcessManager
extends java.lang.Object

Parse SQL like statements to implement in terms of DBObjects THREAD MODE: SINGLE THREADED a connection may only be accessed by one thread at a time.

Since:

3 December 2003

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DISABLE_THREAD_INTERRUPT Allow the thread.interrupt() as part of the cancel of the thread to be disabled as not correctly handling the exception caused in the running SQL can cause a problem.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	abortProcess(long processID) abort a process MODE: multi thread.
static java.lang.String	abortProcess(ProcessHandler handler) abort a process MODE: multi thread.
static java.lang.String	abortProcess(ServerProcess process) abort a process MODE: multi thread.
static java.lang.String	cancelProcess(long processID) cancel a process MODE: multi thread.
static java.lang.String	cancelProcess(ProcessHandler handler) cancel a process MODE: multi thread.
static java.lang.String	cancelProcess(ServerProcess process) cancel a process MODE: multi thread.
static void	check() check that we are not terminated or paused.
static void	check(ServerProcess process) check that we are not terminated or paused.
static void	endProcess() end a process on the current thread MODE: Single thread.
static java.lang.String	getCurrentLoginID() Get the owner login of a current process.
static ProcessHandler	getHandler(long processId) Is this connection terminated ? TODO: This should be notified so that we don't sleep for 59 seconds after the connection has been resumed.
static ProcessHandler[]	getHandler(ServerProcess process) returns the currently running process by a unique process id
static ProcessHandler	getHandler(java.lang.Thread thread) returns the currently running process by a unique process id
static long	getHitsDB(ServerProcess process) The database hits
static long	getLargeHitsDB(ServerProcess process) The database large hits
static java.lang.String	getLoginID(ServerProcess process) Get the owner login of a process.
static int	getPID() Get the process ID
static long	getProcessID(ServerProcess process) get the process id
static java.lang.String	getProgressMsg(ServerProcess process) get the progress message
static long	getStartMS(ServerProcess process) get the process start time in ms
static <T> java.util.List<java.util.concurrent.Future<T>>	invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)
static boolean	isProcessTerminated(ServerProcess process) Is this process terminated ?
static boolean	isProcessTimedOut(ServerProcess process) Is this process timed out?
static void	leaveThreadNameOnEnd(boolean flag) do not restore the name of the thread when the process for this thread ends.
static ServerProcess[]	listProcesses() returns a list of currently running connections
static void	parkAndWait(ServerProcess process) park and wait if the process is paused.
static java.lang.String	pauseProcess(long processID) pause this connection.
static <T> T	result(java.util.concurrent.Future<T> task) get the result
static java.lang.String	resumeProcess(long processID) resume this connection
static void	startProcess(ServerProcess process, Login owner) start a process on the current thread MODE: Single thread.
static void	startProcess(ServerProcess process, Login owner, long timeout) start a process on the current thread with timeout time MODE: Single thread.
static <T> java.util.concurrent.ForkJoinTask<T>	submit(java.util.concurrent.Callable<T> call)

Methods inherited from class java.lang.Object

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

Field Detail

DISABLE_THREAD_INTERRUPT

public static final java.lang.String DISABLE_THREAD_INTERRUPT

Allow the thread.interrupt() as part of the cancel of the thread to be disabled as not correctly handling the exception caused in the running SQL can cause a problem.

See Also:

Constant Field Values

Method Detail

getPID

public static int getPID()

Get the process ID

Returns:

the PID

invokeAll

@CheckReturnValue
 @Nonnull
public static <T> java.util.List<java.util.concurrent.Future<T>> invokeAll(java.util.Collection<? extends java.util.concurrent.Callable<T>> tasks)

Type Parameters:

T - the expected type

Parameters:

tasks - the tasks to run

Returns:

the results

Throws:

java.lang.NullPointerException

java.util.concurrent.RejectedExecutionException

submit

@CheckReturnValue
 @Nonnull
public static <T> java.util.concurrent.ForkJoinTask<T> submit(java.util.concurrent.Callable<T> call)

Type Parameters:

T - the type

Parameters:

call - the call

Returns:

the result

Throws:

java.lang.NullPointerException - if the task is null

java.util.concurrent.RejectedExecutionException - if the task cannot be scheduled for execution

result

@CheckReturnValue
 @Nonnull
public static <T> T result(java.util.concurrent.Future<T> task)
                                                throws java.lang.Exception

get the result

Type Parameters:

T - the type expected.

Parameters:

task - the task

Returns:

the value

Throws:

java.lang.Exception - A problem

pauseProcess

@CheckReturnValue
 @Nonnull
public static java.lang.String pauseProcess(long processID)

pause this connection.

Parameters:

processID - the process ID

Returns:

the status message

resumeProcess

@CheckReturnValue
 @Nonnull
public static java.lang.String resumeProcess(long processID)

resume this connection

Parameters:

processID - the process ID

Returns:

the status message

check

public static void check()

check that we are not terminated or paused.

check

public static void check(@Nullable
                         ServerProcess process)

check that we are not terminated or paused.

Parameters:

process - the process

parkAndWait

public static void parkAndWait(@Nonnull
                               ServerProcess process)

park and wait if the process is paused.

Parameters:

process - the process to check.

isProcessTerminated

@CheckReturnValue
public static boolean isProcessTerminated(@Nonnull
                                                            ServerProcess process)

Is this process terminated ?

Parameters:

process - the process to check if terminated.

Returns:

TRUE if terminated THREAD MODE: do not synchronize as it'll cause deadlocks.

isProcessTimedOut

@CheckReturnValue
public static boolean isProcessTimedOut(@Nonnull
                                                          ServerProcess process)

Is this process timed out?

Parameters:

process - the process to check if timed out

Returns:

TRUE if timed out

getProcessID

@CheckReturnValue
public static long getProcessID(@Nonnull
                                                  ServerProcess process)

get the process id

Parameters:

process - the process to get the process id for

Returns:

the process id

getHandler

@CheckReturnValue
 @Nullable
public static ProcessHandler getHandler(long processId)

Is this connection terminated ? TODO: This should be notified so that we don't sleep for 59 seconds after the connection has been resumed.

Parameters:

processId - The process id

Returns:

TRUE if terminated

getHandler

@CheckReturnValue
 @Nullable
public static ProcessHandler[] getHandler(@Nonnull
                                                                       ServerProcess process)

returns the currently running process by a unique process id

Parameters:

process - the process to get the handler of

Returns:

The currently running connection

getHandler

@CheckReturnValue
 @Nullable
public static ProcessHandler getHandler(@Nonnull
                                                                     java.lang.Thread thread)

returns the currently running process by a unique process id

Parameters:

thread - The thread to get the current handler for.

Returns:

The currently running connection

getProgressMsg

@CheckReturnValue
 @Nonnull
public static java.lang.String getProgressMsg(@Nonnull
                                                                          ServerProcess process)

get the progress message

Parameters:

process - the process to get the process message of

Returns:

the string message

getStartMS

@CheckReturnValue
public static long getStartMS(@Nonnull
                                                ServerProcess process)

get the process start time in ms

Parameters:

process - the process to get the start ms of

Returns:

start ms

getHitsDB

@CheckReturnValue
public static long getHitsDB(@Nonnull
                                               ServerProcess process)

The database hits

Parameters:

process - the process

Returns:

the database hits

getLargeHitsDB

@CheckReturnValue
public static long getLargeHitsDB(@Nonnull
                                                    ServerProcess process)

The database large hits

Parameters:

process - the process

Returns:

the database hits

getLoginID

@CheckReturnValue
 @Nonnull
public static java.lang.String getLoginID(ServerProcess process)

Get the owner login of a process.

Parameters:

process - the process to get the owner login of

Returns:

the owner login

leaveThreadNameOnEnd

public static void leaveThreadNameOnEnd(boolean flag)

do not restore the name of the thread when the process for this thread ends.

Parameters:

flag - TRUE to leave the name as is.

listProcesses

@CheckReturnValue
 @Nonnull
public static ServerProcess[] listProcesses()

returns a list of currently running connections

Returns:

The list of processes

getCurrentLoginID

@CheckReturnValue
 @Nullable
public static java.lang.String getCurrentLoginID()

Get the owner login of a current process.

Returns:

the owner login

startProcess

public static void startProcess(ServerProcess process,
                                Login owner)
                         throws java.lang.Exception

start a process on the current thread MODE: Single thread.

Parameters:

process - the process to start

owner - the owner login.

Throws:

java.lang.Exception - A serious problem

startProcess

public static void startProcess(ServerProcess process,
                                Login owner,
                                long timeout)
                         throws java.lang.Exception

start a process on the current thread with timeout time MODE: Single thread.

Parameters:

process - the process to start

owner - the owner login.

timeout - timeout of this process in MS

Throws:

java.lang.Exception - A serious problem

endProcess

public static void endProcess()

end a process on the current thread MODE: Single thread.

cancelProcess

@Nonnull
public static java.lang.String cancelProcess(@Nonnull
                                                      ServerProcess process)
                                               throws java.lang.Exception

cancel a process MODE: multi thread.

Parameters:

process - the process to cancel

Returns:

the status message

Throws:

java.lang.Exception - A serious problem

cancelProcess

@Nonnull
public static java.lang.String cancelProcess(long processID)
                                               throws java.lang.Exception

cancel a process MODE: multi thread.

Parameters:

processID - the process to cancel

Returns:

the status message

Throws:

java.lang.Exception - A serious problem

cancelProcess

@Nonnull
public static java.lang.String cancelProcess(@Nullable
                                                      ProcessHandler handler)
                                               throws java.lang.Exception

cancel a process MODE: multi thread.

Parameters:

handler - the process to cancel

Returns:

the status message

Throws:

java.lang.Exception - A serious problem

abortProcess

@Nonnull
public static java.lang.String abortProcess(@Nonnull
                                                     ServerProcess process)
                                              throws java.lang.Exception

abort a process MODE: multi thread.

Parameters:

process - the process to abort

Returns:

the status message

Throws:

java.lang.Exception - A serious problem

abortProcess

@Nonnull
public static java.lang.String abortProcess(long processID)
                                              throws java.lang.Exception

abort a process MODE: multi thread.

Parameters:

processID - the process to abort

Returns:

the status message

Throws:

java.lang.Exception - A serious problem

abortProcess

@Nonnull
public static java.lang.String abortProcess(@Nullable
                                                     ProcessHandler handler)
                                              throws java.lang.Exception

abort a process MODE: multi thread.

Parameters:

handler - the process to abort

Returns:

the status message

Throws:

java.lang.Exception - A serious problem