org.apache.manifoldcf.agents.interfaces

Interface ITransformationConnectionManager

All Known Implementing Classes:

TransformationConnectionManager

public interface ITransformationConnectionManager

Manager classes of this kind use the database to contain a human description of a transformation connection.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	checkConnectorExists(java.lang.String name) Check if underlying connector exists.
ITransformationConnection	create() Create a new transformation connection object.
void	deinstall() Uninstall the manager.
void	delete(java.lang.String name) Delete a transformation connection.
void	exportConfiguration(java.io.OutputStream os) Export configuration
java.lang.String[]	findConnectionsForConnector(java.lang.String className) Get a list of transformation connections that share the same connector.
ITransformationConnection[]	getAllConnections() Obtain a list of the transformation connections, ordered by name.
java.lang.String	getConnectionNameColumn() Return the name column.
java.lang.String	getTableName() Return the primary table name.
void	importConfiguration(java.io.InputStream is) Import configuration
void	install() Install the manager.
ITransformationConnection	load(java.lang.String name) Load an transformation connection by name.
ITransformationConnection[]	loadMultiple(java.lang.String[] names) Load a set of transformation connections.
boolean	save(ITransformationConnection object) Save a transformation connection object.

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

install

void install()
      throws ManifoldCFException

Install the manager.

Throws:

ManifoldCFException

deinstall

void deinstall()
        throws ManifoldCFException

Uninstall the manager.

Throws:

ManifoldCFException

exportConfiguration

void exportConfiguration(java.io.OutputStream os)
                  throws java.io.IOException,
                         ManifoldCFException

Export configuration

Throws:

java.io.IOException

ManifoldCFException

importConfiguration

void importConfiguration(java.io.InputStream is)
                  throws java.io.IOException,
                         ManifoldCFException

Import configuration

Throws:

java.io.IOException

ManifoldCFException

getAllConnections

ITransformationConnection[] getAllConnections()
                                       throws ManifoldCFException

Obtain a list of the transformation connections, ordered by name.

Returns:

an array of connection objects.

Throws:

ManifoldCFException

load

ITransformationConnection load(java.lang.String name)
                        throws ManifoldCFException

Load an transformation connection by name.

Parameters:

name - is the name of the transformation connection.

Returns:

the loaded connection object, or null if not found.

Throws:

ManifoldCFException

loadMultiple

ITransformationConnection[] loadMultiple(java.lang.String[] names)
                                  throws ManifoldCFException

Load a set of transformation connections.

Parameters:

names - are the names of the transformation connections.

Returns:

the descriptors of the transformation connections, with null values for those not found.

Throws:

ManifoldCFException

create

ITransformationConnection create()
                          throws ManifoldCFException

Create a new transformation connection object.

Returns:

the new object.

Throws:

ManifoldCFException

save

boolean save(ITransformationConnection object)
      throws ManifoldCFException

Save a transformation connection object.

Parameters:

object - is the object to save.

Returns:

true if the object was created, false otherwise.

Throws:

ManifoldCFException

delete

void delete(java.lang.String name)
     throws ManifoldCFException

Delete a transformation connection.

Parameters:

name - is the name of the connection to delete. If the name does not exist, no error is returned.

Throws:

ManifoldCFException

findConnectionsForConnector

java.lang.String[] findConnectionsForConnector(java.lang.String className)
                                        throws ManifoldCFException

Get a list of transformation connections that share the same connector.

Parameters:

className - is the class name of the connector.

Returns:

the transformation connections that use that connector.

Throws:

ManifoldCFException

checkConnectorExists

boolean checkConnectorExists(java.lang.String name)
                      throws ManifoldCFException

Check if underlying connector exists.

Parameters:

name - is the name of the connection to check.

Returns:

true if the underlying connector is registered.

Throws:

ManifoldCFException

getTableName

java.lang.String getTableName()

Return the primary table name.

Returns:

the table name.

getConnectionNameColumn

java.lang.String getConnectionNameColumn()

Return the name column.

Returns:

the name column.