org.apache.manifoldcf.authorities.interfaces

Interface IMappingConnectionManager

All Known Implementing Classes:

MappingConnectionManager

public interface IMappingConnectionManager

This interface describes the functionality in the mapping connection manager. The authority connection manager manages the definitions of individual connections, and allows them to be defined, edited, and removed.

Method Summary

Modifier and Type	Method and Description
IMappingConnection	create() Create a new mapping connection object.
void	deinstall() Uninstall the manager.
void	delete(java.lang.String name) Delete an mapping connection.
void	exportConfiguration(java.io.OutputStream os) Export configuration
IMappingConnection[]	getAllConnections() Obtain a list of the mapping connections, ordered by name.
IMappingConnection[]	getAllNonLoopingConnections(java.lang.String startingConnectionName) Obtain a list of the mapping connections, ordered by name, excluding those that would form a prerequisite loop if chosen.
java.lang.String	getMappingNameColumn() Get the mapping connection name column.
java.lang.String	getTableName() Get the authority connection table name.
void	importConfiguration(java.io.InputStream is) Import configuration
void	install() Install the manager.
IMappingConnection	load(java.lang.String name) Load a mapping connection by name.
IMappingConnection[]	loadMultiple(java.lang.String[] names) Load multiple mapping connections by name.
boolean	save(IMappingConnection object) Save an mapping connection object.

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

IMappingConnection[] getAllConnections()
                                throws ManifoldCFException

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

Returns:

an array of connection objects.

Throws:

ManifoldCFException

getAllNonLoopingConnections

IMappingConnection[] getAllNonLoopingConnections(java.lang.String startingConnectionName)
                                          throws ManifoldCFException

Obtain a list of the mapping connections, ordered by name, excluding those that would form a prerequisite loop if chosen.

Parameters:

startingConnectionName - is the name of the connection we would be starting with. Pass null for all connections.

Returns:

an array of connection objects.

Throws:

ManifoldCFException

load

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

Load a mapping connection by name.

Parameters:

name - is the name of the mapping connection.

Returns:

the loaded connection object, or null if not found.

Throws:

ManifoldCFException

loadMultiple

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

Load multiple mapping connections by name.

Parameters:

names - are the names to load.

Returns:

the loaded connection objects.

Throws:

ManifoldCFException

create

IMappingConnection create()
                   throws ManifoldCFException

Create a new mapping connection object.

Returns:

the new object.

Throws:

ManifoldCFException

save

boolean save(IMappingConnection object)
      throws ManifoldCFException

Save an mapping 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 mapping connection.

Parameters:

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

Throws:

ManifoldCFException

getTableName

java.lang.String getTableName()

Get the authority connection table name.

Returns:

the table name.

getMappingNameColumn

java.lang.String getMappingNameColumn()

Get the mapping connection name column.

Returns:

the name column.