AdminApplication (Digital Object Identifier Server 1.0.5 API)

java.lang.Object
- org.restlet.Restlet
- - org.restlet.Application
  - - org.restlet.ext.wadl.WadlApplication
    - - fr.cnes.doi.application.AbstractApplication
      - fr.cnes.doi.application.AdminApplication

All Implemented Interfaces:

org.restlet.Uniform
```
@Requirement(reqId="DOI_SRV_130",reqName="Cr\u00e9ation d\'un suffixe projet") @Requirement(reqId="DOI_SRV_140",reqName="R\u00e9cup\u00e9ration du nom du projet \u00e0 partir du suffixe projet") @Requirement(reqId="DOI_SRV_150",reqName="Cr\u00e9ation d\'un token") @Requirement(reqId="DOI_SRV_180",reqName="Information sur le token") @Requirement(reqId="DOI_SRV_190",reqName="Visualisation des informations d\'un DOI",coverage=NONE) @Requirement(reqId="DOI_DISPO_020",reqName="V\u00e9rification des landing pages")
public final class AdminApplication
extends AbstractApplication
```
Provides an application for handling features related to the administration system of the DOI server. The administration application provides the following features:
- An asynchronous task to check the availability of created landing pages each 1 days
- The form for creating DOI
- The Datacite status page to check Datacite services availability
- The Datacite stats page
- A service to create random string as a part of the DOI suffix
- A token service for creating token and to get token information
Security
--------------
The authentication is done by a simple login/password. Only users having the group "admin" will be allowed to log in to this application.
The website for creating DOI is opened on the net whereas the others services are filtered by IP. The allowed IPs are localhost and the IPs defined in "Starter.admin.IP.allower" attribute from the configuration file
Routing
--------------

root (DOI creation web form - no authorization)
|
|__ resources (status page - no authorization)
|__ status (Datacite status page - authorization)
|__ stats (Datacite stats page - authorization)
|_ ____________
|_|************|____ suffixProject (Get a random suffix - authorization)
|_|IP_filtering|____ token (Create a token - authorization)
|_|____________|____ token/{tokenID} (Get token information - authorization)
Author:

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

See Also:

Datacite status page, Datacite stats page, Creating a project suffix for DOI, Creating a token and getting information about a token

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADMIN_URI` URI "/admin" to access to the resources of the system administration.
`private static String`	`API_CLASSPATH` Location of the resources for the API docs in the classpath.
`private ClientMDS`	`client` ClientMDS
`static String`	`DOIS_URI` URI "/dois" to get dois from a specific project.
`private static String`	`IHM_CLASSPATH` Location of the resources for the IHM in the classpath.
`private static String`	`IHM_CONFIG_URI` URI "/js/config.js" where the configuration file is located.
`private static String`	`IHM_FOOTER_URI` URI "/footer.txt" where the footer file is located.
`static String`	`IHM_URI` URI "/ihm" where the web site is located.
`private static org.apache.logging.log4j.Logger`	`LOG` Logger.
`static String`	`NAME` Application name.
`private static int`	`PERIOD_SCHEDULER` The period between successive executions : 1.
`private static int`	`PERIOD_SCHEDULER_FOR_TOKEN_DB` The period between successive executions : 1.
`private static TimeUnit`	`PERIOD_UNIT` The time unit of the initialDelay and period parameters.
`static String`	`RESOURCE_URI` URI "/resources" to access to the resources of the status page.
`static String`	`ROLE_ADMIN_URI` URI "/roles/admin" to check admin access rights.
`static String`	`ROLE_USERS_URI` URI "/roles/users" to check access rights.
`static String`	`STATS_URI` URI "/stats" to access to Stats page.
`private static String`	`STATUS_PAGE_CLASSPATH` Location of the resources for the status page in the classpath.
`static String`	`STATUS_URI` URI "/status" to access to the status page.
`static String`	`SUFFIX_PROJECT_NAME` URI "/{suffixProject}" to manage a project suffix.
`static String`	`SUFFIX_PROJECT_NAME_TEMPLATE` Project suffix template.
`static String`	`SUFFIX_PROJECT_URI` URI "/projects" to create a project suffix.
`static String`	`SUPERUSERS_URI` URI "/superusers" to handle superusers.
`private static String`	`TARGET_STATS_URL` DataCite Stats page "https://stats.datacite.org/#tab-prefixes".
`private static String`	`TARGET_URL` DataCite Status page "http://status.datacite.org".
`static String`	`TOKEN_NAME_URI` URI "/{tokenID}" to handle to get information from a token.
`static String`	`TOKEN_TEMPLATE` Token template.
`static String`	`TOKEN_URI` URI "/token" to create a token.
`static String`	`USERS_NAME` URI "/{userName}" to handle user.
`static String`	`USERS_NAME_TEMPLATE` Template user.
`static String`	`USERS_URI` URI "/users" to handle users.

Fields inherited from class fr.cnes.doi.application.AbstractApplication
DEFAULT_CORS_CREDENTIALS, DEFAULT_CORS_ORIGIN

Constructor Summary

Constructors
Constructor and Description

AdminApplication(ClientMDS client)
Constructor.

Constructors
Constructor and Description
`AdminApplication(ClientMDS client)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`addRouteForWebSite(org.restlet.routing.Router router)` Adds default route to the website when it exists.
`private void`	`addServices(org.restlet.routing.Router router, int redirectorMode, String target, String attachURI)` Adds route attacURI to the target according to redirection mode.
`private void`	`addServicesStats(org.restlet.routing.Router router)` Adds route "/stats" to the services giving the DataCite stats.
`private void`	`addServicesStatus(org.restlet.routing.Router router)` Adds route "/status" to the services describing the DataCite status.
`private void`	`addStatusPage(org.restlet.routing.Router router)` Adds route "/resources" to the status page.
`private org.restlet.routing.Router`	`createAdminRouter()` Creates a router for REST services for the system administration.
`org.restlet.Restlet`	`createInboundRoot()` Creates a router for the AdminApplication.
`private org.restlet.security.RoleAuthorizer`	`createRoleAuthorizer()` Creates a authorization based on the role.
`private org.restlet.service.TaskService`	`createTaskService()` A task checking status of landing pages each 30 days.
`private org.restlet.service.TaskService`	`createUpdateDataBaseTaskService()` A task updating DOI users database from authentication service at each configurable period of time.
`private org.restlet.routing.Router`	`createWebSiteRouter()` Creates a router for the web site resources.
`List<String>`	`getDois(String idProject)` Returns only the dois within the specified project from the search result.
`org.apache.logging.log4j.Logger`	`getLog()` Returns the logger.
`private void`	`init()` Defines services and metadata.
`private org.restlet.service.TaskService`	`periodicalyDeleteExpiredTokenFromDB()` A task removing expired tokens in data base each days.

