fr.cnes.doi.resource.mds

Class BaseMdsResource

java.lang.Object

org.restlet.resource.Resource

org.restlet.resource.ServerResource

org.restlet.ext.wadl.WadlServerResource

fr.cnes.doi.resource.AbstractResource

fr.cnes.doi.resource.mds.BaseMdsResource

Direct Known Subclasses:

DoiResource, DoisResource, MediaResource, MetadataResource, MetadatasResource

public class BaseMdsResource
extends AbstractResource

Base resource for the different resources.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOI_PARAMETER The parameter that describes the DOI name "doi".
private DoiMdsApplication	doiApp DOI Mds application.
protected org.apache.logging.log4j.Logger	LOG Logger.
static String	URL_PARAMETER The parameter that describes the landing page related to the DOI "url".

Constructor Summary

Constructors

Constructor and Description
BaseMdsResource()

Method Summary

Modifier and Type	Method and Description
protected void	checkPermission(String doiName, String selectedRole) Checks permissions to access according to the role of the user and the DOI name.
protected void	describeDelete(org.restlet.ext.wadl.MethodInfo info) Describes WADL representation for checkPermission(java.lang.String, java.lang.String) method.
protected void	describePost(org.restlet.ext.wadl.MethodInfo info) Describes WADL representation for checkPermission(java.lang.String, java.lang.String) method.
protected void	doInit() Init.
protected org.restlet.ext.wadl.RepresentationInfo	explainRepresentation() Body representation.
String	extractSelectedRoleFromRequestIfExists() Extract selectedRole from HTTP header.
String	getAttributePath(String basePath) Retrieves path by cleaning query parameters.
DoiMdsApplication	getDoiApp() Returns the Mds application.
private String	getRoleName(String selectedRole) Returns the suffix project with which the user is associated.
private String	getRoleNameWhenNotProvidedInHeader() Get the role when the role is not provided in the header.
private String	getRoleNameWhenRoleInHeader(String selectedRole) Get the role when the role is in the header.
private boolean	hasNoRole(List<org.restlet.security.Role> roles) Tests if the user has no role.
private boolean	hasSelectedRole(String suffusedWithRole) Tests if the user has selected a role.
private boolean	hasSingleRole(List<org.restlet.security.Role> roles) Tests if the user has only one single role.

Methods inherited from class fr.cnes.doi.resource.AbstractResource

addRequestDocToMethod, addRequestDocToMethod, addRequestDocToMethod, addResponseDocToMethod, createQueryParamDoc, createQueryRepresentationDoc, createResponseDoc, createResponseDoc, createResponseDoc, htmlRepresentation, isObjectExist, isObjectNotExist, isValueExist, isValueNotExist, stringRepresentation

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

canDescribe, createHtmlRepresentation, createWadlRepresentation, describe, describe, describe, describe, describe, describe, describe, describe, describeGet, describeMethod, describeMethod, describeOptions, describeParameters, describePatch, describePut, getDescription, getName, getParameter, getParameters, getPreferredWadlVariant, getResourcePath, getResourcesBase, getWadlVariants, isAutoDescribing, options, setAutoDescribing, setDescription, setName

Methods inherited from class org.restlet.resource.ServerResource

abort, commit, delete, delete, describeVariants, doCatch, doConditionalHandle, doError, doHandle, doHandle, doNegotiatedHandle, get, get, getAttribute, getInfo, getInfo, getOnSent, getPreferredVariant, getRole, getVariants, getVariants, handle, hasAnnotations, head, head, isAnnotated, isAutoCommitting, isCommitted, isConditional, isExisting, isInRole, isNegotiated, options, patch, patch, post, post, put, put, redirectPermanent, redirectPermanent, redirectSeeOther, redirectSeeOther, redirectTemporary, redirectTemporary, setAllowedMethods, setAnnotated, setAttribute, setAutoCommitting, setChallengeRequests, setCommitted, setConditional, setCookieSettings, setDimensions, setExisting, setLocationRef, setLocationRef, setNegotiated, setOnSent, setProxyChallengeRequests, setServerInfo, setStatus, setStatus, setStatus, setStatus, updateAllowedMethods, updateDimensions

Methods inherited from class org.restlet.resource.Resource

doError, doRelease, getAllowedMethods, getApplication, getChallengeRequests, getChallengeResponse, getClientInfo, getConditions, getConnegService, getContext, getConverterService, getCookies, getCookieSettings, getDimensions, getHostRef, getLocationRef, getLogger, getMatrix, getMatrixValue, getMaxForwards, getMetadataService, getMethod, getOriginalRef, getProtocol, getProxyChallengeRequests, getProxyChallengeResponse, getQuery, getQueryValue, getRanges, getReference, getReferrerRef, getRequest, getRequestAttributes, getRequestCacheDirectives, getRequestEntity, getResponse, getResponseAttributes, getResponseCacheDirectives, getResponseEntity, getRootRef, getServerInfo, getStatus, getStatusService, init, isConfidential, isLoggable, release, setApplication, setQueryValue, setRequest, setResponse, toBoolean, toByte, toDouble, toFloat, toInteger, toLong, toObject, toRepresentation, toRepresentation, toRepresentation, toShort, toString

