com.webhydra.slug
Class SlugHelper

java.lang.Object
  com.webhydra.slug.SlugHelper

public class SlugHelper
extends java.lang.Object

Provide conviniet access to the running SluggisProcessess.

Author:

rossen

Constructor Summary

SlugHelper()

Method Summary

static SluggishProcess	cancelProcess(javax.servlet.http.HttpServletRequest request, java.lang.String pid) Cancel SluggishProcess from default runner.
static SluggishProcess	cancelProcess(javax.servlet.http.HttpSession session, java.lang.String pid) Cancel SluggishProcess from default runner.
static SluggishProcess	cancelProcess(java.lang.String runnerName, javax.servlet.http.HttpServletRequest request, java.lang.String pid) Cancel SluggishProcess This method is simple wrapper arround consumeProcess(String, String, String).
static SluggishProcess	cancelProcess(java.lang.String runnerName, javax.servlet.http.HttpSession session, java.lang.String pid) CancelSluggishProcess This method is simple wrapper arround consumeProcess(String, String, String).
static SluggishProcess	cancelProcess(java.lang.String sessionId, java.lang.String pid) Cancel SluggishProcess from default runner.
static SluggishProcess	cancelProcess(java.lang.String runnerName, java.lang.String sessionId, java.lang.String pid) Cancel SluggishProcess
static SluggishProcess	consumeProcess(javax.servlet.http.HttpServletRequest request, java.lang.String pid) Consume SluggishProcess from default runner.
static SluggishProcess	consumeProcess(javax.servlet.http.HttpSession session, java.lang.String pid) Consume SluggishProcess from default runner.
static SluggishProcess	consumeProcess(java.lang.String runnerName, javax.servlet.http.HttpServletRequest request, java.lang.String pid) Consume SluggishProcess This method is simple wrapper arround consumeProcess(String, String, String).
static SluggishProcess	consumeProcess(java.lang.String runnerName, javax.servlet.http.HttpSession session, java.lang.String pid) Consume SluggishProcess This method is simple wrapper arround consumeProcess(String, String, String).
static SluggishProcess	consumeProcess(java.lang.String sessionId, java.lang.String pid) Consume SluggishProcess from default runner.
static SluggishProcess	consumeProcess(java.lang.String runnerName, java.lang.String sessionId, java.lang.String pid) Consume SluggishProcess
static ProcessStatus	getStatus(javax.servlet.http.HttpServletRequest request, java.lang.String pid) Retrieve ProcessStatus of a SluggishProcess from default runner.
static ProcessStatus	getStatus(javax.servlet.http.HttpSession session, java.lang.String pid) Retrieve ProcessStatus of a SluggishProcess from default runner.
static ProcessStatus	getStatus(java.lang.String runnerName, javax.servlet.http.HttpServletRequest request, java.lang.String pid) Retrieve ProcessStatus of a SluggishProcess from default runner.
static ProcessStatus	getStatus(java.lang.String runnerName, javax.servlet.http.HttpSession session, java.lang.String pid) Retrieve ProcessStatus of a SluggishProcess from default runner.
static ProcessStatus	getStatus(java.lang.String sessionId, java.lang.String pid) Retrieve ProcessStatus of a SluggishProcess from default runner.
static ProcessStatus	getStatus(java.lang.String runnerName, java.lang.String sessionId, java.lang.String pid) Retrieve ProcessStatus of a SluggishProcess from default runner.
static java.lang.String	runProcess(javax.servlet.http.HttpServletRequest request, SluggishProcess proc) Add provided SluggishProcess to the specified default ISlugRunner.
static java.lang.String	runProcess(javax.servlet.http.HttpSession session, SluggishProcess proc) Add provided SluggishProcess to the specified default ISlugRunner.
static java.lang.String	runProcess(java.lang.String runnerName, javax.servlet.http.HttpServletRequest request, SluggishProcess proc) Add provided SluggishProcess to the specified ISlugRunner.
static java.lang.String	runProcess(java.lang.String runnerName, javax.servlet.http.HttpSession session, SluggishProcess proc) Add provided SluggishProcess to the specified ISlugRunner.
static java.lang.String	runProcess(java.lang.String sessionId, SluggishProcess proc) Add provided SluggishProcess to the specified default ISlugRunner.
static java.lang.String	runProcess(java.lang.String runnerName, java.lang.String sessionId, SluggishProcess proc) Add provided SluggishProcess to the specified ISlugRunner.

Methods inherited from class java.lang.Object

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

Constructor Detail

SlugHelper

public SlugHelper()

Method Detail

consumeProcess

public static SluggishProcess consumeProcess(javax.servlet.http.HttpServletRequest request,
                                             java.lang.String pid)
                                      throws SlugInitializationException

Consume SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

request - current HTTP request.

pid - PID of the proccess.

Returns:

consumed SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

consumeProcess(String, String, String)

consumeProcess