Methods inherited from class fr.cnes.doi.application.AbstractApplication
createAuthenticator, createAuthenticatorLoginBased, createCoreService, createHtmlRepresentation, createTokenAuthenticator, getConfig, getTokenDB, sendAlertWhenDataCiteFailed

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
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
  - NAME
```
public static final String NAME
```
    Application name.
    
    See Also:
    
    Constant Field Values
  - ADMIN_URI
```
public static final String ADMIN_URI
```
    URI "/admin" to access to the resources of the system administration.
    
    See Also:
    
    Constant Field Values
  - RESOURCE_URI
```
public static final String RESOURCE_URI
```
    URI "/resources" to access to the resources of the status page.
    
    See Also:
    
    Constant Field Values
  - STATUS_URI
```
public static final String STATUS_URI
```
    URI "/status" to access to the status page.
    
    See Also:
    
    Constant Field Values
  - STATS_URI
```
public static final String STATS_URI
```
    URI "/stats" to access to Stats page.
    
    See Also:
    
    Constant Field Values
  - ROLE_USERS_URI
```
public static final String ROLE_USERS_URI
```
    URI "/roles/users" to check access rights.
    
    See Also:
    
    Constant Field Values
  - ROLE_ADMIN_URI
```
public static final String ROLE_ADMIN_URI
```
    URI "/roles/admin" to check admin access rights.
    
    See Also:
    
    Constant Field Values
  - SUFFIX_PROJECT_URI
```
public static final String SUFFIX_PROJECT_URI
```
    URI "/projects" to create a project suffix.
    
    See Also:
    
    Constant Field Values
  - SUFFIX_PROJECT_NAME_TEMPLATE
```
public static final String SUFFIX_PROJECT_NAME_TEMPLATE
```
    Project suffix template.
    
    See Also:
    
    Constant Field Values
  - SUFFIX_PROJECT_NAME
```
public static final String SUFFIX_PROJECT_NAME
```
    URI "/{suffixProject}" to manage a project suffix.
    
    See Also:
    
    Constant Field Values
  - DOIS_URI
```
public static final String DOIS_URI
```
    URI "/dois" to get dois from a specific project.
    
    See Also:
    
    Constant Field Values
  - USERS_URI
```
public static final String USERS_URI
```
    URI "/users" to handle users.
    
    See Also:
    
    Constant Field Values
  - SUPERUSERS_URI
