fr.gouv.vitam.common.server.application

Class AbstractVitamApplication<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

java.lang.Object

fr.gouv.vitam.common.server.application.AbstractVitamApplication<A,C>

Type Parameters:

A - VitamApplication final class

C - VitamApplicationConfiguration final class

All Implemented Interfaces:

VitamApplication<A,C>, VitamApplicationInterface<A,C>

public abstract class AbstractVitamApplication<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>
extends Object
implements VitamApplication<A,C>

Abstract implementation of VitamApplication which handle common tasks for all sub-implementation

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONFIG_FILE_IS_A_MANDATORY_ARGUMENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractVitamApplication(Class<C> configurationType, C configuration) Protected constructor assigning application and configuration types Usage example in sub-implementation : for Junit test class MyApplication extends AbstractVitamApplication { protected MyApplication(C config) { super(MyApplication.class, MyApplicationConfiguration.class, config); } }
protected	AbstractVitamApplication(Class<C> configurationType, String configurationFile) Protected constructor assigning application and configuration types Usage example in sub-implementation : class MyApplication extends AbstractVitamApplication { protected MyApplication(String configFile) { super(MyApplication.class, MyApplicationConfiguration.class, configFile); } }

Method Summary

Modifier and Type	Method and Description
protected org.eclipse.jetty.server.Handler	buildAdminHandler() This is (admin config) an other implementation of the method @see buildApplicationHandler The default implementation is for business api
protected org.eclipse.jetty.server.Handler	buildApplicationHandler() Re Implement this method to construct your application specific handler if necessary.
protected void	checkJerseyMetrics(org.glassfish.jersey.server.ResourceConfig resourceConfig)
protected static void	clearAndconfigureMetrics() Clear the metrics map from any existing VitamMetrics and reload the configuration from the AbstractVitamApplication#METRICS_CONF_FILE_NAME
protected void	configure(String configurationFile) From the configuration file, read the configuration, the Jetty Configuration and create the associate VitamServer using Jetty, adding the applicationHandler from buildApplicationHandler
protected void	configureVitamParameters() To allow override on non Vitam platform such as IHM
org.eclipse.jetty.server.Handler	getApplicationHandlers()
static VitamMetricRegistry	getBusinessMetricsRegistry() Return the VitamMetricRegistry of VitamMetricsType.BUSINESS type.
String	getConfigFilename() Return the name as a string of your configuration file.
C	getConfiguration()
Class<C>	getConfigurationType()
boolean	getServerStatus()
protected int	getSession()
static VitamMetrics	getVitamMetrics(VitamMetricsType type) Return a VitamMetrics object for a given VitamMetricsType or null if the VitamMetrics does not exists.
VitamServer	getVitamServer() retrieve the vitam server
protected abstract boolean	registerInAdminConfig(org.glassfish.jersey.server.ResourceConfig resourceConfig) This method must add the Application Admin resources and eventually registering specific Admin component
protected abstract void	registerInResourceConfig(org.glassfish.jersey.server.ResourceConfig resourceConfig) This method must add the Application resources and eventually registering specific component
protected void	registerLifeCycleListener() register LifeCycle Listener for jetty
void	run() Start the server as full daemon and blocking
void	setConfiguration(C configuration) Allow to override this method in Junit
protected void	setFilter(org.eclipse.jetty.servlet.ServletContextHandler context, boolean isAdminConnector) To set extra filters
void	start() Start the server without blocking
void	startMetrics() Start the reporting of every metrics
void	stop() Stop the server

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_FILE_IS_A_MANDATORY_ARGUMENT

protected static final String CONFIG_FILE_IS_A_MANDATORY_ARGUMENT

See Also:

Constant Field Values

Constructor Detail

AbstractVitamApplication

protected AbstractVitamApplication(Class<C> configurationType,
                                   String configurationFile)

Protected constructor assigning application and configuration types
Usage example in sub-implementation :

class MyApplication extends AbstractVitamApplication {
protected MyApplication(String configFile) {
super(MyApplication.class, MyApplicationConfiguration.class, configFile);
}
}

Parameters:

configurationType - the configuration class type

configurationFile - the configuration file

Throws:

IllegalStateException

AbstractVitamApplication

protected AbstractVitamApplication(Class<C> configurationType,
                                   C configuration)

Protected constructor assigning application and configuration types

Usage example in sub-implementation : for Junit test
class MyApplication extends AbstractVitamApplication {
protected MyApplication(C config) {
super(MyApplication.class, MyApplicationConfiguration.class, config);
}
}

Parameters:

configurationType - the configuration class type

configuration - the configuration object

Throws:

IllegalStateException

Method Detail

getServerStatus

public boolean getServerStatus()

configure

protected final void configure(String configurationFile)

From the configuration file, read the configuration, the Jetty Configuration and create the associate VitamServer using Jetty, adding the applicationHandler from buildApplicationHandler

Parameters:

