com.aspc.commander.process

Class ProcessHandler

java.lang.Object

com.aspc.commander.process.ProcessHandler

public class ProcessHandler
extends java.lang.Object

Parse SQL like statements to implement interms 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

Constructor Summary

Constructors

Constructor and Description
ProcessHandler(java.lang.Thread processThread, ServerProcess process, Login owner, ProcessHandler previous, boolean restoreThreadNameAtEnd, long timeoutMS) constructor of the process information holder.

Method Summary

Modifier and Type	Method and Description
java.lang.String	abort() abort the process.
java.lang.String	cancel() cancel the process
void	end() end the process.
void	forked(boolean flag) fork the process.
long	getHitsDB() the hit count
long	getLargeHitsDB() the hit count
Login	getLogin() get the owner login of this process.
java.util.Date	getPauseTime() get the paused time for the process.
ProcessHandler	getPreviousHandler() The previous handler for this thread.
ServerProcess	getProcess() The actual process
long	getProcessId() the process id
java.lang.Thread	getProcessThread() get the thread running this process.
java.lang.String	getProgressMsg() get the progress message
long	getRemaningTimeMS() The time until we timeout
long	getStartMS() get Started time of this process
long	getTimeOnDB() The time on the database
long	getTimeoutMS() get the timeoutMS
boolean	hasTimedOut() is the process timed out
boolean	isPaused() Is the process paused ?
boolean	isTerminated() is the process terminated
java.lang.String	pause() pause the process.
java.lang.String	resume() resume the process.
void	start() abort the process.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessHandler

public ProcessHandler(java.lang.Thread processThread,
                      ServerProcess process,
                      @Nullable
                      Login owner,
                      ProcessHandler previous,
                      boolean restoreThreadNameAtEnd,
                      long timeoutMS)

constructor of the process information holder.

Parameters:

restoreThreadNameAtEnd - should we restore the thread name when the process ends.

processThread - The process thread

previous - the previous process

process - the process

owner - the owner

timeoutMS - the timeout

Method Detail

getTimeoutMS

public long getTimeoutMS()

get the timeoutMS

Returns:

timeoutMS

getHitsDB

@CheckReturnValue
public long getHitsDB()

the hit count

Returns:

the count

getLargeHitsDB

@CheckReturnValue
public long getLargeHitsDB()

the hit count

Returns:

the count

getTimeOnDB

@CheckReturnValue
public long getTimeOnDB()

The time on the database

Returns:

the time in milliseconds

getLogin

@CheckReturnValue
 @Nullable
public Login getLogin()

get the owner login of this process.

Returns:

the login

forked

public void forked(boolean flag)

fork the process.

Parameters:

flag - is forked ?

getProgressMsg

@CheckReturnValue
 @Nonnull
public java.lang.String getProgressMsg()

get the progress message

Returns:

the string message

getProcessThread

@CheckReturnValue
 @Nonnull
public java.lang.Thread getProcessThread()

get the thread running this process.

Returns:

the thread

getPreviousHandler

@CheckReturnValue
 @Nullable
public ProcessHandler getPreviousHandler()

The previous handler for this thread.

Returns:

The previous handler

isTerminated

@CheckReturnValue
public boolean isTerminated()

is the process terminated

Returns:

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

hasTimedOut

@CheckReturnValue
public boolean hasTimedOut()

is the process timed out

Returns:

true if timed out

getRemaningTimeMS

@CheckReturnValue
public long getRemaningTimeMS()

The time until we timeout

Returns:

the milliseconds until we timeout.

getProcess

@CheckReturnValue
public ServerProcess getProcess()

The actual process

Returns:

the process

getProcessId

@CheckReturnValue
public long getProcessId()

the process id

Returns:

the process id

cancel

@Nonnull
public java.lang.String cancel()
                                 throws java.lang.Exception

cancel the process

Returns:

the status message

Throws:

java.lang.Exception - a serious problem

abort

@Nonnull
public java.lang.String abort()
                                throws java.lang.Exception

abort the process.

Returns:

the status message

Throws:

java.lang.Exception - A serious problem

start

public void start()
           throws java.lang.Exception

abort the process.

Throws:

java.lang.Exception - A serious problem

getStartMS

@CheckReturnValue
public long getStartMS()

get Started time of this process

Returns:

get the time the process was started.

isPaused

@CheckReturnValue
public boolean isPaused()

Is the process paused ?

Returns:

TRUE if paused.

getPauseTime

@CheckReturnValue
 @Nullable
public java.util.Date getPauseTime()

get the paused time for the process.

Returns:

get the time the process was paused.

pause

@Nonnull
public java.lang.String pause()

pause the process.

Returns:

the status message

end

public void end()

end the process.

resume

@Nonnull
public java.lang.String resume()

resume the process.

Returns:

the status message