com.supermap.services.providers

Class RestProviderBase

java.lang.Object

com.supermap.services.providers.RestProviderBase

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

RestAddressMatchProvider, RestDataProvider, RestMapProvider, RestRealspaceProvider, RestSpatialAnalystProvider, RestTrafficTransferAnalystProvider, RestTransportationAnalystProvider

public abstract class RestProviderBase
extends java.lang.Object
implements Disposable

A provider base class based on the iServer Rest service

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestProviderBase.CacheModel The cache mode.
protected static class	RestProviderBase.RestRequestException

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	JAVA_POSTFIX
protected static JavaStreamConverter	javaConverter
protected static java.lang.String	JSON_POSTFIX
protected JsonConverter	jsonConverter
protected static JsonDecoder	jsonDecoder
static java.util.concurrent.locks.ReentrantLock	lock
protected static LocLogger	logger
protected static ResourceManager	message

Constructor Summary

Constructors

Constructor and Description
RestProviderBase() The Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache() Clear the cache.
void	dispose() Release the resource object.
protected <T> T	executeRequest(Request request, java.lang.Class<T> clz) Execute the request and return the object.
protected <T> T	executeRequest(Request request, java.lang.Class<T> clz, boolean useCache) Execute the request and return the object.
protected <T> T	executeRequest(Request request, java.lang.Class<T> clz, RestProviderBase.CacheModel cacheModel) Execute the request and return the object.
protected byte[]	executeRequestForByteArray(Request request) Execute the request and return the byte array.
protected byte[]	executeRequestForByteArray(Request request, boolean useCache) Execute the request and return the byte array.
protected byte[]	executeRequestForByteArray(Request request, RestProviderBase.CacheModel cacheModel) Execute the request and return the byte array.
protected byte[]	executeRequestForByteArray(Request request, RestProviderBase.CacheModel cacheModel, Client restMapClient)
protected <T> java.util.List<T>	executeRequestForList(Request request, java.lang.Class<T> clz) Execute the request to return the array.
protected <T> java.util.List<T>	executeRequestForList(Request request, java.lang.Class<T> clz, boolean useCache) Execute the request to return the array.
protected <T> java.util.List<T>	executeRequestForList(Request request, java.lang.Class<T> clz, RestProviderBase.CacheModel cacheModel) Execute the request to return the array.
protected <T> java.util.List<T>	executeRequestForList(Request request, java.lang.Class<T> clz, RestProviderBase.CacheModel cacheModel, Client restMapClient)
protected java.io.InputStream	executeRequestForStream(Request request) Execute the request and return the Stream.
protected java.io.InputStream	executeRequestForStream(Request request, boolean useCache) Execute the request and return the Stream.
protected java.io.InputStream	executeRequestForStream(Request request, RestProviderBase.CacheModel cacheModel) Execute the request and return the Stream.
protected java.lang.String	executeRequestForText(Request request) Execute the request and return the string.
protected java.lang.String	executeRequestForText(Request request, boolean useCache) Execute the request and return the string.
protected java.lang.String	executeRequestForText(Request request, RestProviderBase.CacheModel cacheModel) Execute the request and return the string.
protected abstract RestProviderSetting	getRestProviderSetting() Return the rest service provider configuration information.
void	handleExeption(RestProviderBase.RestRequestException ex)
protected void	init(RestProviderSetting setting) Initialize the object according to RestProvider Setting.
protected Client	newAndSetClient(Client nclient, java.lang.String socketTimeout)
protected java.lang.String	rectifyRestServiceRootURL(java.lang.String restUrl) Correct the REST URL, remove the "/" at the end of the URL.

Methods inherited from class java.lang.Object

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

Field Detail

lock

public static final java.util.concurrent.locks.ReentrantLock lock

message

protected static final ResourceManager message

logger

protected static final LocLogger logger

javaConverter

protected static final JavaStreamConverter javaConverter

jsonDecoder

protected static final JsonDecoder jsonDecoder

JSON_POSTFIX

protected static final java.lang.String JSON_POSTFIX

JAVA_POSTFIX

protected static final java.lang.String JAVA_POSTFIX

jsonConverter

protected final JsonConverter jsonConverter

Constructor Detail

RestProviderBase

public RestProviderBase()

The Constructor.

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Release the resource object.

Specified by:

dispose in interface Disposable

clearCache

public void clearCache()

Clear the cache.

init

protected void init(RestProviderSetting setting)

Initialize the object according to RestProvider Setting.

Parameters:

setting -

executeRequestForText

protected java.lang.String executeRequestForText(Request request)
                                          throws RestProviderBase.RestRequestException

Execute the request and return the string.

Parameters:

request - request.

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForText

protected java.lang.String executeRequestForText(Request request,
                                     boolean useCache)
                                          throws RestProviderBase.RestRequestException

Execute the request and return the string.

Parameters:

request - request.

useCache - Whether to use caching.

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForText

