fr.cnes.doi.client

Enum ClientMDS.Context

java.lang.Object

java.lang.Enum<ClientMDS.Context>

fr.cnes.doi.client.ClientMDS.Context

All Implemented Interfaces:

Serializable, Comparable<ClientMDS.Context>

Enclosing class:

ClientMDS

public static enum ClientMDS.Context
extends Enum<ClientMDS.Context>

Options for each context

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEV Development context.
POST_DEV Post development context.
PRE_PROD Pre production context.
PROD Production context.

Field Summary

Fields

Modifier and Type	Field and Description
private String	dataCiteUrl DataCite URL.
private boolean	isDoiPrefix There is special test prefix 10.5072 available to all datacentres.
private boolean	isTestMode Each API call can have optional query parametertestMode.
private Level	levelLog Level log.

Method Summary

Modifier and Type	Method and Description
String	getDataCiteUrl() Returns the service end point.
Level	getLevelLog() Returns the log level.
boolean	hasDoiTestPrefix() Returns true when the context has a DOI dev.
boolean	hasTestMode() Returns true when the context must not register data in DataCite
static void	setDataCiteUrl(ClientMDS.Context context, String dataCiteUrl) Sets the DataCite URL for a given context
private void	setDataCiteURl(String dataCiteUrl) Sets the DataCite URL for the context
static void	setLevelLog(ClientMDS.Context context, Level levelLog) Sets the level log for a given context
private void	setLevelLog(Level levelLog) Sets the level log for the context
static ClientMDS.Context	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientMDS.Context[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEV

public static final ClientMDS.Context DEV

Development context.

POST_DEV

public static final ClientMDS.Context POST_DEV

Post development context.

PRE_PROD

public static final ClientMDS.Context PRE_PROD

Pre production context.

PROD

public static final ClientMDS.Context PROD

Production context.

Field Detail

isTestMode

private final boolean isTestMode

Each API call can have optional query parametertestMode. If set to "true" or "1" the request will not change the database nor will the DOI handle will be registered or updated, e.g. POST /doi?testMode=true and the testing prefix will be used instead of the provided prefix

isDoiPrefix

private final boolean isDoiPrefix

There is special test prefix 10.5072 available to all datacentres. Please use it for all your testing DOIs. Your real prefix should not be used for test DOIs. Note that DOIs with test prefix will behave like any other DOI, e.g. they can be normally resolved. They will not be exposed by upcoming services like search and OAI, though. Periodically we purge all 10.5072 datasets from the system.

levelLog

private Level levelLog

Level log.

dataCiteUrl

private String dataCiteUrl

DataCite URL.

Method Detail

values

public static ClientMDS.Context[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientMDS.Context c : ClientMDS.Context.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientMDS.Context valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

hasDoiTestPrefix

public boolean hasDoiTestPrefix()

Returns true when the context has a DOI dev.

Returns:

True when the context has a DOI dev

hasTestMode

public boolean hasTestMode()

Returns true when the context must not register data in DataCite

Returns:

true when the context must not register data in DataCite

getLevelLog

public Level getLevelLog()

Returns the log level.

Returns:

the log level

getDataCiteUrl

public String getDataCiteUrl()

Returns the service end point.

Returns:

the service end point

setDataCiteURl

private void setDataCiteURl(String dataCiteUrl)

Sets the DataCite URL for the context

Parameters:

dataCiteUrl - DataCite URL

setLevelLog

private void setLevelLog(Level levelLog)

Sets the level log for the context

Parameters:

levelLog - level log

setLevelLog

public static void setLevelLog(ClientMDS.Context context,
                               Level levelLog)

Sets the level log for a given context

Parameters:

context - the context

levelLog - the level log

setDataCiteUrl

public static void setDataCiteUrl(ClientMDS.Context context,
                                  String dataCiteUrl)

Sets the DataCite URL for a given context

Parameters:

context - the context

dataCiteUrl - the DataCite URL