eu.fthevenet.binjr.data.adapters

Class HttpDataAdapterBase<T,A extends Decoder<T>>

java.lang.Object

eu.fthevenet.binjr.data.adapters.DataAdapter<T,A>

eu.fthevenet.binjr.data.adapters.SimpleCachingDataAdapter<T,A>

eu.fthevenet.binjr.data.adapters.HttpDataAdapterBase<T,A>

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

JrdsDataAdapter

public abstract class HttpDataAdapterBase<T,A extends Decoder<T>>
extends SimpleCachingDataAdapter<T,A>

This class provides a base on which to implement DataAdapter instances that communicate with sources via the HTTP protocol.

Author:

Frederic Thevenet

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BASE_ADDRESS_PARAM_NAME

Fields inherited from class eu.fthevenet.binjr.data.adapters.SimpleCachingDataAdapter

DEFAULT_CACHE_SIZE

Fields inherited from class eu.fthevenet.binjr.data.adapters.DataAdapter

closed

Constructor Summary

Constructors

Constructor and Description
HttpDataAdapterBase() Creates a new instance of the HttpDataAdapterBase class.
HttpDataAdapterBase(java.net.URL baseAddress) Creates a new instance of the HttpDataAdapterBase class for the specified base address.

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract java.net.URI	craftFetchUri(java.lang.String path, java.time.Instant begin, java.time.Instant end)
protected java.net.URI	craftRequestUri(java.lang.String path, java.util.List<org.apache.http.NameValuePair> params)
protected java.net.URI	craftRequestUri(java.lang.String path, org.apache.http.NameValuePair... params)
protected static javax.net.ssl.SSLContext	createSslCustomContext()
protected <R> R	doHttpGet(java.net.URI requestUri, org.apache.http.client.ResponseHandler<R> responseHandler)
java.net.URL	getBaseAddress() Returns the source's base address
java.util.Map<java.lang.String,java.lang.String>	getParams() Returns a map of all parameters required to establish a connection to the underlying data source
protected org.apache.http.impl.client.CloseableHttpClient	httpClientFactory()
void	loadParams(java.util.Map<java.lang.String,java.lang.String> params) Sets the parameters required to establish a connection to the underlying data source
byte[]	onCacheMiss(java.lang.String path, java.time.Instant begin, java.time.Instant end) Gets raw data from the source as an output stream, for the time interval specified.
void	setBaseAddress(java.net.URL baseAddress) Sets the source's base address

Methods inherited from class eu.fthevenet.binjr.data.adapters.SimpleCachingDataAdapter

fetchRawData

Methods inherited from class eu.fthevenet.binjr.data.adapters.DataAdapter

fetchDecodedData, getBindingTree, getDecoder, getEncoding, getId, getSourceName, getTimeZoneId, isClosed, onStart, ping, setId, toString, validateParameter, validateParameterNullity

Methods inherited from class java.lang.Object

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

Field Detail

BASE_ADDRESS_PARAM_NAME

protected static final java.lang.String BASE_ADDRESS_PARAM_NAME

See Also:

Constant Field Values

Constructor Detail

HttpDataAdapterBase

public HttpDataAdapterBase()
                    throws CannotInitializeDataAdapterException

Creates a new instance of the HttpDataAdapterBase class.

Throws:

CannotInitializeDataAdapterException - if the DataAdapter cannot be initialized.

HttpDataAdapterBase

public HttpDataAdapterBase(java.net.URL baseAddress)
                    throws CannotInitializeDataAdapterException

Creates a new instance of the HttpDataAdapterBase class for the specified base address.

Parameters:

baseAddress - the source's base address

Throws:

CannotInitializeDataAdapterException - if the DataAdapter cannot be initialized.

Method Detail

onCacheMiss

public byte[] onCacheMiss(java.lang.String path,
                          java.time.Instant begin,
                          java.time.Instant end)
                   throws DataAdapterException

Description copied from class: SimpleCachingDataAdapter

Gets raw data from the source as an output stream, for the time interval specified.

Specified by:

onCacheMiss in class SimpleCachingDataAdapter<T,A extends Decoder<T>>

Parameters:

path - the path of the data in the source

begin - the start of the time interval.

end - the end of the time interval.

Returns:

the data to store in the cache.

Throws:

DataAdapterException - if an error occurs while retrieving data from the source.

getParams

public java.util.Map<java.lang.String,java.lang.String> getParams()

Description copied from class: DataAdapter

Returns a map of all parameters required to establish a connection to the underlying data source

Specified by:

getParams in class DataAdapter<T,A extends Decoder<T>>

Returns:

a map of all parameters required to establish a connection to the underlying data source

loadParams

public void loadParams(java.util.Map<java.lang.String,java.lang.String> params)
                throws DataAdapterException

Description copied from class: DataAdapter

Sets the parameters required to establish a connection to the underlying data source

Specified by:

loadParams in class DataAdapter<T,A extends Decoder<T>>

Parameters:

params - the parameters required to establish a connection to the underlying data source

Throws:

DataAdapterException

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class SimpleCachingDataAdapter<T,A extends Decoder<T>>

doHttpGet

protected <R> R doHttpGet(java.net.URI requestUri,
                          org.apache.http.client.ResponseHandler<R> responseHandler)
                   throws DataAdapterException

Throws:

DataAdapterException

createSslCustomContext

protected static javax.net.ssl.SSLContext createSslCustomContext()
                                                          throws java.security.KeyStoreException,
                                                                 java.io.IOException,
                                                                 java.security.NoSuchAlgorithmException,
                                                                 java.security.cert.CertificateException,
                                                                 java.security.KeyManagementException,
                                                                 java.security.UnrecoverableKeyException,
                                                                 java.security.NoSuchProviderException

Throws:

java.security.KeyStoreException

java.io.IOException

java.security.NoSuchAlgorithmException

java.security.cert.CertificateException

java.security.KeyManagementException

java.security.UnrecoverableKeyException

java.security.NoSuchProviderException

httpClientFactory

protected org.apache.http.impl.client.CloseableHttpClient httpClientFactory()
                                                                     throws CannotInitializeDataAdapterException

Throws:

CannotInitializeDataAdapterException

craftRequestUri

protected java.net.URI craftRequestUri(java.lang.String path,
                                       java.util.List<org.apache.http.NameValuePair> params)
                                throws SourceCommunicationException

Throws:

SourceCommunicationException

craftRequestUri

protected java.net.URI craftRequestUri(java.lang.String path,
                                       org.apache.http.NameValuePair... params)
                                throws SourceCommunicationException

Throws:

SourceCommunicationException

craftFetchUri

protected abstract java.net.URI craftFetchUri(java.lang.String path,
                                              java.time.Instant begin,
                                              java.time.Instant end)
                                       throws DataAdapterException

Throws:

DataAdapterException

getBaseAddress

public java.net.URL getBaseAddress()

Returns the source's base address

Returns:

the source's base address

setBaseAddress

public void setBaseAddress(java.net.URL baseAddress)

Sets the source's base address

Parameters:

baseAddress - the source's base address