org.apache.manifoldcf.agents.interfaces
Interface IOutputConnectionManager

All Known Implementing Classes:

OutputConnectionManager

public interface IOutputConnectionManager

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

Field Summary

static java.lang.String

_rcsid

Method Summary

boolean	checkConnectorExists(java.lang.String name) Check if underlying connector exists.
IOutputConnection	create() Create a new output connection object.
void	deinstall() Uninstall the manager.
void	delete(java.lang.String name) Delete an output connection.
void	exportConfiguration(java.io.OutputStream os) Export configuration
java.lang.String[]	findConnectionsForConnector(java.lang.String className) Get a list of output connections that share the same connector.
IOutputConnection[]	getAllConnections() Obtain a list of the output 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.
IOutputConnection	load(java.lang.String name) Load an output connection by name.
IOutputConnection[]	loadMultiple(java.lang.String[] names) Load a set of output connections.
boolean	save(IOutputConnection object) Save an output 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

IOutputConnection[] getAllConnections()
                                      throws ManifoldCFException

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

Returns:

an array of connection objects.

Throws:

ManifoldCFException

load

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

Load an output connection by name.

Parameters:

name - is the name of the output connection.

Returns:

the loaded connection object, or null if not found.

Throws:

ManifoldCFException

loadMultiple

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

Load a set of output connections.

Parameters:

names - are the names of the output connections.

Returns:

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

Throws:

ManifoldCFException

create

IOutputConnection create()
                         throws ManifoldCFException

Create a new output connection object.

Returns:

the new object.

Throws:

ManifoldCFException

save

boolean save(IOutputConnection object)
             throws ManifoldCFException

Save an output 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 an output 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 output connections that share the same connector.

Parameters:

className - is the class name of the connector.

Returns:

the repository 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.