org.grobid.core.utilities.crossref

Class CrossrefClient

java.lang.Object

org.grobid.core.utilities.crossref.CrossrefClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

GluttonClient

public class CrossrefClient
extends java.lang.Object
implements java.io.Closeable

Request pool to get data from api.crossref.org without exceeding limits supporting multi-thread.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ExecutorService	executorService
protected java.util.Map<java.lang.Long,java.util.List<java.util.concurrent.Future<?>>>	futures
protected static CrossrefClient	instance
protected static boolean	limitAuto
static Logger	logger
protected TimedSemaphore	timedSemaphore

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CrossrefClient() Hidden constructor

Method Summary

Modifier and Type	Method and Description
void	checkLimits()
void	close()
void	finish(long threadId) Wait for all request from a specific thread to be completed
static CrossrefClient	getInstance()
static void	printLog(CrossrefRequest<?> request, java.lang.String message)
<T> void	pushRequest(CrossrefRequest<T> request, CrossrefRequestListener<T> listener, long threadId) Push a request in pool to be executed as soon as possible, then wait a response through the listener.
<T> void	pushRequest(java.lang.String model, java.util.Map<java.lang.String,java.lang.String> params, CrossrefDeserializer<T> deserializer, long threadId, CrossrefRequestListener<T> listener) Push a request in pool to be executed soon as possible, then wait a response through the listener.
void	setLimits(int iterations, int interval)
void	updateLimits(int iterations, int interval)

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final Logger logger

instance

protected static volatile CrossrefClient instance

executorService

protected volatile java.util.concurrent.ExecutorService executorService

limitAuto

protected static boolean limitAuto

timedSemaphore

protected volatile TimedSemaphore timedSemaphore

futures

protected volatile java.util.Map<java.lang.Long,java.util.List<java.util.concurrent.Future<?>>> futures

Constructor Detail

CrossrefClient

protected CrossrefClient()

Hidden constructor

Method Detail

getInstance

public static CrossrefClient getInstance()

printLog

public static void printLog(CrossrefRequest<?> request,
                            java.lang.String message)

setLimits

public void setLimits(int iterations,
                      int interval)

updateLimits

public void updateLimits(int iterations,
                         int interval)

checkLimits

public void checkLimits()
                 throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

pushRequest

public <T> void pushRequest(CrossrefRequest<T> request,
                            CrossrefRequestListener<T> listener,
                            long threadId)
                     throws java.net.URISyntaxException,
                            ClientProtocolException,
                            java.io.IOException

Push a request in pool to be executed as soon as possible, then wait a response through the listener. API Documentation : https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md

Throws:

java.net.URISyntaxException

ClientProtocolException

java.io.IOException

pushRequest

public <T> void pushRequest(java.lang.String model,
                            java.util.Map<java.lang.String,java.lang.String> params,
                            CrossrefDeserializer<T> deserializer,
                            long threadId,
                            CrossrefRequestListener<T> listener)
                     throws java.net.URISyntaxException,
                            ClientProtocolException,
                            java.io.IOException

Push a request in pool to be executed soon as possible, then wait a response through the listener.

Parameters:

params - query parameters, can be null, ex: ?query.title=[title]&query.author=[author]

deserializer - json response deserializer, ex: WorkDeserializer to convert Work to BiblioItem

threadId - the java identifier of the thread providing the request (e.g. via Thread.currentThread().getId())

listener - catch response from request

Throws:

java.net.URISyntaxException

ClientProtocolException

java.io.IOException

See Also:

Crossref API Documentation

finish

public void finish(long threadId)

Wait for all request from a specific thread to be completed

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException