fr.cnes.doi.client

Class ClientCrossCiteCitation

java.lang.Object

fr.cnes.doi.client.BaseClient

fr.cnes.doi.client.ClientCrossCiteCitation

@Requirement(reqId="DOI_INTER_020",
             reqName="Interface avec CrossCite Citation")
public class ClientCrossCiteCitation
extends BaseClient

Client to query the citation service. This class queries CrossCite.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientCrossCiteCitation.Context Options for each context.

Field Summary

Fields

Modifier and Type	Field and Description
private ClientCrossCiteCitation.Context	contextUse Context use.
static String	CROSS_CITE_MOCK_URL Service end point "http://localhost:1080".
static String	CROSS_CITE_URL Service end point "http://citation.crosscite.org".
static String	FORMAT_URI URI to get format "format".
static String	LOCALE_URI URI to get locales "locales".
static String	STYLE_URI URI to get styles "styles".

Fields inherited from class fr.cnes.doi.client.BaseClient

DATACITE_MOCKSERVER_PORT

Constructor Summary

Constructors

Constructor and Description
ClientCrossCiteCitation() Creates a client to "http://citation.crosscite.org" with a prod context and without a proxy.
ClientCrossCiteCitation(ClientCrossCiteCitation.Context context) Creates a client to an URI related to the context.

Method Summary

Modifier and Type	Method and Description
String	getFormat(String doiName, String style, String language) Returns the citation of a DOI based on the selected style and language.
List<String>	getLanguages() Returns languages by calling "locales".
private List<String>	getList(String segment) Returns the response as a list of String of an URI.
List<String>	getStyles() Returns styles by calling "styles".
protected void	init() Init the endpoint.

Methods inherited from class fr.cnes.doi.client.BaseClient

getClient, getLog

Methods inherited from class java.lang.Object

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

Field Detail

CROSS_CITE_URL

public static final String CROSS_CITE_URL

Service end point "http://citation.crosscite.org".

See Also:

Constant Field Values

CROSS_CITE_MOCK_URL

public static final String CROSS_CITE_MOCK_URL

Service end point "http://localhost:1080".

See Also:

Constant Field Values

STYLE_URI

public static final String STYLE_URI

URI to get styles "styles".

See Also:

Constant Field Values

LOCALE_URI

public static final String LOCALE_URI

URI to get locales "locales".

See Also:

Constant Field Values

FORMAT_URI

public static final String FORMAT_URI

URI to get format "format".

See Also:

Constant Field Values

contextUse

private final ClientCrossCiteCitation.Context contextUse

Context use.

Constructor Detail

ClientCrossCiteCitation

public ClientCrossCiteCitation()

Creates a client to "http://citation.crosscite.org" with a prod context and without a proxy.

ClientCrossCiteCitation

public ClientCrossCiteCitation(ClientCrossCiteCitation.Context context)

Creates a client to an URI related to the context.

Parameters:

context - context

Method Detail

init

protected void init()

Init the endpoint.

getList

private List<String> getList(String segment)
                      throws ClientCrossCiteException

Returns the response as a list of String of an URI.

Parameters:

segment - resource name

Returns:

the response

Throws:

ClientCrossCiteException - - if an error happens when requesting CrossCite

getStyles

public List<String> getStyles()
                       throws ClientCrossCiteException

Returns styles by calling "styles".

Returns:

list of possible styles

Throws:

ClientCrossCiteException - Will thrown an Exception when a problem happens during the request to Cross Cite

getLanguages

public List<String> getLanguages()
                          throws ClientCrossCiteException

Returns languages by calling "locales".

Returns:

List of possible languages

Throws:

ClientCrossCiteException - Will thrown an Exception when a problem happens during the request to Cross Cite

getFormat

public String getFormat(String doiName,
                        String style,
                        String language)
                 throws ClientCrossCiteException

Returns the citation of a DOI based on the selected style and language.

Parameters:

doiName - DOI name

style - Selected style to format the citation

language - Selected language to format the citation

Returns:

The formatted citation

Throws:

ClientCrossCiteException - Will thrown an Exception when a problem happens during the request to Cross Cite