co.codewizards.cloudstore.rest.client.request

Class VoidRequest

java.lang.Object

co.codewizards.cloudstore.rest.client.request.AbstractRequest<Void>

co.codewizards.cloudstore.rest.client.request.VoidRequest

All Implemented Interfaces:

Request<Void>

Direct Known Subclasses:

BeginPutFile, Copy, Delete, EndPutFile, EndSyncFromRepository, EndSyncToRepository, MakeDirectory, MakeSymlink, Move, PutFileData, PutParentConfigPropSetDto, RequestRepoConnection

public abstract class VoidRequest
extends AbstractRequest<Void>

Abstract base class for REST requests never returning a response.

Author:

Marco หงุ่ยตระกูล-Schulze - marco at codewizards dot co

Constructor Summary

Constructors

Constructor and Description
VoidRequest()

Method Summary

Modifier and Type	Method and Description
protected abstract javax.ws.rs.core.Response	_execute() REST requests without response should implement this delegate method instead of execute().
Void	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

VoidRequest

public VoidRequest()

Method Detail

execute

public final Void 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.

_execute

protected abstract javax.ws.rs.core.Response _execute()

REST requests without response should implement this delegate method instead of execute().

Returns:

the response object returned from SyncInvoker.put(javax.ws.rs.client.Entity) or a similar method.

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.