org.abstracthorizon.extend.server.deployment
Interface Module

All Known Implementing Classes:

AbstractApplicationContextModule, AbstractModule, Bootstrap.BootstrapModule, DanubeWebApplicationContext, DeploymentDirectoryModule, DirectoryModule, JarModule, JettyWebApplicationContext, ProvisionalModule, ServiceApplicationContextModule, TomcatWebApplicationContext, UnknownLoaderModule

public interface Module

This interface describes a module that can be loaded and deployed.

Author:

Daniel Sendula

Field Summary

static int	CREATED Created module
static int	DEFINED Module that is defined (loaded)
static int	STARTED Deployed module
static int	UNDEFINED Undefined module
static int	WAITING_ON_CREATE Module that waits of dependencies to be created
static int	WAITING_ON_CREATE_TO_START Module that waits of dependencies to be created
static int	WAITING_ON_START Waiting on modules this module depends to start

Method Summary

void	create() Creates the module.
void	destroy() Destroys the module.
ClassLoader	getClassLoader() Returns modules class loader.
Set<Module>	getDependOnThis() Returns a set of modules that depend on this module.
Set<Module>	getDependsOn() Returns a set of modules this module depends on.
ModuleId	getModuleId() Return's module's name.
URL	getOriginalLocation() Returns module's original location.
int	getState() Returns module's state
URL	getWorkingLocation() Returns module's working location
void	setState(int state) Sets the moduile's state.
void	start() Starts the module.
void	stop() Stops the module.

Field Detail

UNDEFINED

static final int UNDEFINED

Undefined module

See Also:

Constant Field Values

DEFINED

static final int DEFINED

Module that is defined (loaded)

See Also:

Constant Field Values

WAITING_ON_CREATE

static final int WAITING_ON_CREATE

Module that waits of dependencies to be created

See Also:

Constant Field Values

WAITING_ON_CREATE_TO_START

static final int WAITING_ON_CREATE_TO_START

Module that waits of dependencies to be created

See Also:

Constant Field Values

CREATED

static final int CREATED

Created module

See Also:

Constant Field Values

WAITING_ON_START

static final int WAITING_ON_START

Waiting on modules this module depends to start

See Also:

Constant Field Values

STARTED

static final int STARTED

Deployed module

See Also:

Constant Field Values

Method Detail

getOriginalLocation

URL getOriginalLocation()

Returns module's original location.

Returns:

module's original location

getWorkingLocation

URL getWorkingLocation()

Returns module's working location

Returns:

module's working location

getClassLoader

ClassLoader getClassLoader()

Returns modules class loader.

Returns:

modules class loader or null

getDependOnThis

Set<Module> getDependOnThis()

Returns a set of modules that depend on this module.

Returns:

a set of modules that depend on this module

getDependsOn

Set<Module> getDependsOn()

Returns a set of modules this module depends on.

Returns:

a set of modules this module depends on

setState

void setState(int state)

Sets the moduile's state.

Note: Not to be called directly!

Parameters:

state - module's state

getState

int getState()

Returns module's state

Returns:

module's state

getModuleId

ModuleId getModuleId()

Return's module's name. This must not be null.

Returns:

module's name

create

void create()

Creates the module.

Note: Not to be called directly. Use DeploymentManager.create(Module) method instead.

start

void start()

Starts the module.

Note: Not to be called directly. Use DeploymentManager.start(Module) method instead.

stop

void stop()

Stops the module.

Note: Not to be called directly. Use DeploymentManager.stop(Module) method instead.

destroy

void destroy()

Destroys the module.

Note: Not to be called directly. Use DeploymentManager.destroy(Module) method instead.