public static SluggishProcess consumeProcess(javax.servlet.http.HttpSession session,
                                             java.lang.String pid)
                                      throws SlugInitializationException

Consume SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

session - current HTTP session.

pid - PID of the proccess.

Returns:

consumed SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

consumeProcess(String, String, String)

consumeProcess

public static SluggishProcess consumeProcess(java.lang.String sessionId,
                                             java.lang.String pid)
                                      throws SlugInitializationException

Consume SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

sessionId - session Id.

pid - PID of the proccess.

Returns:

consumed SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

consumeProcess(String, String, String)

consumeProcess

public static SluggishProcess consumeProcess(java.lang.String runnerName,
                                             javax.servlet.http.HttpServletRequest request,
                                             java.lang.String pid)

Consume SluggishProcess This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

runnerName - name of the ISlugRunner.

request - current HTTP request.

pid - PID of the proccess.

Returns:

consumed SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

See Also:

consumeProcess(String, String, String)

consumeProcess

public static SluggishProcess consumeProcess(java.lang.String runnerName,
                                             javax.servlet.http.HttpSession session,
                                             java.lang.String pid)

Consume SluggishProcess This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

runnerName - name of the ISlugRunner.

session - current HTTP session.

pid - PID of the proccess.

Returns:

consumed SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

See Also:

consumeProcess(String, String, String)

consumeProcess

public static SluggishProcess consumeProcess(java.lang.String runnerName,
                                             java.lang.String sessionId,
                                             java.lang.String pid)

Consume SluggishProcess

Parameters:

runnerName - name of the ISlugRunner.

sessionId - session ID.

pid - PID of the proccess.

Returns:

consumed SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session.

getStatus

public static ProcessStatus getStatus(javax.servlet.http.HttpServletRequest request,
                                      java.lang.String pid)
                               throws SlugInitializationException

Retrieve ProcessStatus of a SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

request - current HTTP request.

pid - PID of the proccess.

Returns:

ProcessStatus for spefigied process or null if provided runner can not be foud or there is not a process with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

getStatus(String, String, String)

getStatus

public static ProcessStatus getStatus(javax.servlet.http.HttpSession session,
                                      java.lang.String pid)
                               throws SlugInitializationException

Retrieve ProcessStatus of a SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

session - current HTTP session.

pid - PID of the proccess.

Returns:

ProcessStatus for spefigied process or null if provided runner can not be foud or there is not a process with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

getStatus(String, String, String)

getStatus

public static ProcessStatus getStatus(java.lang.String sessionId,
                                      java.lang.String pid)
                               throws SlugInitializationException

Retrieve ProcessStatus of a SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

sessionId - session ID.

pid - PID of the proccess.

Returns:

ProcessStatus for spefigied process or null if provided runner can not be foud or there is not a process with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

getStatus(String, String, String)

getStatus

public static ProcessStatus getStatus(java.lang.String runnerName,
                                      javax.servlet.http.HttpServletRequest request,
                                      java.lang.String pid)

Retrieve ProcessStatus of a SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

runnerName - name of the ISlugRunner.

request - current HTTP request.

pid - PID of the proccess.

Returns:

ProcessStatus for spefigied process or null if provided runner can not be foud or there is not a process with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

getStatus(String, String, String)

getStatus

public static ProcessStatus getStatus(java.lang.String runnerName,
                                      javax.servlet.http.HttpSession session,
                                      java.lang.String pid)

Retrieve ProcessStatus of a SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

runnerName - name of the ISlugRunner.

session - current HTTP session.

pid - PID of the proccess.

Returns:

ProcessStatus for spefigied process or null if provided runner can not be foud or there is not a process with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

getStatus(String, String, String)

getStatus

public static ProcessStatus getStatus(java.lang.String runnerName,
                                      java.lang.String sessionId,
                                      java.lang.String pid)

Retrieve ProcessStatus of a SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

runnerName - name of the ISlugRunner.

sessionId - session ID.

pid - PID of the proccess.

Returns:

ProcessStatus for spefigied process or null if provided runner can not be foud or there is not a process with provided PID for specified session.

See Also:

ISlugRunner.checkProcess(String, String)

cancelProcess

public static SluggishProcess cancelProcess(javax.servlet.http.HttpServletRequest request,
                                            java.lang.String pid)
                                     throws SlugInitializationException

Cancel SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

request - current HTTP request.

pid - PID of the proccess.

Returns:

canceled SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

cancelProcess(String, String, String)

cancelProcess

public static SluggishProcess cancelProcess(javax.servlet.http.HttpSession session,
                                            java.lang.String pid)
                                     throws SlugInitializationException

Cancel SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

session - current HTTP session.

pid - PID of the proccess.

Returns:

canceled SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

cancelProcess(String, String, String)

cancelProcess

public static SluggishProcess cancelProcess(java.lang.String sessionId,
                                            java.lang.String pid)
                                     throws SlugInitializationException

Cancel SluggishProcess from default runner. This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

sessionId - session ID.

pid - PID of the proccess.