```
public static final String SUPERUSERS_URI
```
    URI "/superusers" to handle superusers.
    
    See Also:
    
    Constant Field Values
  - USERS_NAME_TEMPLATE
```
public static final String USERS_NAME_TEMPLATE
```
    Template user.
    
    See Also:
    
    Constant Field Values
  - USERS_NAME
```
public static final String USERS_NAME
```
    URI "/{userName}" to handle user.
    
    See Also:
    
    Constant Field Values
  - TOKEN_URI
```
public static final String TOKEN_URI
```
    URI "/token" to create a token.
    
    See Also:
    
    Constant Field Values
  - TOKEN_TEMPLATE
```
public static final String TOKEN_TEMPLATE
```
    Token template.
    
    See Also:
    
    Constant Field Values
  - TOKEN_NAME_URI
```
public static final String TOKEN_NAME_URI
```
    URI "/{tokenID}" to handle to get information from a token.
    
    See Also:
    
    Constant Field Values
  - IHM_URI
```
public static final String IHM_URI
```
    URI "/ihm" where the web site is located.
    
    See Also:
    
    Constant Field Values
  - LOG
```
private static final org.apache.logging.log4j.Logger LOG
```
    Logger.
  - IHM_CONFIG_URI
```
private static final String IHM_CONFIG_URI
```
    URI "/js/config.js" where the configuration file is located.
    
    See Also:
    
    Constant Field Values
  - IHM_FOOTER_URI
```
private static final String IHM_FOOTER_URI
```
    URI "/footer.txt" where the footer file is located.
    
    See Also:
    
    Constant Field Values
  - STATUS_PAGE_CLASSPATH
```
private static final String STATUS_PAGE_CLASSPATH
```
    Location of the resources for the status page in the classpath.
    
    See Also:
    
    Constant Field Values
  - IHM_CLASSPATH
```
private static final String IHM_CLASSPATH
```
    Location of the resources for the IHM in the classpath.
    
    See Also:
    
    Constant Field Values
  - API_CLASSPATH
```
private static final String API_CLASSPATH
```
    Location of the resources for the API docs in the classpath.
    
    See Also:
    
    Constant Field Values
  - PERIOD_SCHEDULER
```
private static final int PERIOD_SCHEDULER
```
    The period between successive executions : 1.
    
    See Also:
    
    Constant Field Values
  - PERIOD_SCHEDULER_FOR_TOKEN_DB
```
private static final int PERIOD_SCHEDULER_FOR_TOKEN_DB
```
    The period between successive executions : 1.
    
    See Also:
    
    Constant Field Values
  - PERIOD_UNIT
```
private static final TimeUnit PERIOD_UNIT
```
    The time unit of the initialDelay and period parameters.
  - TARGET_URL
```
private static final String TARGET_URL
```
    DataCite Status page "http://status.datacite.org".
    
    See Also:
    
    Constant Field Values
  - TARGET_STATS_URL
```
private static final String TARGET_STATS_URL
```
    DataCite Stats page "https://stats.datacite.org/#tab-prefixes".
    
    See Also:
    
    Constant Field Values
  - client
```
private final ClientMDS client
```
    ClientMDS
- Constructor Detail
  - AdminApplication
```
public AdminApplication(ClientMDS client)
```
    Constructor.
    
    Parameters:
    
    client - Client MDS
- Method Detail
  - init
```
private void init()
```
    Defines services and metadata.
  - createTaskService
```
@Requirement(reqId="DOI_DISPO_020",
             reqName="V\u00e9rification des landing pages")
private org.restlet.service.TaskService createTaskService()
```
    A task checking status of landing pages each 30 days.
    
    Returns:
    
    A task
  - periodicalyDeleteExpiredTokenFromDB
```
private org.restlet.service.TaskService periodicalyDeleteExpiredTokenFromDB()
```
    A task removing expired tokens in data base each days.
    
    Returns:
    
    A task
  - createUpdateDataBaseTaskService
```
private org.restlet.service.TaskService createUpdateDataBaseTaskService()
```
    A task updating DOI users database from authentication service at each configurable period of time.
    
    Returns:
    
    A task
  - createInboundRoot
```
public org.restlet.Restlet createInboundRoot()
```
    Creates a router for the AdminApplication. This router routes :
    - the web resources for the website with no authentication
    - the REST resources for the system administration with authentication/authorization
    The web resources are attached by default to the AdminApplication where as the REST resources for the system administration are attached with the ADMIN_URI
    Overrides:
    
    createInboundRoot in class org.restlet.Application
    
    Returns:
    
    Router
    
    See Also:
    
    the router that contains the the web resources, the router that contains the REST resources, the authentication mechanism, the authorization mechanism
  - createRoleAuthorizer
