fr.gouv.vitam.common.serverv2

Class VitamStarter

java.lang.Object

fr.gouv.vitam.common.serverv2.VitamStarter

public class VitamStarter
extends Object

launch vitam server

Constructor Summary

Constructors

Constructor and Description
VitamStarter(Class<? extends VitamApplicationConfiguration> configurationType, String configurationFile, Class<? extends javax.ws.rs.core.Application> businessApplication, Class<? extends javax.ws.rs.core.Application> adminApplication) Constructor
VitamStarter(Class<? extends VitamApplicationConfiguration> configurationType, String configurationFile, Class<? extends javax.ws.rs.core.Application> businessApplication, Class<? extends javax.ws.rs.core.Application> adminApplication, List<javax.servlet.ServletContextListener> customListeners) Constructor

Method Summary

Modifier and Type	Method and Description
protected org.eclipse.jetty.server.Handler	buildAdminHandler(String configurationFile, VitamApplicationConfiguration configuration)
protected org.eclipse.jetty.server.Handler	buildApplicationHandler(String configurationFile, VitamApplicationConfiguration configuration) Re Implement this method to construct your application specific handler if necessary.
protected org.eclipse.jetty.server.Handler	buildApplicationHandler(String configurationFile, VitamApplicationConfiguration configuration, String contextPath, String virtualHost, boolean hasSession) Re Implement this method to construct your application specific handler if necessary.
protected void	configure(String configurationFile)
org.eclipse.jetty.server.handler.ContextHandlerCollection	configureForIHM(VitamApplicationConfiguration configuration, String configurationFile, String contextPath) Method configure for IHM
protected void	configureVitamParameters() Allow override Vitam parameters
static VitamStarter	createVitamStarterForIHM(Class<? extends VitamApplicationConfiguration> configurationType, String configurationFile, Class<? extends javax.ws.rs.core.Application> businessApplication, Class<? extends javax.ws.rs.core.Application> adminApplication, List<javax.servlet.ServletContextListener> customListeners) Method to create VitamStarter only for IHM
Class<? extends VitamApplicationConfiguration>	getConfigurationType() Get configuration Type
protected int	getSession()
VitamServer	getVitamServer() Get the vitam server
boolean	isStarted() Check if server is started
protected void	platformSecretConfiguration() To allow override on non Vitam platform such as IHM
void	run() Run method, start and join the server
void	start() For Junit tests, starts only, not join
void	stop() For Junit tests, stops the server

Methods inherited from class java.lang.Object

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

Constructor Detail

VitamStarter

public VitamStarter(Class<? extends VitamApplicationConfiguration> configurationType,
                    String configurationFile,
                    Class<? extends javax.ws.rs.core.Application> businessApplication,
                    Class<? extends javax.ws.rs.core.Application> adminApplication)

Constructor

Parameters:

configurationType - configuration type

configurationFile - configuration file

businessApplication - business application

adminApplication - admin application

VitamStarter

public VitamStarter(Class<? extends VitamApplicationConfiguration> configurationType,
                    String configurationFile,
                    Class<? extends javax.ws.rs.core.Application> businessApplication,
                    Class<? extends javax.ws.rs.core.Application> adminApplication,
                    List<javax.servlet.ServletContextListener> customListeners)

Constructor

Parameters:

configurationType - configuration type

configurationFile - configuration file

businessApplication - business application

adminApplication - admin application

customListeners - list of custom listeners

Method Detail

configure

protected final void configure(String configurationFile)

platformSecretConfiguration

protected void platformSecretConfiguration()

To allow override on non Vitam platform such as IHM

configureVitamParameters

protected void configureVitamParameters()

Allow override Vitam parameters

getConfigurationType

public final Class<? extends VitamApplicationConfiguration> getConfigurationType()

Get configuration Type

Returns:

configuration type

buildApplicationHandler

protected org.eclipse.jetty.server.Handler buildApplicationHandler(String configurationFile,
                                                                   VitamApplicationConfiguration configuration)
                                                            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.

Parameters:

configurationFile - configuration file

configuration - configuration

Returns:

the generated Handler

Throws:

VitamApplicationServerException

buildAdminHandler

protected org.eclipse.jetty.server.Handler buildAdminHandler(String configurationFile,
                                                             VitamApplicationConfiguration configuration)
                                                      throws VitamApplicationServerException

Throws:

VitamApplicationServerException

getSession

protected int getSession()

Returns:

0 for NO_SESSION, 1 for SESSION

run

public final void run()
               throws VitamApplicationServerException

Run method, start and join the server

Throws:

VitamApplicationServerException

start

public void start()
           throws VitamApplicationServerException

For Junit tests, starts only, not join

Throws:

VitamApplicationServerException - in case the server could not be started

stop

public void stop()
          throws VitamApplicationServerException

For Junit tests, stops the server

Throws:

VitamApplicationServerException

isStarted

public boolean isStarted()

Check if server is started

Returns:

true if started

getVitamServer

public VitamServer getVitamServer()

Get the vitam server

Returns:

the vitam server

createVitamStarterForIHM

public static VitamStarter createVitamStarterForIHM(Class<? extends VitamApplicationConfiguration> configurationType,
                                                    String configurationFile,
                                                    Class<? extends javax.ws.rs.core.Application> businessApplication,
                                                    Class<? extends javax.ws.rs.core.Application> adminApplication,
                                                    List<javax.servlet.ServletContextListener> customListeners)

Method to create VitamStarter only for IHM

Parameters:

configurationType -

configurationFile -

businessApplication -

adminApplication -

customListeners -

Returns:

instance VitamStarter configured

configureForIHM

public final org.eclipse.jetty.server.handler.ContextHandlerCollection configureForIHM(VitamApplicationConfiguration configuration,
                                                                                       String configurationFile,
                                                                                       String contextPath)

Method configure for IHM

Parameters:

configuration -

configurationFile -

contextPath -

Returns:

ContextHandlerCollection

buildApplicationHandler

protected org.eclipse.jetty.server.Handler buildApplicationHandler(String configurationFile,
                                                                   VitamApplicationConfiguration configuration,
                                                                   String contextPath,
                                                                   String virtualHost,
                                                                   boolean hasSession)
                                                            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.

Parameters:

configurationFile -

configuration -

contextPath -

virtualHost -

hasSession -

Returns:

the generated Handler

Throws:

VitamApplicationServerException