com.marklogic.client.extensions

Interface ResourceServices

public interface ResourceServices

A ResourceServices object supports calling the services for a resource. The Resource Services extension must have been installed on the server previously, which can be done with ResourceExtensionsManager. A ResourceManager object receives a ResourceServices object when it is initialized by the DatabaseClient.init() method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ResourceServices.ServiceResult ServiceResult provides one content response from a service.
static interface	ResourceServices.ServiceResultIterator ServiceResultIterator provides an iterator over content responses from the server.

Method Summary

Modifier and Type	Method and Description
<R extends AbstractReadHandle> R	delete(RequestParameters params, R output) Deletes content by calling a DELETE service.
<R extends AbstractReadHandle> R	delete(RequestParameters params, Transaction transaction, R output) Deletes content by calling a DELETE service.
<R extends AbstractReadHandle> R	get(RequestParameters params, R output) Reads resource content by calling a GET service.
ResourceServices.ServiceResultIterator	get(RequestParameters params, String... mimetypes) Reads multiple resource content by calling a GET service.
<R extends AbstractReadHandle> R	get(RequestParameters params, Transaction transaction, R output) Reads resource content by calling a GET service.
ResourceServices.ServiceResultIterator	get(RequestParameters params, Transaction transaction, String... mimetypes) Reads multiple resource content by calling a GET service.
RequestLogger	getRequestLogger() Returns the logger for debugging client requests.
String	getResourceName() Returns the name of the resource.
<R extends AbstractReadHandle> R	post(RequestParameters params, AbstractWriteHandle input, R output) Applies content by calling a POST service.
ResourceServices.ServiceResultIterator	post(RequestParameters params, AbstractWriteHandle input, String... mimetypes) Applies multiple content by calling a POST service.
<R extends AbstractReadHandle> R	post(RequestParameters params, AbstractWriteHandle input, Transaction transaction, R output) Applies content by calling a POST service.
ResourceServices.ServiceResultIterator	post(RequestParameters params, AbstractWriteHandle input, Transaction transaction, String... mimetypes) Applies multiple content by calling a POST service.
<R extends AbstractReadHandle,W extends AbstractWriteHandle> R	post(RequestParameters params, W[] input, R output) Applies content by calling a POST service.
<W extends AbstractWriteHandle> ResourceServices.ServiceResultIterator	post(RequestParameters params, W[] input, String... mimetypes) Applies multiple content by calling a POST service.
<R extends AbstractReadHandle,W extends AbstractWriteHandle> R	post(RequestParameters params, W[] input, Transaction transaction, R output) Applies content by calling a POST service.
<W extends AbstractWriteHandle> ResourceServices.ServiceResultIterator	post(RequestParameters params, W[] input, Transaction transaction, String... mimetypes) Applies multiple content by calling a POST service.
<R extends AbstractReadHandle> R	put(RequestParameters params, AbstractWriteHandle input, R output) Writes content by calling a PUT service.
<R extends AbstractReadHandle> R	put(RequestParameters params, AbstractWriteHandle input, Transaction transaction, R output) Writes content by calling a PUT service.
<R extends AbstractReadHandle,W extends AbstractWriteHandle> R	put(RequestParameters params, W[] input, R output) Writes multiple content by calling a PUT service.
<R extends AbstractReadHandle,W extends AbstractWriteHandle> R	put(RequestParameters params, W[] input, Transaction transaction, R output) Writes multiple content by calling a PUT service.
void	startLogging(RequestLogger logger) Starts debugging client requests.
void	stopLogging() Stops debugging client requests.

Method Detail

getResourceName

String getResourceName()

Returns the name of the resource.

Returns:

the resource name

get

<R extends AbstractReadHandle> R get(RequestParameters params,
                                     R output)

Reads resource content by calling a GET service.

Type Parameters:

R - the type of AbstractReadHandle to return

Parameters:

params - the parameters for the call

output - a handle on the content returned by the call

Returns:

the content handle

get

<R extends AbstractReadHandle> R get(RequestParameters params,
                                     Transaction transaction,
                                     R output)

Reads resource content by calling a GET service.

Type Parameters:

R - the type of AbstractReadHandle to return

Parameters:

params - the parameters for the call

transaction - the transaction for reading content

output - a handle on the content returned by the call

Returns:

the content handle

get

ResourceServices.ServiceResultIterator get(RequestParameters params,
                                           String... mimetypes)

Reads multiple resource content by calling a GET service.

Parameters:

params - the parameters for the call

mimetypes - the mimetypes for the requested content

Returns:

an iterator over the requested content

get

ResourceServices.ServiceResultIterator get(RequestParameters params,
                                           Transaction transaction,
                                           String... mimetypes)

Reads multiple resource content by calling a GET service.

Parameters:

params - the parameters for the call

transaction - the transaction for reading content

mimetypes - the mimetypes for the requested content

Returns:

an iterator over the requested content

put

<R extends AbstractReadHandle> R put(RequestParameters params,
                                     AbstractWriteHandle input,
                                     R output)

Writes content by calling a PUT service.

Type Parameters:

R - the type of AbstractReadHandle to return

Parameters:

params - the parameters for the call

input - the content passed with the call

output - a handle on the content response from the call

Returns:

the content handle for the response

put

<R extends AbstractReadHandle> R put(RequestParameters params,
                                     AbstractWriteHandle input,
                                     Transaction transaction,
                                     R output)

Writes content by calling a PUT service.

Type Parameters:

R - the type of AbstractReadHandle to return

Parameters:

