org.nuxeo.client.objects

Class Document.AbstractAdapter<A extends Document.AbstractAdapter<A>>

java.lang.Object

org.nuxeo.client.objects.AbstractBase<B>

org.nuxeo.client.objects.AbstractConnectable<RepositoryAPI,A>

org.nuxeo.client.objects.Document.AbstractAdapter<A>

Type Parameters:

A - The type of object extending this one.

All Implemented Interfaces:

Connectable

Direct Known Subclasses:

AnnotationAdapter, CommentAdapter, Document.Adapter

Enclosing class:

Document

public abstract static class Document.AbstractAdapter<A extends Document.AbstractAdapter<A>>
extends AbstractConnectable<RepositoryAPI,A>

Adapter is basic class to handle requests against web adapters.

Since:

3.2

Field Summary

Fields

Modifier and Type	Field and Description
protected String	adapter
protected String	documentId
protected String	repositoryName

Fields inherited from class org.nuxeo.client.objects.AbstractConnectable

api, apiClass, nuxeoClient

Fields inherited from class org.nuxeo.client.objects.AbstractBase

headerInterceptors, headerValues, okhttpBuilder, retrofit, retrofitBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractAdapter(Document document, String adapter)
protected	AbstractAdapter(NuxeoClient nuxeoClient, String repositoryName, String documentId, String adapter)

Method Summary

Modifier and Type	Method and Description
void	delete() Sends a DELETE request directly on adapter url.
void	delete(Map<String,Serializable> queryParams) Sends a DELETE request directly on adapter url and filled with query parameters.
void	delete(String pathSuffix) Sends a DELETE request on adapter url suffixed by given input.
void	delete(String pathSuffix, Map<String,Serializable> queryParams) Sends a DELETE request on adapter url suffixed by given input and filled with query parameters.
<O> O	get() Sends a GET request directly on adapter url.
<O> O	get(Map<String,Serializable> queryParams) Sends a GET request directly on adapter url and filled with query parameters.
<O> O	get(String pathSuffix) Sends a GET request on adapter url suffixed by given input.
<O> O	get(String pathSuffix, Map<String,Serializable> queryParams) Sends a GET request on adapter url suffixed by given input and filled with query parameters.
String	getDocumentId()
<O> O	post(Map<String,Serializable> queryParams, O object) Sends a POST request directly on adapter url and filled with query parameters.
<O> O	post(O object) Sends a POST request directly on adapter url.
<O> O	post(String pathSuffix, Map<String,Serializable> queryParams, O object) Sends a POST request on adapter url suffixed by given input and filled with query parameters.
<O> O	post(String pathSuffix, O object) Sends a POST request on adapter url suffixed by given input.
<O> O	put(Map<String,Serializable> queryParams, O object) Sends a PUT request directly on adapter url and filled with query parameters.
<O> O	put(O object) Sends a PUT request directly on adapter url.
<O> O	put(String pathSuffix, Map<String,Serializable> queryParams, O object) Sends a PUT request on adapter url suffixed by given input and filled with query parameters.
<O> O	put(String pathSuffix, O object) Sends a PUT request on adapter url suffixed by given input.

Methods inherited from class org.nuxeo.client.objects.AbstractConnectable

buildRetrofit, fetchResponse, fetchResponse, reconnectWith

Methods inherited from class org.nuxeo.client.objects.AbstractBase

connectTimeout, depth, enrichers, enrichers, enrichersForDocument, fetchProperties, fetchProperties, fetchPropertiesForDocument, fetchPropertiesForGroup, header, header, header, header, header, header, header, readTimeout, replaceWith, schemas, schemas, timeout, transactionTimeout, version

Methods inherited from class java.lang.Object

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

Field Detail

repositoryName

protected final String repositoryName

documentId

protected final String documentId

adapter

protected final String adapter

Constructor Detail

AbstractAdapter

protected AbstractAdapter(NuxeoClient nuxeoClient,
                          String repositoryName,
                          String documentId,
                          String adapter)

AbstractAdapter

public AbstractAdapter(Document document,
                       String adapter)

Method Detail

getDocumentId

public String getDocumentId()

Returns:

the document id on which this adapter has been created

get

public <O> O get()

Sends a GET request directly on adapter url.

Since:

3.2

get

public <O> O get(String pathSuffix)

Sends a GET request on adapter url suffixed by given input.

Parameters:

pathSuffix - the path to append to the end of hit adapter

Since:

3.2

get

public <O> O get(Map<String,Serializable> queryParams)

Sends a GET request directly on adapter url and filled with query parameters.

Parameters:

queryParams - the query parameters to append to url

Since:

3.2

get

public <O> O get(String pathSuffix,
                 Map<String,Serializable> queryParams)

Sends a GET request on adapter url suffixed by given input and filled with query parameters.

Parameters:

pathSuffix - the path to append to the end of hit adapter

queryParams - the query parameters to append to url

Since:

3.2

post

public <O> O post(O object)

Sends a POST request directly on adapter url.

Parameters:

object - the object to send as body

Since:

3.2

post

public <O> O post(String pathSuffix,
                  O object)

Sends a POST request on adapter url suffixed by given input.

Parameters:

pathSuffix - the path to append to the end of hit adapter

object - the object to send as body

Since:

3.2

post

public <O> O post(Map<String,Serializable> queryParams,
                  O object)

Sends a POST request directly on adapter url and filled with query parameters.

Parameters:

queryParams - the query parameters to append to url

object - the object to send as body

Since:

3.2

post

public <O> O post(String pathSuffix,
                  Map<String,Serializable> queryParams,
                  O object)

Sends a POST request on adapter url suffixed by given input and filled with query parameters.

Parameters:

pathSuffix - the path to append to the end of hit adapter

queryParams - the query parameters to append to url

object - the object to send as body

Since:

3.2

put

public <O> O put(O object)

Sends a PUT request directly on adapter url.

Parameters:

object - the object to send as body

Since:

3.2

put

public <O> O put(String pathSuffix,
                 O object)

Sends a PUT request on adapter url suffixed by given input.

Parameters:

pathSuffix - the path to append to the end of hit adapter

object - the object to send as body

Since:

3.2

put

public <O> O put(Map<String,Serializable> queryParams,
                 O object)

Sends a PUT request directly on adapter url and filled with query parameters.

Parameters:

queryParams - the query parameters to append to url

object - the object to send as body

Since:

3.2

put

public <O> O put(String pathSuffix,
                 Map<String,Serializable> queryParams,
                 O object)

Sends a PUT request on adapter url suffixed by given input and filled with query parameters.

Parameters:

pathSuffix - the path to append to the end of hit adapter

queryParams - the query parameters to append to url

object - the object to send as body

Since:

3.2

delete

public void delete()

Sends a DELETE request directly on adapter url.

Since:

3.2

delete

public void delete(String pathSuffix)

Sends a DELETE request on adapter url suffixed by given input.

Parameters:

pathSuffix - the path to append to the end of hit adapter

Since:

3.2

delete

public void delete(Map<String,Serializable> queryParams)

Sends a DELETE request directly on adapter url and filled with query parameters.

Parameters:

queryParams - the query parameters to append to url

Since:

3.2

delete

public void delete(String pathSuffix,
                   Map<String,Serializable> queryParams)

Sends a DELETE request on adapter url suffixed by given input and filled with query parameters.

Parameters:

pathSuffix - the path to append to the end of hit adapter

queryParams - the query parameters to append to url

Since:

3.2