Methods inherited from class java.lang.Object

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

Field Detail

DOI_PARAMETER

public static final String DOI_PARAMETER

The parameter that describes the DOI name "doi".

See Also:

Constant Field Values

URL_PARAMETER

public static final String URL_PARAMETER

The parameter that describes the landing page related to the DOI "url".

See Also:

Constant Field Values

LOG

protected volatile org.apache.logging.log4j.Logger LOG

Logger.

doiApp

private volatile DoiMdsApplication doiApp

DOI Mds application.

Constructor Detail

BaseMdsResource

public BaseMdsResource()

Method Detail

doInit

protected void doInit()
               throws DoiServerException

Init.

Overrides:

doInit in class AbstractResource

Throws:

DoiServerException - - if a problem happens

hasSingleRole

private boolean hasSingleRole(List<org.restlet.security.Role> roles)

Tests if the user has only one single role.

Parameters:

roles - roles

Returns:

True when the user has only one single role otherwise False

hasNoRole

private boolean hasNoRole(List<org.restlet.security.Role> roles)

Tests if the user has no role.

Parameters:

roles - roles

Returns:

True when the user has no role otherwise False

hasSelectedRole

private boolean hasSelectedRole(String suffusedWithRole)

Tests if the user has selected a role.

Parameters:

suffusedWithRole - selected role

Returns:

True when the user has selected a role otherwise False

getRoleName

private String getRoleName(String selectedRole)
                    throws DoiServerException

Returns the suffix project with which the user is associated. For each suffix project, a role is associated. To get the suffix projet, the role must be get in the HTTP header. When several roles are associated to a user, a selectedRole must be provided to select the role that the user wants to get.

Parameters:

selectedRole - selected role

Returns:

the project name associated to the user

Throws:

DoiServerException - - CLIENT_ERROR_FORBIDDEN if the role is not allowed to use this feature - CLIENT_ERROR_UNAUTHORIZED if no role is provided - CLIENT_ERROR_CONFLICT if a user is associated to more than one role

getRoleNameWhenNotProvidedInHeader

private String getRoleNameWhenNotProvidedInHeader()

Get the role when the role is not provided in the header.

Returns:

the role name

getRoleNameWhenRoleInHeader

private String getRoleNameWhenRoleInHeader(String selectedRole)

Get the role when the role is in the header.

Parameters:

selectedRole - role from the header

Returns:

the role name

checkPermission

@Requirement(reqId="DOI_AUTO_030",
             reqName="V\u00e9rification du projet")
protected void checkPermission(String doiName,
                                                                                                                      String selectedRole)
                                                                                                               throws DoiServerException

Checks permissions to access according to the role of the user and the DOI name. The authorization in DOI server is based on role. Each projectSuffix is

• a role
• related to a projectName

When the DOI name does not start with prefixDOI/role, an exception is send.

Parameters:

doiName - DOI name

selectedRole - Selected role

Throws:

DoiServerException -

• DoiMdsApplication.API_MDS.SECURITY_USER_NO_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_NOT_IN_SELECTED_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_PERMISSION
• DoiMdsApplication.API_MDS.SECURITY_USER_CONFLICT

See Also:

Creates a suffixProject for a given project name

extractSelectedRoleFromRequestIfExists

@Requirement(reqId="DOI_AUTO_020",
             reqName="S\u00e9lection du r\u00f4le")
public String extractSelectedRoleFromRequestIfExists()

Extract selectedRole from HTTP header.

Returns:

the selected role or an empty string when there is no selected role

explainRepresentation

protected org.restlet.ext.wadl.RepresentationInfo explainRepresentation()

Body representation.

Returns:

Wadl description for a body representation

describeDelete

protected void describeDelete(org.restlet.ext.wadl.MethodInfo info)

Describes WADL representation for checkPermission(java.lang.String, java.lang.String) method. The different representations are the followings:

• DoiMdsApplication.API_MDS.SECURITY_USER_NO_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_NOT_IN_SELECTED_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_PERMISSION
• DoiMdsApplication.API_MDS.SECURITY_USER_CONFLICT

Overrides:

describeDelete in class org.restlet.ext.wadl.WadlServerResource

Parameters:

info - Method information

describePost

protected void describePost(org.restlet.ext.wadl.MethodInfo info)

Describes WADL representation for checkPermission(java.lang.String, java.lang.String) method. The different representations are the followings:

• DoiMdsApplication.API_MDS.SECURITY_USER_NO_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_NOT_IN_SELECTED_ROLE
• DoiMdsApplication.API_MDS.SECURITY_USER_PERMISSION
• DoiMdsApplication.API_MDS.SECURITY_USER_CONFLICT

Overrides:

describePost in class org.restlet.ext.wadl.WadlServerResource

Parameters:

info - Method information

getAttributePath

public String getAttributePath(String basePath)

Retrieves path by cleaning query parameters.

Parameters:

basePath - base path to remove

Returns:

the path value

getDoiApp

public DoiMdsApplication getDoiApp()

Returns the Mds application.

Returns:

the doiApp