Package org.apache.manifoldcf.crawler.notification

Class NotificationConnectionManager

java.lang.Object

org.apache.manifoldcf.core.database.BaseTable

org.apache.manifoldcf.crawler.notification.NotificationConnectionManager

All Implemented Interfaces:

INotificationConnectionManager

public class NotificationConnectionManager
extends BaseTable
implements INotificationConnectionManager

This class is the manager of the notification connection description. Inside, multiple database tables are managed, with appropriate caching. Note well: The database handle is instantiated here using the DBInterfaceFactory. This is acceptable because the actual database that this table is located in is fixed.

notificationconnections

Field	Type	Description
connectionname	VARCHAR(32)	Primary Key
description	VARCHAR(255)
classname	VARCHAR(255)
maxcount	BIGINT
configxml	LONGTEXT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	NotificationConnectionManager.NotificationConnectionDescription	This is the object description for a repository connection object.
protected static class	NotificationConnectionManager.NotificationConnectionExecutor	This is the executor object for locating notification connection objects.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid
protected ICacheManager	cacheManager
protected static java.lang.String	classNameField
protected static java.lang.String	configField
protected static java.lang.String	descriptionField
protected static int	FETCH_MAX
protected ILockManager	lockManager
protected static java.lang.String	maxCountField
protected static java.lang.String	nameField
protected java.lang.String	notificationsLock
protected static java.util.Random	random
protected IThreadContext	threadContext

Fields inherited from class org.apache.manifoldcf.core.database.BaseTable

dbInterface, tableName

Constructor Summary

Constructors

Constructor	Description
NotificationConnectionManager(IThreadContext threadContext, IDBInterface database)	Constructor.

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.
protected static java.lang.String	getNotificationConnectionKey(java.lang.String connectionName)	Construct a key which represents an individual notification connection.
protected void	getNotificationConnectionsChunk(NotificationConnection[] rval, java.util.Map returnIndex, java.util.ArrayList params)	Read a chunk of notification connections.
protected static java.lang.String	getNotificationConnectionsKey()	Construct a key which represents the general list of notification connectors.
protected NotificationConnection[]	getNotificationConnectionsMultiple(java.lang.String[] connectionNames)	Fetch multiple notification connections at a single time.
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 multiple notification connections by name.
protected int	loadMultipleInternal(INotificationConnection[] rval, int outputIndex, java.lang.String[] fetchNames, int inputIndex, int length)
protected int	maxClauseGetNotificationConnectionsChunk()	Calculate how many notification connections to get at once.
boolean	save(INotificationConnection object)	Save a notification connection object.

Methods inherited from class org.apache.manifoldcf.core.database.BaseTable

addTableIndex, analyzeTable, beginTransaction, buildConjunctionClause, constructCountClause, constructDistinctOnClause, constructDoubleCastClause, constructOffsetLimitClause, constructRegexpClause, constructSubstringClause, endTransaction, findConjunctionClauseMax, getDatabaseCacheKey, getDBInterface, getMaxInClause, getMaxOrClause, getSleepAmt, getTableIndexes, getTableName, getTableSchema, getTransactionID, getWindowedReportMaxRows, makeTableKey, noteModifications, performAddIndex, performAlter, performCommit, performCreate, performDelete, performDrop, performInsert, performModification, performQuery, performQuery, performRemoveIndex, performUpdate, prepareRowForSave, readRow, reindexTable, signalRollback, sleepFor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.manifoldcf.crawler.interfaces.INotificationConnectionManager

getTableName

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

nameField

protected static final java.lang.String nameField

See Also:

Constant Field Values

descriptionField

protected static final java.lang.String descriptionField

See Also:

Constant Field Values

classNameField

protected static final java.lang.String classNameField

See Also:

Constant Field Values

maxCountField

protected static final java.lang.String maxCountField

See Also:

Constant Field Values

configField

protected static final java.lang.String configField

See Also:

Constant Field Values

random

protected static java.util.Random random

cacheManager

protected final ICacheManager cacheManager

threadContext

protected final IThreadContext threadContext

lockManager

protected final ILockManager lockManager

notificationsLock

protected final java.lang.String notificationsLock

See Also:

Constant Field Values

FETCH_MAX

protected static final int FETCH_MAX

See Also:

Constant Field Values

Constructor Detail

NotificationConnectionManager

public NotificationConnectionManager(IThreadContext threadContext,
                                     IDBInterface database)
                              throws ManifoldCFException

