co.codewizards.cloudstore.rest.client.request

Class GetFileData

java.lang.Object

co.codewizards.cloudstore.rest.client.request.AbstractRequest<byte[]>

co.codewizards.cloudstore.rest.client.request.GetFileData

All Implemented Interfaces:

Request<byte[]>

public class GetFileData
extends AbstractRequest<byte[]>

Constructor Summary

Constructors

Constructor and Description
GetFileData(String repositoryName, String path, long offset, int length)

Method Summary

Modifier and Type	Method and Description
byte[]	execute() Execute the actual request.
boolean	isResultNullable() Indicates, if the result of the invocation can be null.

Methods inherited from class co.codewizards.cloudstore.rest.client.request.AbstractRequest

assertResponseIndicatesSuccess, assignCredentials, createWebTarget, encodePath, getBaseURL, getClientOrFail, getCloudStoreRestClient, getCloudStoreRestClientOrFail, getPath, setCloudStoreRestClient, throwOriginalExceptionIfPossible, urlEncode

Methods inherited from class java.lang.Object

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

Constructor Detail

GetFileData

public GetFileData(String repositoryName,
                   String path,
                   long offset,
                   int length)

Method Detail

execute

public byte[] execute()

Description copied from interface: Request

Execute the actual request.

Important: You should never invoke this method directly! Instead, pass the Request to CloudStoreRestClient.execute(Request).

Returns:

the response from the server. May be null. Depending on Request.isResultNullable() a null result is considered an error and causes an exception.

isResultNullable

public boolean isResultNullable()

Description copied from interface: Request

Indicates, if the result of the invocation can be null.

If the server must send a response, i.e. the invocation must not return empty-handed, this should be false. In case, the server still does not send a reply, it is considered an error causing an exception.

Please note: If a request never returns a response (like a Java void method), it is recommended that you sub-class VoidRequest.

Returns:

true if null as response is allowed; false otherwise.