Package 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	Description
protected java.lang.String	adapter
protected java.lang.String	documentId
protected java.lang.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	Description
protected	AbstractAdapter(NuxeoClient nuxeoClient, java.lang.String repositoryName, java.lang.String documentId, java.lang.String adapter)
	AbstractAdapter(Document document, java.lang.String adapter)

Method Summary

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

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, retryOnConnectionFailure, schemas, schemas, timeout, transactionTimeout, version, writeTimeout

Methods inherited from class java.lang.Object

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

Field Detail

repositoryName

protected final java.lang.String repositoryName

documentId

protected final java.lang.String documentId

adapter

protected final java.lang.String adapter

Constructor Detail

AbstractAdapter

protected AbstractAdapter(NuxeoClient nuxeoClient,
                          java.lang.String repositoryName,
                          java.lang.String documentId,
                          java.lang.String adapter)

AbstractAdapter

public AbstractAdapter(Document document,
                       java.lang.String adapter)

Method Detail

getDocumentId

public java.lang.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(java.lang.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(java.util.Map<java.lang.String,java.io.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(java.lang.String pathSuffix,
                 java.util.Map<java.lang.String,java.io.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(java.lang.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(java.util.Map<java.lang.String,java.io.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(java.lang.String pathSuffix,
                  java.util.Map<java.lang.String,java.io.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(java.lang.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(java.util.Map<java.lang.String,java.io.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(java.lang.String pathSuffix,
                 java.util.Map<java.lang.String,java.io.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(java.lang.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(java.util.Map<java.lang.String,java.io.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(java.lang.String pathSuffix,
                   java.util.Map<java.lang.String,java.io.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