protected java.lang.String executeRequestForText(Request request,
                                     RestProviderBase.CacheModel cacheModel)
                                          throws RestProviderBase.RestRequestException

Execute the request and return the string.

Parameters:

request - request.

cacheModel - Cache mode.

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequest

protected <T> T executeRequest(Request request,
                   java.lang.Class<T> clz)
                    throws RestProviderBase.RestRequestException

Execute the request and return the object.

Parameters:

request - request.

clz - Object type.

Returns:

Throws:

JSONException

RestProviderBase.RestRequestException

executeRequest

protected <T> T executeRequest(Request request,
                   java.lang.Class<T> clz,
                   boolean useCache)
                    throws RestProviderBase.RestRequestException

Execute the request and return the object.

Parameters:

request - request.

clz - Object type.

useCache - cache.

Returns:

Throws:

JSONException

RestProviderBase.RestRequestException

executeRequest

protected <T> T executeRequest(Request request,
                   java.lang.Class<T> clz,
                   RestProviderBase.CacheModel cacheModel)
                    throws RestProviderBase.RestRequestException

Execute the request and return the object.

Parameters:

request - request.

clz - Object type.

cacheModel - Cache mode.

Returns:

Throws:

RestProviderBase.RestRequestException

JSONException

executeRequestForByteArray

protected byte[] executeRequestForByteArray(Request request)
                                     throws RestProviderBase.RestRequestException

Execute the request and return the byte array.

Parameters:

request - request.

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForByteArray

protected byte[] executeRequestForByteArray(Request request,
                                boolean useCache)
                                     throws RestProviderBase.RestRequestException

Execute the request and return the byte array.

Parameters:

request - request.

useCache - Whether to use caching.

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForByteArray

protected byte[] executeRequestForByteArray(Request request,
                                RestProviderBase.CacheModel cacheModel)
                                     throws RestProviderBase.RestRequestException

Execute the request and return the byte array.

Parameters:

request - request.

cacheModel - Cache mode.

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForByteArray

protected byte[] executeRequestForByteArray(Request request,
                                RestProviderBase.CacheModel cacheModel,
                                Client restMapClient)
                                     throws RestProviderBase.RestRequestException

Parameters:

request -

cacheModel -

restMapClient - The client used by RestMapProvider

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForList

protected <T> java.util.List<T> executeRequestForList(Request request,
                                          java.lang.Class<T> clz)
                                           throws RestProviderBase.RestRequestException

Execute the request to return the array.

Parameters:

request - request.

clz - Object type.

Returns:

Throws:

JSONException

RestProviderBase.RestRequestException

executeRequestForList

protected <T> java.util.List<T> executeRequestForList(Request request,
                                          java.lang.Class<T> clz,
                                          boolean useCache)
                                           throws RestProviderBase.RestRequestException

Execute the request to return the array.

Parameters:

request - request.

clz - Object type.

useCache - Whether to use caching.

Returns:

Throws:

JSONException

RestProviderBase.RestRequestException

executeRequestForList

protected <T> java.util.List<T> executeRequestForList(Request request,
                                          java.lang.Class<T> clz,
                                          RestProviderBase.CacheModel cacheModel)
                                           throws RestProviderBase.RestRequestException

Execute the request to return the array.

Parameters:

request - request.

clz - Object type.

cacheModel - Cache mode.

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForList

protected <T> java.util.List<T> executeRequestForList(Request request,
                                          java.lang.Class<T> clz,
                                          RestProviderBase.CacheModel cacheModel,
                                          Client restMapClient)
                                           throws RestProviderBase.RestRequestException

Parameters:

request -

clz -

cacheModel -

restMapClient - The client used by RestMapProvider

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForStream

protected java.io.InputStream executeRequestForStream(Request request)
                                               throws RestProviderBase.RestRequestException

Execute the request and return the Stream.

Parameters:

request - request.

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForStream

protected java.io.InputStream executeRequestForStream(Request request,
                                          boolean useCache)
                                               throws RestProviderBase.RestRequestException

Execute the request and return the Stream.

Parameters:

request - request.

useCache - Whether to use caching.

Returns:

Throws:

RestProviderBase.RestRequestException

executeRequestForStream

protected java.io.InputStream executeRequestForStream(Request request,
                                          RestProviderBase.CacheModel cacheModel)
                                               throws RestProviderBase.RestRequestException

Execute the request and return the Stream.

Parameters:

request - request.

cacheModel - Cache mode.

Returns:

Throws:

RestProviderBase.RestRequestException

rectifyRestServiceRootURL

protected java.lang.String rectifyRestServiceRootURL(java.lang.String restUrl)

Correct the REST URL, remove the "/" at the end of the URL.

Parameters:

restUrl -

Returns:

getRestProviderSetting

protected abstract RestProviderSetting getRestProviderSetting()

Return the rest service provider configuration information.

Returns:

newAndSetClient

protected Client newAndSetClient(Client nclient,
                     java.lang.String socketTimeout)

handleExeption

public void handleExeption(RestProviderBase.RestRequestException ex)