params - the parameters for the call

input - the content passed with the call

transaction - the transaction for writing content

output - a handle on the content response from the call

Returns:

the content handle for the response

put

<R extends AbstractReadHandle,W extends AbstractWriteHandle> R put(RequestParameters params,
                                                                   W[] input,
                                                                   R output)

Writes multiple content by calling a PUT service.

Type Parameters:

R - the type of AbstractReadHandle to return

W - the type of AbstractWriteHandle's with content to send

Parameters:

params - the parameters for the call

input - an array of content passed with the call

output - a handle on the content response from the call

Returns:

the content handle for the response

put

<R extends AbstractReadHandle,W extends AbstractWriteHandle> R put(RequestParameters params,
                                                                   W[] input,
                                                                   Transaction transaction,
                                                                   R output)

Writes multiple content by calling a PUT service.

Type Parameters:

R - the type of AbstractReadHandle to return

W - the type of AbstractWriteHandle's with content to send

Parameters:

params - the parameters for the call

input - an array of content passed with the call

transaction - the transaction for writing content

output - a handle on the content response from the call

Returns:

the content handle for the response

post

<R extends AbstractReadHandle> R post(RequestParameters params,
                                      AbstractWriteHandle input,
                                      R output)

Applies content by calling a POST service.

Type Parameters:

R - the type of AbstractReadHandle to return

Parameters:

params - the parameters for the call

input - the content passed with the call

output - a handle on the content response from the call

Returns:

the content handle for the response

post

<R extends AbstractReadHandle> R post(RequestParameters params,
                                      AbstractWriteHandle input,
                                      Transaction transaction,
                                      R output)

Applies content by calling a POST service.

Type Parameters:

R - the type of AbstractReadHandle to return

Parameters:

params - the parameters for the call

input - the content passed with the call

transaction - the transaction for applying content

output - a handle on the content response from the call

Returns:

the content handle for the response

post

<R extends AbstractReadHandle,W extends AbstractWriteHandle> R post(RequestParameters params,
                                                                    W[] input,
                                                                    R output)

Applies content by calling a POST service.

Type Parameters:

R - the type of AbstractReadHandle to return

W - the type of AbstractWriteHandle's with content to send

Parameters:

params - the parameters for the call

input - an array of content passed with the call

output - a handle on the content response from the call

Returns:

the content handle for the response

post

<R extends AbstractReadHandle,W extends AbstractWriteHandle> R post(RequestParameters params,
                                                                    W[] input,
                                                                    Transaction transaction,
                                                                    R output)

Applies content by calling a POST service.

Type Parameters:

R - the type of AbstractReadHandle to return

W - the type of AbstractWriteHandle's with content to send

Parameters:

params - the parameters for the call

input - an array of content passed with the call

transaction - the transaction for applying content

output - a handle on the content response from the call

Returns:

the content handle for the response

post

ResourceServices.ServiceResultIterator post(RequestParameters params,
                                            AbstractWriteHandle input,
                                            String... mimetypes)

Applies multiple content by calling a POST service.

Parameters:

params - the parameters for the call

input - the content passed with the call

mimetypes - the mimetypes for the requested content

Returns:

an iterator over the requested content

post

ResourceServices.ServiceResultIterator post(RequestParameters params,
                                            AbstractWriteHandle input,
                                            Transaction transaction,
                                            String... mimetypes)

Applies multiple content by calling a POST service.

Parameters:

params - the parameters for the call

input - the content passed with the call

transaction - the transaction for applying content

mimetypes - the mimetypes for the requested content

Returns:

an iterator over the requested content

post

<W extends AbstractWriteHandle> ResourceServices.ServiceResultIterator post(RequestParameters params,
                                                                            W[] input,
                                                                            String... mimetypes)

Applies multiple content by calling a POST service.

Type Parameters:

W - the type of AbstractWriteHandle's with content to send

Parameters:

params - the parameters for the call

input - an array of content passed with the call

mimetypes - the mimetypes for the requested content

Returns:

an iterator over the requested content

post

<W extends AbstractWriteHandle> ResourceServices.ServiceResultIterator post(RequestParameters params,
                                                                            W[] input,
                                                                            Transaction transaction,
                                                                            String... mimetypes)

Applies multiple content by calling a POST service.

Type Parameters:

W - the type of AbstractWriteHandle's with content to send

Parameters:

params - the parameters for the call

input - an array of content passed with the call

transaction - the transaction for applying content

mimetypes - the mimetypes for the requested content

Returns:

an iterator over the requested content

delete

<R extends AbstractReadHandle> R delete(RequestParameters params,
                                        R output)

Deletes content by calling a DELETE service.

Type Parameters:

R - the type of AbstractReadHandle to return

Parameters:

params - the parameters for the call

output - a handle on the content response from the call

Returns:

the content handle for the response

delete

<R extends AbstractReadHandle> R delete(RequestParameters params,
                                        Transaction transaction,
                                        R output)

Deletes content by calling a DELETE service.

Type Parameters:

R - the type of AbstractReadHandle to return

Parameters:

params - the parameters for the call

transaction - the transaction for applying content

output - a handle on the content response from the call

Returns:

the content handle for the response

startLogging

void startLogging(RequestLogger logger)

Starts debugging client requests. You can suspend and resume debugging output using the methods of the logger.

Parameters:

logger - the logger that receives debugging output

getRequestLogger

RequestLogger getRequestLogger()

Returns the logger for debugging client requests.

Returns:

the request logger

stopLogging

void stopLogging()

Stops debugging client requests.