```
private org.restlet.security.RoleAuthorizer createRoleAuthorizer()
```
    Creates a authorization based on the role. Only users attached to the role RoleAuthorizer.ROLE_ADMIN are allowed
    
    Returns:
    
    the authorization that contains the access rights to the resources.
  - createAdminRouter
```
private org.restlet.routing.Router createAdminRouter()
```
    Creates a router for REST services for the system administration. This router contains the following resources :
    - SUFFIX_PROJECT_URI resource to handle the project suffix, which is used in the Digital Object Identifier
    - TOKEN_URI resource to handle the token for the authentication
    Returns:
    
    the router
    
    See Also:
    
    Resource to handle the the project suffix, Resource to handle the token resource
  - createWebSiteRouter
```
private org.restlet.routing.Router createWebSiteRouter()
```
    Creates a router for the web site resources. This router contains the following resources:
    - RESOURCE_URI to distribute the web resources for the status page
    - the website resources attached by default when it is available
    The website is located to IHM_URI directory when it is distributed by the DOI server.
    Returns:
    
    The router for the public web site
  - addStatusPage
```
private void addStatusPage(org.restlet.routing.Router router)
```
    Adds route "/resources" to the status page. The resources of the status page are located in the classpath "class/website".
    
    Parameters:
    
    router - router
  - addServices
```
private void addServices(org.restlet.routing.Router router,
                         int redirectorMode,
                         String target,
                         String attachURI)
```
    Adds route attacURI to the target according to redirection mode.
    
    Parameters:
    
    router - router
    
    redirectorMode - redirection mode
    
    target - target
    
    attachURI - attachURI
  - addServicesStatus
```
private void addServicesStatus(org.restlet.routing.Router router)
```
    Adds route "/status" to the services describing the DataCite status.
    
    Parameters:
    
    router - router
  - addServicesStats
```
private void addServicesStats(org.restlet.routing.Router router)
```
    Adds route "/stats" to the services giving the DataCite stats.
    
    Parameters:
    
    router - router
  - addRouteForWebSite
```
private void addRouteForWebSite(org.restlet.routing.Router router)
```
    Adds default route to the website when it exists. The website must be located in the "/ihm" directory.
    
    Parameters:
    
    router - router
  - getLog
```
public org.apache.logging.log4j.Logger getLog()
```
    Returns the logger.
    
    Overrides:
    
    getLog in class AbstractApplication
    
    Returns:
    
    the logger
  - getDois
```
public List<String> getDois(String idProject)
                     throws ClientMdsException
```
    Returns only the dois within the specified project from the search result.
    
    Parameters:
    
    idProject - project ID
    
    Returns:
    
    the search result
    
    Throws:
    
    ClientMdsException - it happens when a problem happens with Datacite

Class AdminApplication

Field Summary

Fields inherited from class fr.cnes.doi.application.AbstractApplication

Constructor Summary

Method Summary

Methods inherited from class fr.cnes.doi.application.AbstractApplication

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

Methods inherited from class org.restlet.Application

Methods inherited from class org.restlet.Restlet

Methods inherited from class java.lang.Object

Field Detail

NAME

ADMIN_URI

RESOURCE_URI

STATUS_URI

STATS_URI

ROLE_USERS_URI

ROLE_ADMIN_URI

SUFFIX_PROJECT_URI

SUFFIX_PROJECT_NAME_TEMPLATE

SUFFIX_PROJECT_NAME

DOIS_URI

USERS_URI

SUPERUSERS_URI

USERS_NAME_TEMPLATE

USERS_NAME

TOKEN_URI

TOKEN_TEMPLATE

TOKEN_NAME_URI

IHM_URI

LOG

IHM_CONFIG_URI

IHM_FOOTER_URI

STATUS_PAGE_CLASSPATH

IHM_CLASSPATH

API_CLASSPATH

PERIOD_SCHEDULER

PERIOD_SCHEDULER_FOR_TOKEN_DB

PERIOD_UNIT

TARGET_URL

TARGET_STATS_URL

client

Constructor Detail

AdminApplication

Method Detail

init

createTaskService

periodicalyDeleteExpiredTokenFromDB

createUpdateDataBaseTaskService

createInboundRoot

createRoleAuthorizer

createAdminRouter

createWebSiteRouter

addStatusPage

addServices

addServicesStatus

addServicesStats

addRouteForWebSite

getLog

getDois