Package org.apache.manifoldcf.crawler.interfaces

Interface INotificationConnectionManager

All Known Implementing Classes:

NotificationConnectionManager

public interface INotificationConnectionManager

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

Field Summary

Fields

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

Method Summary

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

INotificationConnection[] getAllConnections()
                                     throws ManifoldCFException

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

Returns:

an array of connection objects.

Throws:

ManifoldCFException

load

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

Load a notification connection by name.

Parameters:

name - is the name of the notification connection.

Returns:

the loaded connection object, or null if not found.

Throws:

ManifoldCFException

loadMultiple

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

Load a set of notification connections.

Parameters:

names - are the names of the notification connections.

Returns:

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

Throws:

ManifoldCFException

create

INotificationConnection create()
                        throws ManifoldCFException

Create a new notification connection object.

Returns:

the new object.

Throws:

ManifoldCFException

save

boolean save(INotificationConnection object)
      throws ManifoldCFException

Save a notification connection object.

Parameters:

object - is the object to save.

Returns:

true if the object is created, false otherwise.

Throws:

ManifoldCFException

delete

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

Delete a notification 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 notification connections that share the same connector.

Parameters:

className - is the class name of the connector.

Returns:

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