DoiMdsApplication (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.DoiMdsApplication

All Implemented Interfaces:

org.restlet.Uniform
```
@Requirement(reqId="DOI_SRV_010",reqName="Cr\u00e9ation de m\u00e9tadonn\u00e9es") @Requirement(reqId="DOI_SRV_020",reqName="Enregistrement d\u2019un DOI") @Requirement(reqId="DOI_SRV_030",reqName="Mise \u00e0 jour de l\u2019URL de la landing page d\'un DOI") @Requirement(reqId="DOI_SRV_040",reqName="Mise \u00e0 jour des m\u00e9tadonn\u00e9es d\u2019un DOI") @Requirement(reqId="DOI_SRV_050",reqName="D\u00e9sactivation d\u2019un DOI") @Requirement(reqId="DOI_SRV_060",reqName="R\u00e9cup\u00e9ration des m\u00e9tadonn\u00e9es") @Requirement(reqId="DOI_SRV_070",reqName="R\u00e9cup\u00e9ration de l\u2019URL de la landing page") @Requirement(reqId="DOI_SRV_080",reqName="Cr\u00e9ation d\u2019un m\u00e9dia") @Requirement(reqId="DOI_SRV_090",reqName="R\u00e9cup\u00e9ration des m\u00e9dias") @Requirement(reqId="DOI_MONIT_020",reqName="Monitoring de l\'\u00e9tat de DataCite")
public final class DoiMdsApplication
extends AbstractApplication
```
Provides an application to handle Data Object Identifier within an organization. A Digital Object Identifier (DOI) is a persistent identifier or handle used to uniquely identify objects, standardized by the International Organization. A DOI aims to be "resolvable", usually to some form of access to the information object to which the DOI refers. This is achieved by binding the DOI to metadata about the object, such as a URL, where all the details about the object are accessible. Everytime a URL changes, the publisher has to update the metadata for the DOI to link to the new URL. It is the publisher's responsibility to update the DOI database. If he fails to do so, the DOI resolves to a dead link leaving the DOI useless.
Two methods of authentication are defined in this application and both is optional:
- authenticator by login/password
- authenticator by token
Only the GET can be anonymous whereas POST, PUT, DELETE methods need to be authenticated.
Security
-------------- The authentication is done by the following pipeline: |Method authorization|-->|Authentication login/pwd|-->|Authentication token| Method authorization : Only GET method does not need an authorization
Routing
-------------- root | |__ dois (authorization) |__ dois/{doiName} (authorization) |__ metadata (authorization) |__ metadata/{doiName} (authorization) |__ media/{doiName} (authorization)
Author:

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

See Also:

the resources related to this application, DOI Handbook, API Documentation, List and create DOI, Handle a DOI, Create metadata, Handle DOI metadata, Handle media related to metadata

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DoiMdsApplication.API_MDS` API related only to the code in this webservice.
`static class`	`DoiMdsApplication.SecurityPostProcessingFilter` Post processing for specific authorization.

Field Summary

Fields
Modifier and Type	Field and Description
`private ClientMDS`	`client` Client to query Mds Datacite.
`static String`	`DOI_NAME_URI` URI to handle a DOI : "/{doiName}".
`static String`	`DOI_TEMPLATE` Template Query for DOI : "doiName".
`static String`	`DOI_URI` URI to handle the collection of DOIs : "/dois".
`private static org.apache.logging.log4j.Logger`	`LOG` Logger.
`static String`	`MEDIA_URI` URI to handle media : "/media".
`static String`	`METADATAS_URI` URI to handle metadata : "/metadata".
`static String`	`NAME` Application name : "Metadata Store Application"
`private AbstractTokenDBHelper`	`tokenDB` Token DB that contains the set of generated token.

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

Constructor Summary

Constructors
Constructor and Description

DoiMdsApplication(ClientMDS client)
Creates the Digital Object Identifier server application.

Constructors
Constructor and Description
`DoiMdsApplication(ClientMDS client)` Creates the Digital Object Identifier server application.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.restlet.Restlet`	`createInboundRoot()` Creates a router for the DoiMdsApplication.
`private org.restlet.security.MethodAuthorizer`	`createMethodAuthorizer()` Creates the method authorizer.
`private org.restlet.routing.Router`	`createRouter()` Creates the router.
`org.restlet.ext.wadl.ApplicationInfo`	`getApplicationInfo(org.restlet.Request request, org.restlet.Response response)` Method to describe application in the WADL.
`ClientMDS`	`getClient()` Returns the client.
`String`	`getDataCentrePrefix()` Returns the DOI prefix.
`org.apache.logging.log4j.Logger`	`getLog()` Returns the logger.
`private String`	`getLoginMds()` Returns the decrypted login for DataCite.
`private String`	`getPwdMds()` Returns the decrypted password for DataCite.
`AbstractTokenDBHelper`	`getTokenDB()` Returns the token database.

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

Methods inherited from class org.restlet.ext.wadl.WadlApplication
attachToComponent, attachToHost, canDescribe, createFinder, createWadlRepresentation, 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
  - DOI_TEMPLATE
```
public static final String DOI_TEMPLATE
```
    Template Query for DOI : "doiName".
    
    See Also:
    
    Constant Field Values
  - DOI_URI
```
public static final String DOI_URI
```
    URI to handle the collection of DOIs : "/dois".
    
    See Also:
    
    Constant Field Values
  - DOI_NAME_URI
```
public static final String DOI_NAME_URI
```
    URI to handle a DOI : "/{doiName}".
    
    See Also:
    
    Constant Field Values
  - METADATAS_URI
```
public static final String METADATAS_URI
```
    URI to handle metadata : "/metadata".
    
    See Also:
    
    Constant Field Values
  - MEDIA_URI
```
public static final String MEDIA_URI
```
    URI to handle media : "/media".
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    Application name : "Metadata Store Application"
    
    See Also:
    
    Constant Field Values
  - LOG
```
private static final org.apache.logging.log4j.Logger LOG
```
    Logger.
  - client
```
private final ClientMDS client
```
    Client to query Mds Datacite.
  - tokenDB
```
private final AbstractTokenDBHelper tokenDB
```
    Token DB that contains the set of generated token.
- Constructor Detail
  - DoiMdsApplication
```
public DoiMdsApplication(ClientMDS client)
```
    Creates the Digital Object Identifier server application.
    
    Parameters:
    
    client - ClientMDS
    
    Throws:
    
    DoiRuntimeException - When the DataCite schema is not available
- Method Detail
  - createInboundRoot
```
public org.restlet.Restlet createInboundRoot()
```
    Creates a router for the DoiMdsApplication. This router routes the resources for the Mds application, which is protected by two authentication mechanisms (optional mechanisms) and an authorization by method.
    
    Overrides:
    
    createInboundRoot in class org.restlet.Application
    
    Returns:
    
    Router
    
    See Also:
    
    the router that contains the Mds resources, the authentication mechanism by login/password, the authentication mechanism by token, the method authorization mechanism
  - createRouter
```
private org.restlet.routing.Router createRouter()
```
    Creates the router. The router routes the following resources:
    - DOI_URI to create/update a DOI and its landing page
    - DOI_URI DOI_NAME_URI to get the URL of the landing page related to a given DOI
    - METADATAS_URI to create/update DOI metadata
    - METADATAS_URI DOI_NAME_URI to get DOI's metadata or delete a given DOI
    - MEDIA_URI DOI_NAME_URI to handle media related to a DOI
    Returns:
    
    the router
    
    See Also:
    
    Handles a DOI and its landing page, Handles DOI metadata, Handles DOI metadata, Handles media related to a DOI
  - createMethodAuthorizer
```
private org.restlet.security.MethodAuthorizer createMethodAuthorizer()
```
    Creates the method authorizer. GET method can be anonymous. The verbs (POST, PUT, DELETE) need to be authenticated.
    
    Returns:
    
    Authorizer based on authorized methods
  - getLoginMds
```
private String getLoginMds()
```
    Returns the decrypted login for DataCite.
    
    Returns:
    
    the DataCite's login
  - getPwdMds
```
private String getPwdMds()
```
    Returns the decrypted password for DataCite.
    
    Returns:
    
    the DataCite's pwd
  - getDataCentrePrefix
```
public String getDataCentrePrefix()
```
    Returns the DOI prefix.
    
    Returns:
    
    the DOI prefix
  - getClient
```
public ClientMDS getClient()
```
    Returns the client.
    
    Returns:
    
    the client
  - getTokenDB
```
public AbstractTokenDBHelper getTokenDB()
```
    Returns the token database.
    
    Overrides:
    
    getTokenDB in class AbstractApplication
    
    Returns:
    
    the token database
  - getLog
```
public org.apache.logging.log4j.Logger getLog()
```
    Returns the logger.
    
    Overrides:
    
    getLog in class AbstractApplication
    
    Returns:
    
    the logger
  - getApplicationInfo
```
public final org.restlet.ext.wadl.ApplicationInfo getApplicationInfo(org.restlet.Request request,
                                                                     org.restlet.Response response)
```
    Method to describe application in the WADL.
    
    Overrides:
    
    getApplicationInfo in class org.restlet.ext.wadl.WadlApplication
    
    Parameters:
    
    request - Request
    
    response - Response
    
    Returns:
    
    the application description for WADL

Class DoiMdsApplication

Nested Class Summary

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

DOI_TEMPLATE

DOI_URI

DOI_NAME_URI

METADATAS_URI

MEDIA_URI

NAME

LOG

client

tokenDB

Constructor Detail

DoiMdsApplication

Method Detail

createInboundRoot

createRouter

createMethodAuthorizer

getLoginMds

getPwdMds

getDataCentrePrefix

getClient

getTokenDB

getLog

getApplicationInfo