Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2012-2015 MarkLogic Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.marklogic.client.extensions;
import java.util.Iterator;
import com.marklogic.client.admin.ExtensionMetadata;
import com.marklogic.client.io.Format;
import com.marklogic.client.util.RequestLogger;
import com.marklogic.client.util.RequestParameters;
import com.marklogic.client.Transaction;
import com.marklogic.client.io.marker.AbstractReadHandle;
import com.marklogic.client.io.marker.AbstractWriteHandle;
/**
* 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
* {@link com.marklogic.client.admin.ResourceExtensionsManager}.
* A {@link ResourceManager} object
* receives a ResourceServices object when it is initialized by the
* {@link com.marklogic.client.DatabaseClient}.init() method.
*/
public interface ResourceServices {
/**
* Returns the name of the resource.
* @return the resource name
*/
public String getResourceName();
/**
* Reads resource content by calling a GET service.
* @param params the parameters for the call
* @param output a handle on the content returned by the call
* @return the content handle
*/
public R get(RequestParameters params, R output);
/**
* Reads resource content by calling a GET service.
* @param params the parameters for the call
* @param transaction the transaction for reading content
* @param output a handle on the content returned by the call
* @return the content handle
*/
public R get(RequestParameters params, Transaction transaction, R output);
/**
* Reads multiple resource content by calling a GET service.
* @param params the parameters for the call
* @param mimetypes the mimetypes for the requested content
* @return an iterator over the requested content
*/
public ServiceResultIterator get(RequestParameters params, String... mimetypes);
/**
* Reads multiple resource content by calling a GET service.
* @param params the parameters for the call
* @param transaction the transaction for reading content
* @param mimetypes the mimetypes for the requested content
* @return an iterator over the requested content
*/
public ServiceResultIterator get(RequestParameters params, Transaction transaction, String... mimetypes);
/**
* Writes content by calling a PUT service.
* @param params the parameters for the call
* @param input the content passed with the call
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R put(RequestParameters params, AbstractWriteHandle input, R output);
/**
* Writes content by calling a PUT service.
* @param params the parameters for the call
* @param input the content passed with the call
* @param transaction the transaction for writing content
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R put(RequestParameters params, AbstractWriteHandle input, Transaction transaction, R output);
/**
* Writes multiple content by calling a PUT service.
* @param params the parameters for the call
* @param input an array of content passed with the call
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R put(RequestParameters params, W[] input, R output);
/**
* Writes multiple content by calling a PUT service.
* @param params the parameters for the call
* @param input an array of content passed with the call
* @param transaction the transaction for writing content
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R put(RequestParameters params, W[] input, Transaction transaction, R output);
/**
* Applies content by calling a POST service.
* @param params the parameters for the call
* @param input the content passed with the call
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R post(RequestParameters params, AbstractWriteHandle input, R output);
/**
* Applies content by calling a POST service.
* @param params the parameters for the call
* @param input the content passed with the call
* @param transaction the transaction for applying content
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R post(RequestParameters params, AbstractWriteHandle input, Transaction transaction, R output);
/**
* Applies content by calling a POST service.
* @param params the parameters for the call
* @param input an array of content passed with the call
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R post(RequestParameters params, W[] input, R output);
/**
* Applies content by calling a POST service.
* @param params the parameters for the call
* @param input an array of content passed with the call
* @param transaction the transaction for applying content
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R post(RequestParameters params, W[] input, Transaction transaction, R output);
/**
* Applies multiple content by calling a POST service.
* @param params the parameters for the call
* @param input the content passed with the call
* @param mimetypes the mimetypes for the requested content
* @return an iterator over the requested content
*/
public ServiceResultIterator post(RequestParameters params, AbstractWriteHandle input, String... mimetypes);
/**
* Applies multiple content by calling a POST service.
* @param params the parameters for the call
* @param input the content passed with the call
* @param transaction the transaction for applying content
* @param mimetypes the mimetypes for the requested content
* @return an iterator over the requested content
*/
public ServiceResultIterator post(RequestParameters params, AbstractWriteHandle input, Transaction transaction, String... mimetypes);
/**
* Applies multiple content by calling a POST service.
* @param params the parameters for the call
* @param input an array of content passed with the call
* @param mimetypes the mimetypes for the requested content
* @return an iterator over the requested content
*/
public ServiceResultIterator post(RequestParameters params, W[] input, String... mimetypes);
/**
* Applies multiple content by calling a POST service.
* @param params the parameters for the call
* @param input an array of content passed with the call
* @param transaction the transaction for applying content
* @param mimetypes the mimetypes for the requested content
* @return an iterator over the requested content
*/
public ServiceResultIterator post(RequestParameters params, W[] input, Transaction transaction, String... mimetypes);
/**
* Deletes content by calling a DELETE service.
* @param params the parameters for the call
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R delete(RequestParameters params, R output);
/**
* Deletes content by calling a DELETE service.
* @param params the parameters for the call
* @param transaction the transaction for applying content
* @param output a handle on the content response from the call
* @return the content handle for the response
*/
public R delete(RequestParameters params, Transaction transaction, R output);
/**
* Starts debugging client requests. You can suspend and resume debugging output
* using the methods of the logger.
*
* @param logger the logger that receives debugging output
*/
public void startLogging(RequestLogger logger);
/**
* Returns the logger for debugging client requests.
* @return the request logger
*/
public RequestLogger getRequestLogger();
/**
* Stops debugging client requests.
*/
public void stopLogging();
/**
* ServiceResult provides one content response from a service.
*/
public interface ServiceResult {
/**
* Returns the format of the content.
* @return the content format
*/
public abstract Format getFormat();
/**
* Returns the mimetype of the content.
* @return the content mimetype
*/
public abstract String getMimetype();
/**
* Returns the length of the content in bytes.
* @return the byte length
*/
public abstract long getLength();
/**
* Returns a handle on the content.
* @param handle the content handle
* @return the content handle
*/
public R getContent(R handle);
}
/**
* ServiceResultIterator provides an iterator over content responses
* from the server.
*/
public interface ServiceResultIterator extends Iterator {
/**
* Closes the iterator when no longer needed.
*/
public void close();
}
}
