org.apache.manifoldcf.agents.interfaces

Interface ITransformationConnector

All Superinterfaces:

IConnector, IPipelineConnector

All Known Implementing Classes:

BaseTransformationConnector

public interface ITransformationConnector
extends IPipelineConnector

This interface describes an instance of a connection to a translation engine. Each instance of this interface is used in only one thread at a time. Connection Pooling on these kinds of objects is performed by the factory which instantiates connector objects from symbolic names and config parameters, and is pooled by these parameters. That is, a pooled connector handle is used only if all the connection parameters for the handle match. Implementers of this interface should provide a default constructor which has this signature: xxx(); Connector instances are either configured or not. If configured, they will persist in a pool, and be reused multiple times. Certain methods of a connector may be called before the connector is configured. This includes basically all methods that permit inspection of the connector's capabilities. The purpose of the transformation connector is to allow documents to be transformed prior to them being sent to an output connection.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid

Fields inherited from interface org.apache.manifoldcf.agents.interfaces.IPipelineConnector

DOCUMENTSTATUS_ACCEPTED, DOCUMENTSTATUS_REJECTED

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getActivitiesList() Return a list of activities that this connector generates.
boolean	requestInfo(Configuration output, java.lang.String command) Request arbitrary connector information.

Methods inherited from interface org.apache.manifoldcf.agents.interfaces.IPipelineConnector

addOrReplaceDocumentWithException, checkDateIndexable, checkDocumentIndexable, checkLengthIndexable, checkMimeTypeIndexable, checkURLIndexable, getFormCheckJavascriptMethodName, getFormPresaveCheckJavascriptMethodName, getPipelineDescription, outputSpecificationBody, outputSpecificationHeader, processSpecificationPost, viewSpecification

Methods inherited from interface org.apache.manifoldcf.core.interfaces.IConnector

check, clearThreadContext, connect, deinstall, disconnect, getConfiguration, install, isConnected, outputConfigurationBody, outputConfigurationHeader, poll, processConfigurationPost, setThreadContext, viewConfiguration

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

getActivitiesList

java.lang.String[] getActivitiesList()

Return a list of activities that this connector generates. The connector does NOT need to be connected before this method is called.

Returns:

the set of activities.

requestInfo

boolean requestInfo(Configuration output,
                    java.lang.String command)
             throws ManifoldCFException

Request arbitrary connector information. This method is called directly from the API in order to allow API users to perform any one of several connector-specific queries.

Parameters:

output - is the response object, to be filled in by this method.

command - is the command, which is taken directly from the API request.

Returns:

true if the resource is found, false if not. In either case, output may be filled in.

Throws:

ManifoldCFException