org.apache.manifoldcf.authorities.authdomains

Class AuthorizationDomainManager

java.lang.Object

org.apache.manifoldcf.core.database.BaseTable

org.apache.manifoldcf.authorities.authdomains.AuthorizationDomainManager

All Implemented Interfaces:

IAuthorizationDomainManager

public class AuthorizationDomainManager
extends BaseTable
implements IAuthorizationDomainManager

This is the implementation of that authority connector manager.

authdomains

Field	Type	Description
description	VARCHAR(255)
domainname	VARCHAR(255)	Primary Key

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
protected static java.lang.String	descriptionField
protected static java.lang.String	domainNameField
protected IThreadContext	threadContext

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

dbInterface, tableName

Constructor Summary

Constructors

Constructor and Description
AuthorizationDomainManager(IThreadContext threadContext, IDBInterface database) Constructor.

Method Summary

Modifier and Type	Method and Description
void	deinstall() Uninstall.
protected java.lang.String	getCacheKey() Get the cache key for the connector manager table.
java.lang.String	getDescription(java.lang.String domainName) Get a description given a domain name.
IResultSet	getDomains() Get ordered list of domains.
void	install() Install or upgrade.
void	registerDomain(java.lang.String description, java.lang.String domainName) Register a new domain.
void	unregisterDomain(java.lang.String domainName) Unregister a domain.

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

descriptionField

protected static final java.lang.String descriptionField

See Also:

Constant Field Values

domainNameField

protected static final java.lang.String domainNameField

See Also:

Constant Field Values

threadContext

protected final IThreadContext threadContext

Constructor Detail

AuthorizationDomainManager

public AuthorizationDomainManager(IThreadContext threadContext,
                                  IDBInterface database)
                           throws ManifoldCFException

Constructor.

Parameters:

threadContext - is the thread context.

database - is the database handle.

Throws:

ManifoldCFException

Method Detail

install

public void install()
             throws ManifoldCFException

Install or upgrade.

Specified by:

install in interface IAuthorizationDomainManager

Throws:

ManifoldCFException

deinstall

public void deinstall()
               throws ManifoldCFException

Uninstall.

Specified by:

deinstall in interface IAuthorizationDomainManager

Throws:

ManifoldCFException

registerDomain

public void registerDomain(java.lang.String description,
                           java.lang.String domainName)
                    throws ManifoldCFException

Register a new domain.

Specified by:

registerDomain in interface IAuthorizationDomainManager

Parameters:

description - is the description to use in the UI.

domainName - is the internal domain name used by the authority service.

Throws:

ManifoldCFException

unregisterDomain

public void unregisterDomain(java.lang.String domainName)
                      throws ManifoldCFException

Unregister a domain. This may fail if any authority connections refer to the domain.

Specified by:

unregisterDomain in interface IAuthorizationDomainManager

Parameters:

domainName - is the internal domain name to unregister.

Throws:

ManifoldCFException

getDomains

public IResultSet getDomains()
                      throws ManifoldCFException

Get ordered list of domains.

Specified by:

getDomains in interface IAuthorizationDomainManager

Returns:

a resultset with the columns "description" and "domainname". These will be ordered by description.

Throws:

ManifoldCFException

getDescription

public java.lang.String getDescription(java.lang.String domainName)
                                throws ManifoldCFException

Get a description given a domain name.

Specified by:

getDescription in interface IAuthorizationDomainManager

Parameters:

domainName - is the domain name.

Returns:

the description, or null if the domain is not registered.

Throws:

ManifoldCFException

getCacheKey

protected java.lang.String getCacheKey()

Get the cache key for the connector manager table.

Returns:

the cache key