com.aspc.remote.rest.internal

Class RestCall

java.lang.Object

com.aspc.remote.rest.internal.RestCall

All Implemented Interfaces:

java.util.concurrent.Callable<Response>

Direct Known Subclasses:

RestCallHTTP, RestCallLocal

public abstract class RestCall
extends java.lang.Object
implements java.util.concurrent.Callable<Response>

Since:

20 March 2015

Author:

Lei Gao

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	agent
protected java.io.File	body
protected ContentType	contentType
protected boolean	disableGZIP
protected DispositionType	dispositionType
ReSTTask	fjt
protected Friend	friend
static java.lang.String	HEADER_LOCATION
protected Method	method
protected ReSTPlugin	plugin
protected java.io.File	propertiesFile
int	timeoutMS
protected java.net.URL	url

Constructor Summary

Constructors

Constructor and Description
RestCall(Method method, java.net.URL url, ReSTPlugin plugin, java.lang.String agent, java.io.File propertiesFile, java.io.File body, int timeoutMS, boolean disableGZIP, Friend friend, ContentType contentType, DispositionType dispositionType) The ReST call.

Method Summary

Modifier and Type	Method and Description
Response	call() Make the call
protected abstract Response	doCall() Make the call
java.io.File	getBody()
Method	getMethod()
java.lang.String	getURL()
protected void	mantainFileHistory(java.util.Properties p, java.io.File cacheFile)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_LOCATION

public static final java.lang.String HEADER_LOCATION

See Also:

Constant Field Values

fjt

public ReSTTask fjt

propertiesFile

protected final java.io.File propertiesFile

body

protected final java.io.File body

method

protected final Method method

url

protected final java.net.URL url

agent

protected final java.lang.String agent

plugin

protected final ReSTPlugin plugin

timeoutMS

public final int timeoutMS

friend

protected final Friend friend

disableGZIP

protected final boolean disableGZIP

contentType

protected final ContentType contentType

dispositionType

protected final DispositionType dispositionType

Constructor Detail

RestCall

public RestCall(@Nonnull
                Method method,
                @Nonnull
                java.net.URL url,
                @Nullable
                ReSTPlugin plugin,
                @Nullable
                java.lang.String agent,
                @Nullable
                java.io.File propertiesFile,
                @Nullable
                java.io.File body,
                @Nonnegative
                int timeoutMS,
                boolean disableGZIP,
                @Nullable
                Friend friend,
                @Nullable
                ContentType contentType,
                @Nullable
                DispositionType dispositionType)

The ReST call.

Parameters:

method - the method

url - the URL.

plugin - any authorization.

agent - the agent string to use.

propertiesFile - the properties file

body - the call body

timeoutMS - the timeout in milliseconds ( if any)

disableGZIP - true to NOT accept GZIP encoding, default is false

friend - the friend

contentType - the content type

dispositionType - the disposition type

Method Detail

getURL

@CheckReturnValue
 @Nonnull
public java.lang.String getURL()

getMethod

@CheckReturnValue
 @Nonnull
public Method getMethod()

getBody

public java.io.File getBody()

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

call

@CheckReturnValue
 @Nonnull
public Response call()
                                          throws java.lang.Exception

Make the call

Specified by:

call in interface java.util.concurrent.Callable<Response>

Returns:

the response

Throws:

java.lang.Exception - a serious problem.

doCall

@CheckReturnValue
 @Nonnull
protected abstract Response doCall()
                                                        throws java.lang.Exception

Make the call

Returns:

the response

Throws:

java.lang.Exception - a serious problem.

mantainFileHistory

protected void mantainFileHistory(@Nonnull
                                  java.util.Properties p,
                                  @Nonnull
                                  java.io.File cacheFile)
                           throws java.io.IOException

Throws:

java.io.IOException