Returns:

canceled SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

Throws:

SlugInitializationException - if Slug is not properly initialized.

See Also:

cancelProcess(String, String, String)

cancelProcess

public static SluggishProcess cancelProcess(java.lang.String runnerName,
                                            javax.servlet.http.HttpServletRequest request,
                                            java.lang.String pid)

Cancel SluggishProcess This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

runnerName - name of the ISlugRunner.

request - current HTTP request.

pid - PID of the proccess.

Returns:

canceled SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

See Also:

cancelProcess(String, String, String)

cancelProcess

public static SluggishProcess cancelProcess(java.lang.String runnerName,
                                            javax.servlet.http.HttpSession session,
                                            java.lang.String pid)

CancelSluggishProcess This method is simple wrapper arround consumeProcess(String, String, String).

Parameters:

runnerName - name of the ISlugRunner.

session - current HTTP session.

pid - PID of the proccess.

Returns:

canceled SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session. with provided PID for specified session.

See Also:

cancelProcess(String, String, String)

cancelProcess

public static SluggishProcess cancelProcess(java.lang.String runnerName,
                                            java.lang.String sessionId,
                                            java.lang.String pid)

Cancel SluggishProcess

Parameters:

runnerName - name of the ISlugRunner.

sessionId - session ID.

pid - PID of the proccess.

Returns:

canceled SluggishProcess or null if provided runner can not be foud or there is not a process with provided PID for specified session.

See Also:

ISlugRunner.cancelProcess(String, String)

runProcess

public static java.lang.String runProcess(javax.servlet.http.HttpServletRequest request,
                                          SluggishProcess proc)
                                   throws SlugInitializationException

Add provided SluggishProcess to the specified default ISlugRunner. Adds provided SluggishProcess to the default ISlugRunner and schedule it for running. This function is wrapper arround runProcess(String, String, SluggishProcess)

Parameters:

request - current HTTP request.

proc - SluggishProcess to run.

Returns:

Process' PID or null if it can not be started.

Throws:

SlugInitializationException

See Also:

runProcess(String, String, SluggishProcess)

runProcess

public static java.lang.String runProcess(javax.servlet.http.HttpSession session,
                                          SluggishProcess proc)
                                   throws SlugInitializationException

Add provided SluggishProcess to the specified default ISlugRunner. Adds provided SluggishProcess to the default ISlugRunner and schedule it for running. This function is wrapper arround runProcess(String, String, SluggishProcess)

Parameters:

session - current HTTP session.

proc - SluggishProcess to run.

Returns:

Process' PID or null if it can not be started.

Throws:

SlugInitializationException

See Also:

runProcess(String, String, SluggishProcess)

runProcess

public static java.lang.String runProcess(java.lang.String sessionId,
                                          SluggishProcess proc)
                                   throws SlugInitializationException

Add provided SluggishProcess to the specified default ISlugRunner. Adds provided SluggishProcess to the default ISlugRunner and schedule it for running. This function is wrapper arround runProcess(String, String, SluggishProcess)

Parameters:

sessionId - session ID.

proc - SluggishProcess to run.

Returns:

Process' PID or null if it can not be started.

Throws:

SlugInitializationException

See Also:

runProcess(String, String, SluggishProcess)

runProcess

public static java.lang.String runProcess(java.lang.String runnerName,
                                          javax.servlet.http.HttpServletRequest request,
                                          SluggishProcess proc)

Add provided SluggishProcess to the specified ISlugRunner. Adds provided SluggishProcess to the specified ISlugRunner and schedule it for running. This function is wrapper arround runProcess(String, String, SluggishProcess)

Parameters:

runnerName - name of the ISlugRunner.

request - current HTTP request.

proc - SluggishProcess to run.

Returns:

Process' PID or null if it can not be started.

See Also:

runProcess(String, String, SluggishProcess)

runProcess

public static java.lang.String runProcess(java.lang.String runnerName,
                                          javax.servlet.http.HttpSession session,
                                          SluggishProcess proc)

Add provided SluggishProcess to the specified ISlugRunner. Adds provided SluggishProcess to the specified ISlugRunner and schedule it for running. This function is wrapper arround runProcess(String, String, SluggishProcess)

Parameters:

runnerName - name of the ISlugRunner.

session - current HTTP session.

proc - SluggishProcess to run.

Returns:

Process' PID or null if it can not be started.

See Also:

runProcess(String, String, SluggishProcess)

runProcess

public static java.lang.String runProcess(java.lang.String runnerName,
                                          java.lang.String sessionId,
                                          SluggishProcess proc)

Add provided SluggishProcess to the specified ISlugRunner. Adds provided SluggishProcess to the specified ISlugRunner and schedule it for running.

Parameters:

runnerName - name of the ISlugRunner.

sessionId - session ID.

proc - SluggishProcess to run.

Returns:

Process' PID or null if it can not be started.

See Also:

ISlugRunner.add(SluggishProcess, String)