org.ldp4j.application.ext

Class Application<T extends Configuration>

java.lang.Object

org.ldp4j.application.ext.Application<T>

public abstract class Application<T extends Configuration>
extends Object

The entry point for an LDP4j Application. This class provides the means for controlling the life-cycle of the application: the bootstrapping of the application and the application termination.

Constructor Summary

Constructors

Constructor and Description
Application()

Method Summary

Methods

Modifier and Type	Method and Description
Class<T>	getConfigurationClass() Returns the Class of the configuration class type parameter.
String	getName() Return the name of the application.
abstract void	initialize(WriteSession session) Initialize the application.
abstract void	setup(Environment environment, Bootstrap<T> bootstrap) Setup the application.
abstract void	shutdown() Shutdown the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

Application

public Application()

Method Detail

getConfigurationClass

public final Class<T> getConfigurationClass()

Returns the Class of the configuration class type parameter.

Returns:

the configuration class

See Also:

Generics.getTypeParameter(Class, Class)

getName

public String getName()

Return the name of the application.

Returns:

the application's name

setup

public abstract void setup(Environment environment,
         Bootstrap<T> bootstrap)
                    throws ApplicationSetupException

Setup the application.
The implementation class will have to register the resource handler instances and classes in the Bootstrap instance, and publish the root resources for the application in the Environment instance.

Parameters:

environment - the environment for publishing root resources.

bootstrap - the bootstrap for registering resource handler instances and classes.

Throws:

ApplicationSetupException - if any failure prevented setting up the application.

initialize

public abstract void initialize(WriteSession session)
                         throws ApplicationInitializationException

Initialize the application.
The implementation class may synchronize its internal state with the state of the resources already managed by the LDP4j framework.

Parameters:

session - the session to use for controlling the lifecycle of the resources managed by the framework.

Throws:

ApplicationInitializationException - if any failure prevented the initialization of the application.

shutdown

public abstract void shutdown()
                       throws ApplicationShutdownException

Shutdown the application.
The implementation class should carry out any termination activity required before shutting down the application.

Throws:

ApplicationShutdownException - if any failure prevented the graceful termination of the application.