configurationFile -

Throws:

IllegalStateException

configureVitamParameters

protected void configureVitamParameters()

To allow override on non Vitam platform such as IHM

startMetrics

public final void startMetrics()

Start the reporting of every metrics

clearAndconfigureMetrics

protected static final void clearAndconfigureMetrics()

Clear the metrics map from any existing VitamMetrics and reload the configuration from the AbstractVitamApplication#METRICS_CONF_FILE_NAME

checkJerseyMetrics

protected void checkJerseyMetrics(org.glassfish.jersey.server.ResourceConfig resourceConfig)

registerInResourceConfig

protected abstract void registerInResourceConfig(org.glassfish.jersey.server.ResourceConfig resourceConfig)

This method must add the Application resources and eventually registering specific component

Parameters:

resourceConfig - the ResourceConfig to setup

registerInAdminConfig

protected abstract boolean registerInAdminConfig(org.glassfish.jersey.server.ResourceConfig resourceConfig)

This method must add the Application Admin resources and eventually registering specific Admin component

Parameters:

resourceConfig - the ResourceConfig to setup

Returns:

return true if resource registered else return false this help to add or not the admin connector

getSession

protected int getSession()

Returns:

0 for NO_SESSION, 1 for SESSION

setFilter

protected void setFilter(org.eclipse.jetty.servlet.ServletContextHandler context,
                         boolean isAdminConnector)
                  throws VitamApplicationServerException

To set extra filters

Parameters:

context - the context on which to call context.addFilter (as many times as needed)

isAdminConnector - use to be able to add or not some specific filter or listener to the context

Throws:

VitamApplicationServerException

buildApplicationHandler

protected org.eclipse.jetty.server.Handler buildApplicationHandler()
                                                            throws VitamApplicationServerException

Re Implement this method to construct your application specific handler if necessary.

If extra register are needed, override the method getResources.
If extra filter or action on context are needed, override setFilter.

Returns:

the generated Handler

Throws:

VitamApplicationServerException

buildAdminHandler

protected org.eclipse.jetty.server.Handler buildAdminHandler()
                                                      throws VitamApplicationServerException

This is (admin config) an other implementation of the method @see buildApplicationHandler The default implementation is for business api

Returns:

the generated Handler

Throws:

VitamApplicationServerException

getConfigFilename

public String getConfigFilename()

Description copied from interface: VitamApplication

Return the name as a string of your configuration file. Example : "logbook.conf"
Could be overridden if necessary

Specified by:

getConfigFilename in interface VitamApplication<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

Returns:

the name of the application configuration file

getConfiguration

public final C getConfiguration()

Specified by:

getConfiguration in interface VitamApplication<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

Returns:

the configuration

setConfiguration

public void setConfiguration(C configuration)

Description copied from interface: VitamApplication

Allow to override this method in Junit

Specified by:

setConfiguration in interface VitamApplication<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

getConfigurationType

public final Class<C> getConfigurationType()

Specified by:

getConfigurationType in interface VitamApplication<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

Returns:

the Configuration Class

getApplicationHandlers

public final org.eclipse.jetty.server.Handler getApplicationHandlers()

Specified by:

getApplicationHandlers in interface VitamApplication<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

Returns:

the application Handler

getVitamServer

public final VitamServer getVitamServer()

Description copied from interface: VitamApplicationInterface

retrieve the vitam server

Specified by:

getVitamServer in interface VitamApplicationInterface<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

Returns:

vitam server

run

public final void run()
               throws VitamApplicationServerException

Description copied from interface: VitamApplication

Start the server as full daemon and blocking

Specified by:

run in interface VitamApplication<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

Throws:

VitamApplicationServerException

start

public final void start()
                 throws VitamApplicationServerException

Description copied from interface: VitamApplicationInterface

Start the server without blocking

Specified by:

start in interface VitamApplicationInterface<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

Throws:

VitamApplicationServerException

stop

public final void stop()
                throws VitamApplicationServerException

Description copied from interface: VitamApplicationInterface

Stop the server

Specified by:

stop in interface VitamApplicationInterface<A extends VitamApplication<A,C>,C extends VitamApplicationConfiguration>

Throws:

VitamApplicationServerException

getBusinessMetricsRegistry

public static final VitamMetricRegistry getBusinessMetricsRegistry()

Return the VitamMetricRegistry of VitamMetricsType.BUSINESS type. This VitamMetricRegistry can be used to register custom metrics wherever in the application.

Returns:

VitamMetrics BUSINESS VitamMetrics

getVitamMetrics

public static final VitamMetrics getVitamMetrics(VitamMetricsType type)

Return a VitamMetrics object for a given VitamMetricsType or null if the VitamMetrics does not exists.

Parameters:

type - VitamMetricsType type

Returns:

VitamMetrics VitamMetrics

registerLifeCycleListener

protected void registerLifeCycleListener()

register LifeCycle Listener for jetty