fr.cnes.doi.application

Class AbstractApplication

java.lang.Object

org.restlet.Restlet

org.restlet.Application

org.restlet.ext.wadl.WadlApplication

fr.cnes.doi.application.AbstractApplication

All Implemented Interfaces:

org.restlet.Uniform

Direct Known Subclasses:

AdminApplication, DoiCrossCiteApplication, DoiMdsApplication

@Requirement(reqId="DOI_DOC_010",
             reqName="Documentation des interfaces")
public abstract class AbstractApplication
extends org.restlet.ext.wadl.WadlApplication

Creates a base application by setting both the CORS, the DOI status page, the proxy and the DOI.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
private DoiSettings	config DOI settings.
static boolean	DEFAULT_CORS_CREDENTIALS If true, adds 'Access-Control-Allow-Credentials' header.
static Set	DEFAULT_CORS_ORIGIN Default value of 'Access-Control-Allow-Origin' header.
private static org.apache.logging.log4j.Logger	LOG Logger.
private AbstractTokenDBHelper	tokenDB Token database.

Constructor Summary

Constructors

Constructor and Description
AbstractApplication() This constructor creates an instance of proxySettings and doiSettings.

Method Summary

Modifier and Type	Method and Description
protected org.restlet.security.ChallengeAuthenticator	createAuthenticator() Creates the authenticator based on a HTTP basic.
protected org.restlet.security.ChallengeAuthenticator	createAuthenticatorLoginBased() Creates the authenticator based on a HTTP basic.
protected org.restlet.service.CorsService	createCoreService(Set corsOrigin, boolean corsCredentials) Defines the CORS service.
protected org.restlet.representation.Representation	createHtmlRepresentation(org.restlet.ext.wadl.ApplicationInfo applicationInfo) Creates HTML representation of the WADL.
protected org.restlet.security.ChallengeAuthenticator	createTokenAuthenticator() Creates an authentication by token.
protected DoiSettings	getConfig() Returns the configuration of the DOI server.
org.apache.logging.log4j.Logger	getLog() Returns the logger.
AbstractTokenDBHelper	getTokenDB() Returns the token database.
private void	init() Defined services and metadata.
void	sendAlertWhenDataCiteFailed(Exception exception) Sends alert as an email when DataCite failed.

Methods inherited from class org.restlet.ext.wadl.WadlApplication

attachToComponent, attachToHost, canDescribe, createFinder, createWadlRepresentation, getApplicationInfo, getBaseRef, getPreferredWadlVariant, getRouter, getWadlVariants, handle, isAutoDescribing, setAutoDescribing, setBaseRef, wadlRepresent, wadlRepresent

Methods inherited from class org.restlet.Application

createInboundRoot, createOutboundRoot, getConnectorService, getConnegService, getConverterService, getCurrent, getDecoderService, getEncoderService, getInboundRoot, getMetadataService, getOutboundRoot, getRangeService, getRole, getRoles, getServices, getStatusService, getTaskService, getTunnelService, isDebugging, setConnectorService, setConnegService, setContext, setConverterService, setCurrent, setDebugging, setDecoderService, setEncoderService, setInboundRoot, setInboundRoot, setMetadataService, setOutboundRoot, setOutboundRoot, setRangeService, setRoles, setStatusService, setTaskService, setTunnelService, start, stop

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_CORS_ORIGIN

public static final Set DEFAULT_CORS_ORIGIN

Default value of 'Access-Control-Allow-Origin' header.

DEFAULT_CORS_CREDENTIALS

public static final boolean DEFAULT_CORS_CREDENTIALS

If true, adds 'Access-Control-Allow-Credentials' header.

See Also:

Constant Field Values

LOG

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

Logger.

tokenDB

private final AbstractTokenDBHelper tokenDB

Token database.

config

private final DoiSettings config

DOI settings.

Constructor Detail

AbstractApplication

public AbstractApplication()

This constructor creates an instance of proxySettings and doiSettings. By creating the instance, the constructor creates :

• the CORS service using the default value DEFAULT_CORS_ORIGIN and DEFAULT_CORS_CREDENTIALS
• the custom status page

See Also:

CORS, createCoreService(java.util.Set, boolean)

Method Detail

init

private void init()

Defined services and metadata.

createCoreService

protected final org.restlet.service.CorsService createCoreService(Set corsOrigin,
                                                                  boolean corsCredentials)

Defines the CORS service.

Parameters:

corsOrigin - IP that can access to the service

corsCredentials - credentials allowed

Returns:

CORS service

createAuthenticator

@Requirement(reqId="DOI_AUTH_010",
             reqName="Authentification par login/mot de passe")
protected org.restlet.security.ChallengeAuthenticator createAuthenticator()

Creates the authenticator based on a HTTP basic. Creates the user, role and mapping user/role.

Returns:

Authenticator based on a challenge scheme

createAuthenticatorLoginBased

@Requirement(reqId="DOI_AUTH_010",
             reqName="Authentification par login/mot de passe")
protected org.restlet.security.ChallengeAuthenticator createAuthenticatorLoginBased()

Creates the authenticator based on a HTTP basic. Creates the user, role and mapping user/role.

Returns:

Authenticator based on a challenge scheme

createTokenAuthenticator

@Requirement(reqId="DOI_AUTH_020",
             reqName="Authentification par token")
protected org.restlet.security.ChallengeAuthenticator createTokenAuthenticator()

Creates an authentication by token.

Returns:

the object that contains the business to check

See Also:

the token verification

createHtmlRepresentation

protected org.restlet.representation.Representation createHtmlRepresentation(org.restlet.ext.wadl.ApplicationInfo applicationInfo)

Creates HTML representation of the WADL.

Overrides:

createHtmlRepresentation in class org.restlet.ext.wadl.WadlApplication

Parameters:

applicationInfo - Application description

Returns:

the HTML representation of the WADL

sendAlertWhenDataCiteFailed

public void sendAlertWhenDataCiteFailed(Exception exception)

Sends alert as an email when DataCite failed.

Parameters:

exception - error message to send

getConfig

protected final DoiSettings getConfig()

Returns the configuration of the DOI server.

Returns:

the configuration of the DOI server.

getTokenDB

public AbstractTokenDBHelper getTokenDB()

Returns the token database.

Returns:

the token database

getLog

public org.apache.logging.log4j.Logger getLog()

Returns the logger.

Returns:

the logger