Skip navigation links

waggle.client.main
Class XClientMain

java.lang.Object
waggle.client.main.XClientMain

public final class XClientMain

extends Object

Client main program.

Field Summary

static String	CLIENT_INSTANCE_NAME Used to specify an alternate client instance name during client startup.
static String	CLIENT_LOG_INSTANCE_NAME Used to specify an alternate client log instance name during client startup.

Method Summary

static void	initApp(File basePath) For client app running in the file system with the OnTrack classes in the classes folder.
static void	initApp(File basePath, Properties localProperties) For client app running in the file system with the OnTrack classes in the classes folder.
static void	initAppWithJar() For client app running in the file system with the OnTrack classes in a jar on the classpath.
static void	initAppWithJar(Properties localProperties) For client app running in the file system with the OnTrack classes in a jar on the classpath.
static void	initWebApp(javax.servlet.ServletContext servletContext) For client app in a WebApp with the OnTrack classes exploded in the classes folder.
static void	initWebApp(javax.servlet.ServletContext servletContext, Properties localProperties) For client app in a WebApp with the OnTrack classes exploded in the classes folder.
static void	initWebAppWithJar(javax.servlet.ServletContext servletContext, String jarName) For client app in a WebApp with the OnTrack classes in a jar in the lib folder.
static void	initWebAppWithJar(javax.servlet.ServletContext servletContext, String jarName, Properties localProperties) For client app in a WebApp with the OnTrack classes in a jar in the lib folder.
static void	shutdown() Shutdown a Client.

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_INSTANCE_NAME

public static final String CLIENT_INSTANCE_NAME

Used to specify an alternate client instance name during client startup. If not specified "ontrack-client" is used.

See Also:

Constant Field Values

CLIENT_LOG_INSTANCE_NAME

public static final String CLIENT_LOG_INSTANCE_NAME

Used to specify an alternate client log instance name during client startup. If not specified the instance name is used.

See Also:

Constant Field Values

Method Detail

initApp

public static void initApp(File basePath)
                    throws Exception

For client app running in the file system with the OnTrack classes in the classes folder.

Parameters:

basePath - The base path.

Throws:

Exception - Generic exception.

initApp

public static void initApp(File basePath,
                           Properties localProperties)
                    throws Exception

For client app running in the file system with the OnTrack classes in the classes folder.

Parameters:

basePath - The base path.

localProperties - Any local properties. May be null.

Throws:

Exception - Generic exception.

initAppWithJar

public static void initAppWithJar()
                           throws Exception

For client app running in the file system with the OnTrack classes in a jar on the classpath.

Throws:

Exception - Generic exception.

initAppWithJar

public static void initAppWithJar(Properties localProperties)
                           throws Exception

For client app running in the file system with the OnTrack classes in a jar on the classpath.

Parameters:

localProperties - Any local properties. May be null.

Throws:

Exception - Generic exception.

initWebApp

public static void initWebApp(javax.servlet.ServletContext servletContext)
                       throws Exception

For client app in a WebApp with the OnTrack classes exploded in the classes folder.

Parameters:

servletContext - The servlet context.

Throws:

Exception - generic exceptions.

initWebApp

public static void initWebApp(javax.servlet.ServletContext servletContext,
                              Properties localProperties)
                       throws Exception

For client app in a WebApp with the OnTrack classes exploded in the classes folder.

Parameters:

servletContext - The servlet context.

localProperties - Any local properties. May be null.

Throws:

Exception - generic exceptions.

initWebAppWithJar

public static void initWebAppWithJar(javax.servlet.ServletContext servletContext,
                                     String jarName)
                              throws Exception

For client app in a WebApp with the OnTrack classes in a jar in the lib folder.

Parameters:

servletContext - The servlet context.

jarName - The name of the jar file. For example "ontrack.jar". May be null. If null the "ontrack.jar" will be used.

Throws:

Exception - generic exceptions.

initWebAppWithJar

public static void initWebAppWithJar(javax.servlet.ServletContext servletContext,
                                     String jarName,
                                     Properties localProperties)
                              throws Exception

For client app in a WebApp with the OnTrack classes in a jar in the lib folder.

Parameters:

servletContext - The servlet context.

jarName - The name of the jar file. For example "ontrack.jar". May be null. If null the "ontrack.jar" will be used.

localProperties - Any local properties. May be null.

Throws:

Exception - generic exceptions.

shutdown

public static void shutdown()

Shutdown a Client.

Skip navigation links