com.marklogic.client.admin.ResourceExtensionsManager Maven / Gradle / Ivy
/*
* Copyright 2012-2016 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.admin;
import com.marklogic.client.util.RequestLogger;
import com.marklogic.client.util.RequestParameters;
import com.marklogic.client.io.Format;
import com.marklogic.client.io.marker.StructureReadHandle;
import com.marklogic.client.io.marker.TextReadHandle;
import com.marklogic.client.io.marker.TextWriteHandle;
/**
* A Resource Extensions Manager supports writing, reading, and deleting
* a Resource Services extension as well as listing the installed
* Resource Services extensions. A Resource Services extension implements
* server operations on a kind of database resource not supported
* by default.
*/
public interface ResourceExtensionsManager {
/**
* Reads the list of resource service extensions installed on the server
* in a JSON or XML representation provided as an object of an IO class.
*
* The IO class must have been registered before creating the database client.
* By default, the provided handles that implement
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
*
* Learn more about shortcut methods
*
* @param format whether to provide the list in a JSON or XML representation
* @param as the IO class for reading the list of resource service extensions
* @param the type of object that will be returned by the handle registered for it
* @return an object of the IO class with the list of resource service extensions
*/
public T listServicesAs(Format format, Class as);
/**
* Reads the list of resource service extensions installed on the server
* in a JSON or XML representation provided as an object of an IO class.
*
* The IO class must have been registered before creating the database client.
* By default, the provided handles that implement
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
*
* Learn more about shortcut methods
*
* @param format whether to provide the list in a JSON or XML representation
* @param as the IO class for reading the list of resource service extensions
* @param refresh whether to parse metadata from the extension source
* @param the type of object that will be returned by the handle registered for it
* @return an object of the IO class with the list of resource service extensions
*/
public T listServicesAs(Format format, Class as, boolean refresh);
/**
* Reads the list of resource service extensions installed on the server.
* @param listHandle a handle on a JSON or XML representation of the list
* @param the type of StructureReadHandle to return
* @return the list handle
*/
public T listServices(T listHandle);
/**
* Reads the list of resource service extensions installed on the server,
* specifying whether to refresh the metadata about each extension by parsing
* the extension source.
* @param listHandle a handle on a JSON or XML representation of the list
* @param refresh whether to parse metadata from the extension source
* @param the type of StructureReadHandle to return
* @return the list handle
*/
public T listServices(T listHandle, boolean refresh);
/**
* Reads the XQuery implementation of the services for a resource
* in a textual representation provided as an object of an IO class.
*
* The IO class must have been registered before creating the database client.
* By default, the provided handles that implement
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
*
* Learn more about shortcut methods
*
* @param resourceName the name of the resource
* @param as the IO class for reading the source code as text
* @param the type of object that will be returned by the handle registered for it
* @return an object of the IO class with the source code for the service
*/
public T readServicesAs(String resourceName, Class as);
/**
* Reads the XQuery implementation of the services for a resource.
* @param resourceName the name of the resource
* @param sourceHandle a handle for reading the text of the XQuery implementation.
* @param the type of TextReadHandle to return
* @return the XQuery source code
*/
public T readServices(String resourceName, T sourceHandle);
/**
* Installs the services that implement a resource
* in a textual representation provided as an object of an IO class.
*
* The IO class must have been registered before creating the database client.
* By default, the provided handles that implement
* {@link com.marklogic.client.io.marker.ContentHandle ContentHandle} are registered.
*
* Learn more about shortcut methods
*
* @param resourceName the name of the resource
* @param source an IO representation of the source code
* @param metadata the metadata about the resource services
* @param methodParams a declaration of the parameters for the services
*/
public void writeServicesAs(
String resourceName, Object source, ExtensionMetadata metadata, MethodParameters... methodParams
);
/**
* Installs the services that implement a resource.
* @param resourceName the name of the resource
* @param sourceHandle a handle on the source for the XQuery implementation
* @param metadata the metadata about the resource services
* @param methodParams a declaration of the parameters for the services
*/
public void writeServices(String resourceName, TextWriteHandle sourceHandle, ExtensionMetadata metadata, MethodParameters... methodParams);
/**
* Uninstalls the services that implement a resource.
* @param resourceName the name of the resource
*/
public void deleteServices(String resourceName);
/**
* 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);
/**
* Stops debugging client requests.
*/
public void stopLogging();
/**
* Method Parameters declare the parameters accepted
* by the Resource Services extension.
*/
public class MethodParameters extends RequestParameters {
private MethodType method;
/**
* Declares the parameters for a method the provides services for a resource.
* @param method the method type
*/
public MethodParameters(MethodType method) {
super();
this.method = method;
}
/**
* Returns the method for the parameters.
* @return the method type
*/
public MethodType getMethod() {
return method;
}
/**
* Returns the hash code for the method.
*/
@Override
public int hashCode() {
return getMethod().hashCode();
}
/**
* Returns whether the method declaration is the same.
*/
@Override
public boolean equals(Object other) {
if (other == null)
return false;
if (!(other instanceof MethodParameters))
return false;
MethodParameters otherParam = (MethodParameters) other;
if (!getMethod().equals(otherParam.getMethod()))
return false;
return super.equals(otherParam);
}
}
}