Constructor.

Parameters:

threadContext - is the thread context.

Throws:

ManifoldCFException

Method Detail

install

public void install()
             throws ManifoldCFException

Install the manager.

Specified by:

install in interface INotificationConnectionManager

Throws:

ManifoldCFException

deinstall

public void deinstall()
               throws ManifoldCFException

Uninstall the manager.

Specified by:

deinstall in interface INotificationConnectionManager

Throws:

ManifoldCFException

exportConfiguration

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

Export configuration

Specified by:

exportConfiguration in interface INotificationConnectionManager

Throws:

java.io.IOException

ManifoldCFException

importConfiguration

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

Import configuration

Specified by:

importConfiguration in interface INotificationConnectionManager

Throws:

java.io.IOException

ManifoldCFException

getAllConnections

public INotificationConnection[] getAllConnections()
                                            throws ManifoldCFException

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

Specified by:

getAllConnections in interface INotificationConnectionManager

Returns:

an array of connection objects.

Throws:

ManifoldCFException

load

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

Load a notification connection by name.

Specified by:

load in interface INotificationConnectionManager

Parameters:

name - is the name of the notification connection.

Returns:

the loaded connection object, or null if not found.

Throws:

ManifoldCFException

loadMultiple

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

Load multiple notification connections by name.

Specified by:

loadMultiple in interface INotificationConnectionManager

Parameters:

names - are the names to load.

Returns:

the loaded connection objects.

Throws:

ManifoldCFException

loadMultipleInternal

protected int loadMultipleInternal(INotificationConnection[] rval,
                                   int outputIndex,
                                   java.lang.String[] fetchNames,
                                   int inputIndex,
                                   int length)
                            throws ManifoldCFException

Throws:

ManifoldCFException

create

public INotificationConnection create()
                               throws ManifoldCFException

Create a new notification connection object.

Specified by:

create in interface INotificationConnectionManager

Returns:

the new object.

Throws:

ManifoldCFException

save

public boolean save(INotificationConnection object)
             throws ManifoldCFException

Save a notification connection object.

Specified by:

save in interface INotificationConnectionManager

Parameters:

object - is the object to save.

Returns:

true if the object was created, false otherwise.

Throws:

ManifoldCFException

delete

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

Delete a notification connection.

Specified by:

delete in interface INotificationConnectionManager

Parameters:

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

Throws:

ManifoldCFException

findConnectionsForConnector

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

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

Specified by:

findConnectionsForConnector in interface INotificationConnectionManager

Parameters:

className - is the class name of the connector.

Returns:

the notification connections that use that connector.

Throws:

ManifoldCFException

checkConnectorExists

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

Check if underlying connector exists.

Specified by:

checkConnectorExists in interface INotificationConnectionManager

Parameters:

name - is the name of the connection to check.

Returns:

true if the underlying connector is registered.

Throws:

ManifoldCFException

getConnectionNameColumn

public java.lang.String getConnectionNameColumn()

Return the name column.

Specified by:

getConnectionNameColumn in interface INotificationConnectionManager

Returns:

the name column.

getNotificationConnectionsKey

protected static java.lang.String getNotificationConnectionsKey()

Construct a key which represents the general list of notification connectors.

Returns:

the cache key.

getNotificationConnectionKey

protected static java.lang.String getNotificationConnectionKey(java.lang.String connectionName)

Construct a key which represents an individual notification connection.

Parameters:

connectionName - is the name of the connector.

Returns:

the cache key.

getNotificationConnectionsMultiple

protected NotificationConnection[] getNotificationConnectionsMultiple(java.lang.String[] connectionNames)
                                                               throws ManifoldCFException

Fetch multiple notification connections at a single time.

Parameters:

connectionNames - are a list of connection names.

Returns:

the corresponding repository connection objects.

Throws:

ManifoldCFException

maxClauseGetNotificationConnectionsChunk

protected int maxClauseGetNotificationConnectionsChunk()

Calculate how many notification connections to get at once.

getNotificationConnectionsChunk

protected void getNotificationConnectionsChunk(NotificationConnection[] rval,
                                               java.util.Map returnIndex,
                                               java.util.ArrayList params)
                                        throws ManifoldCFException

Read a chunk of notification connections.

Parameters:

rval - is the place to put the read policies.

returnIndex - is a map from the object id (resource id) and the rval index.

params - is the set of parameters.

Throws:

ManifoldCFException