fr.cnes.doi.server

Class DoiServer

java.lang.Object

org.restlet.Restlet

org.restlet.Component

fr.cnes.doi.server.DoiServer

All Implemented Interfaces:

org.restlet.Uniform

public class DoiServer
extends org.restlet.Component

DoiServer contains the configuration of this server and the methods to start/stop it.

Author:

Jean-Christophe Malapert (jean-christophe.malapert@cnes.fr)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CITATION_URI URI of the Citation application.
static String	DEFAULT_MAX_CONNECTIONS_PER_HOST Default number for RESTLET_MAX_CONNECTIONS_PER_HOST.
static String	DEFAULT_MAX_TOTAL_CONNECTIONS Default number for RESTLET_MAX_TOTAL_CONNECTIONS.
static String	DEFAULT_SSL_CTX Default value for SSL_CTX_FACTORY parameter : "org.restlet.engine.ssl.DefaultSslContextFactory".
static String	JKS_DIRECTORY Directory "jks".
static String	JKS_FILE JKS file, which is stored in the JAR.
static String	KEY_PWD Key password parameter "keyPassword".
static String	KEY_STORE_PATH Key store parameter "keyStorePath".
static String	KEY_STORE_PWD Key store password parameter "keyStorePassword".
static String	KEY_STORE_TYPE Key store type parameter "keyStoreType".
private static org.apache.logging.log4j.Logger	LOG Logger.
static String	MDS_URI URI of the Meta Data Store application.
private static String	MESSAGE_TPL Template message "{} : {}".
private static String	PARAMETERS Text to display "Parameters" in log messages.
static String	RESTLET_MAX_CONNECTIONS_PER_HOST Number connections per host.
static String	RESTLET_MAX_TOTAL_CONNECTIONS Number total connections.
private DoiSettings	settings Configuration.
static String	SSL_CTX_FACTORY SslContectFactory parameter "sslContextFactory".
static String	STATUS_URI URI of the Datacite status.
static String	TRUST_STORE_PATH Trust store path parameter "trustStorePath".
static String	TRUST_STORE_PWD Trust store password parameter "trustStorePath".
static String	TRUST_STORE_TYPE Trust store type parameter "trustStorePath".

Constructor Summary

Constructors

Constructor and Description
DoiServer(DoiSettings settings) Creates an instance of the server with settings coming from the config.properties

Method Summary

Modifier and Type	Method and Description
private void	addAuthenticationUserAsAdmin(String username) Adds an authentication system user as administrator of the DOI server
private void	configureServer() Configures the Server in HTTP and HTTPS.
private String	extractKeyStoreToPath() Extracts keystore for JAR and copy it in a directory in order to use it.
private void	initAttachApplication() Routes the applications.
private void	initClients() Inits supported protocols.
private boolean	initHttpServer() Inits the HTTP server.
private boolean	initHttpsServer() Inits the HTTPS server.
private void	initJettyConfiguration(org.restlet.Server server) Init the Jetty configuration and applies it to the server.
private void	initLogServices() Init log services.
void	start()
private org.restlet.Server	startHttpServer(Integer port) Creates a HTTP server
private org.restlet.Server	startHttpsServer(Integer port) Creates a HTTPS server
private void	startWithProxy() Starts with proxy.
void	stop()

Methods inherited from class org.restlet.Component

getClients, getDefaultHost, getHosts, getInternalRouter, getLogService, getRealm, getRealms, getServers, getServices, getStatusService, getTaskService, handle, main, setClients, setContext, setDefaultHost, setHosts, setInternalRouter, setLogService, setRealms, setServers, setStatusService, setTaskService, startClients, startHelper, startRealms, startRouters, startServers, startServices, stopClients, stopHelper, stopRealms, stopRouters, stopServers, stopServices, updateHosts

Methods inherited from class org.restlet.Restlet

createFinder, finalize, getApplication, getAuthor, getContext, getDescription, getFinderClass, getLogger, getName, getOwner, handle, handle, handle, isStarted, isStopped, setAuthor, setDescription, setFinderClass, setName, setOwner

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SSL_CTX

public static final String DEFAULT_SSL_CTX

Default value for SSL_CTX_FACTORY parameter : "org.restlet.engine.ssl.DefaultSslContextFactory".

See Also:

Constant Field Values

SSL_CTX_FACTORY

public static final String SSL_CTX_FACTORY

SslContectFactory parameter "sslContextFactory".

See Also:

Constant Field Values

KEY_STORE_PATH

public static final String KEY_STORE_PATH

Key store parameter "keyStorePath".

See Also:

Constant Field Values

KEY_STORE_PWD

public static final String KEY_STORE_PWD

Key store password parameter "keyStorePassword".

See Also:

Constant Field Values

KEY_STORE_TYPE

public static final String KEY_STORE_TYPE

