org.dspace.importer.external.service.other

Class MetadataSource

java.lang.Object

org.dspace.importer.external.service.other.MetadataSource

Direct Known Subclasses:

AbstractImportMetadataSourceService

public abstract class MetadataSource
extends Object

Created by: Antoine Snyers (antoine at atmire dot com) Date: 27 Oct 2014

Field Summary

Fields

Modifier and Type	Field and Description
protected Exception	error
protected Map<Class,List<SourceExceptionHandler>>	exceptionHandlersMap
protected long	interRequestTime
protected long	lastRequest
protected ReentrantLock	lock
protected int	maxRetry
protected String	operationId
protected int	retry
protected String	warning

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MetadataSource()

Method Summary

Methods

Modifier and Type	Method and Description
Exception	getError()
protected List<SourceExceptionHandler>	getExceptionHandler(Exception e)
int	getMaxRetry()
String	getOperationId()
int	getRetry()
String	getWarning()
protected void	handleException(int retry, Exception e, String operationId)
abstract void	init() Attempts to init a session
protected void	initExceptionHandlers()
protected <T> T	retry(Callable<T> callable) Command pattern implementation.
void	setError(Exception error)
void	setMaxRetry(int maxRetry)
void	setWarning(String warning)
protected void	throwSourceException(int retry, Exception e, String operationId)
protected void	throwSourceExceptionHook()

Methods inherited from class java.lang.Object

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

Field Detail

lastRequest

protected long lastRequest

interRequestTime

protected long interRequestTime

lock

protected ReentrantLock lock

maxRetry

protected int maxRetry

retry

protected int retry

operationId

protected String operationId

warning

protected String warning

exceptionHandlersMap

protected Map<Class,List<SourceExceptionHandler>> exceptionHandlersMap

error

protected Exception error

Constructor Detail

MetadataSource

protected MetadataSource()

Method Detail

initExceptionHandlers

protected void initExceptionHandlers()

getWarning

public String getWarning()

setWarning

public void setWarning(String warning)

getRetry

public int getRetry()

getMaxRetry

public int getMaxRetry()

setMaxRetry

public void setMaxRetry(int maxRetry)

getOperationId

public String getOperationId()

getError

public Exception getError()

setError

public void setError(Exception error)

retry

protected <T> T retry(Callable<T> callable)
           throws MetadataSourceException

Command pattern implementation. the callable.call method will be retried until it either succeeds or reaches the try limit. Maybe this should have a backoff algorithm instead of waiting a fixed time.

Type Parameters:

T - return type. Generics for type safety.

Parameters:

callable - the callable to call. See the classes with the same name as the public methods of this class.

Returns:

The result of the call

Throws:

com.atmire.import_citations.configuration.SourceException - if something unrecoverable happens (e.g. network failures)

MetadataSourceException

handleException

protected void handleException(int retry,
                   Exception e,
                   String operationId)
                        throws MetadataSourceException

Throws:

MetadataSourceException

getExceptionHandler

protected List<SourceExceptionHandler> getExceptionHandler(Exception e)

throwSourceException

protected void throwSourceException(int retry,
                        Exception e,
                        String operationId)
                             throws MetadataSourceException

Throws:

MetadataSourceException

throwSourceExceptionHook

protected void throwSourceExceptionHook()

init

public abstract void init()
                   throws Exception

Attempts to init a session

Throws:

Exception - if error