Key store type parameter "keyStoreType".

See Also:

Constant Field Values

KEY_PWD

public static final String KEY_PWD

Key password parameter "keyPassword".

See Also:

Constant Field Values

TRUST_STORE_PATH

public static final String TRUST_STORE_PATH

Trust store path parameter "trustStorePath".

See Also:

Constant Field Values

TRUST_STORE_PWD

public static final String TRUST_STORE_PWD

Trust store password parameter "trustStorePath".

See Also:

Constant Field Values

TRUST_STORE_TYPE

public static final String TRUST_STORE_TYPE

Trust store type parameter "trustStorePath".

See Also:

Constant Field Values

JKS_FILE

public static final String JKS_FILE

JKS file, which is stored in the JAR.

See Also:

Constant Field Values

JKS_DIRECTORY

public static final String JKS_DIRECTORY

Directory "jks". where JKS_FILE is located.

See Also:

Constant Field Values

MDS_URI

public static final String MDS_URI

URI of the Meta Data Store application.

See Also:

Constant Field Values

CITATION_URI

public static final String CITATION_URI

URI of the Citation application.

See Also:

Constant Field Values

STATUS_URI

public static final String STATUS_URI

URI of the Datacite status.

See Also:

Constant Field Values

RESTLET_MAX_TOTAL_CONNECTIONS

public static final String RESTLET_MAX_TOTAL_CONNECTIONS

Number total connections.

See Also:

Constant Field Values

RESTLET_MAX_CONNECTIONS_PER_HOST

public static final String RESTLET_MAX_CONNECTIONS_PER_HOST

Number connections per host.

See Also:

Constant Field Values

DEFAULT_MAX_TOTAL_CONNECTIONS

public static final String DEFAULT_MAX_TOTAL_CONNECTIONS

Default number for RESTLET_MAX_TOTAL_CONNECTIONS.

See Also:

Constant Field Values

DEFAULT_MAX_CONNECTIONS_PER_HOST

public static final String DEFAULT_MAX_CONNECTIONS_PER_HOST

Default number for RESTLET_MAX_CONNECTIONS_PER_HOST.

See Also:

Constant Field Values

LOG

private static final org.apache.logging.log4j.Logger LOG

Logger.

MESSAGE_TPL

private static final String MESSAGE_TPL

Template message "{} : {}".

See Also:

Constant Field Values

PARAMETERS

private static final String PARAMETERS

Text to display "Parameters" in log messages.

See Also:

Constant Field Values

settings

private final DoiSettings settings

Configuration.

Constructor Detail

DoiServer

public DoiServer(DoiSettings settings)
          throws ClientMdsException

Creates an instance of the server with settings coming from the config.properties

Parameters:

settings - settings

Throws:

ClientMdsException - It happens when the server cannot access to Datacite account

Method Detail

initLogServices

private void initLogServices()

Init log services.

configureServer

@Requirement(reqId="DOI_ARCHI_010",
             reqName="Protocole HTTP et HTTPS pour les API")
private void configureServer()
                                                                                                                       throws ClientMdsException

Configures the Server in HTTP and HTTPS.

Throws:

ClientMdsException

initHttpServer

private boolean initHttpServer()

Inits the HTTP server.

Returns:

True when the Http server is configured to start.

initHttpsServer

private boolean initHttpsServer()

Inits the HTTPS server.

Returns:

True when the Https server is configured to start.

initJettyConfiguration

private void initJettyConfiguration(org.restlet.Server server)

Init the Jetty configuration and applies it to the server.

Parameters:

server - HTTP or HTTPS server

initClients

private void initClients()

Inits supported protocols. Theses protocols are used by the server to access to resources

initAttachApplication

private void initAttachApplication()
                            throws ClientMdsException

Routes the applications.

Throws:

ClientMdsException

addAuthenticationUserAsAdmin

private void addAuthenticationUserAsAdmin(String username)

Adds an authentication system user as administrator of the DOI server

Parameters:

username - username

startWithProxy

private void startWithProxy()
                     throws ClientMdsException

Starts with proxy.

Throws:

ClientMdsException

startHttpServer

private org.restlet.Server startHttpServer(Integer port)

Creates a HTTP server

Parameters:

port - HTTP port

Returns:

the HTTP server

startHttpsServer

private org.restlet.Server startHttpsServer(Integer port)

Creates a HTTPS server

Parameters:

port - HTTPS port

Returns:

the HTTPS server

extractKeyStoreToPath

private String extractKeyStoreToPath()

Extracts keystore for JAR and copy it in a directory in order to use it.

Returns:

the path of the new location of the keystore.

start

public void start()
           throws Exception

Overrides:

start in class org.restlet.Component

Throws:

Exception

stop

public void stop()
          throws Exception

Overrides:

stop in class org.restlet.Component

Throws:

Exception