org.apache.manifoldcf.authorities.interfaces

Interface IAuthorityConnectionManager

All Known Implementing Classes:

AuthorityConnectionManager

public interface IAuthorityConnectionManager

This interface describes the functionality in the authority 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
IAuthorityConnection	create() Create a new authority connection object.
void	deinstall() Uninstall the manager.
void	delete(java.lang.String name) Delete an authority connection.
void	exportConfiguration(java.io.OutputStream os) Export configuration
IAuthorityConnection[]	getAllConnections() Obtain a list of the authority connections, ordered by name.
java.lang.String	getAuthorityNameColumn() Get the authority connection name column.
IAuthorityConnection[]	getDomainConnections(java.lang.String authDomain) Obtain a list of the authority connections which correspond to an auth domain.
java.lang.String	getTableName() Get the authority connection table name.
void	importConfiguration(java.io.InputStream is) Import configuration
void	install() Install the manager.
boolean	isGroupReferenced(java.lang.String authorityGroup) Return true if the specified authority group name is referenced.
boolean	isMappingReferenced(java.lang.String mappingName) Return true if the specified mapping name is referenced.
IAuthorityConnection	load(java.lang.String name) Load a authority connection by name.
IAuthorityConnection[]	loadMultiple(java.lang.String[] names) Load multiple repository connections by name.
boolean	save(IAuthorityConnection object) Save an authority 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

isGroupReferenced

boolean isGroupReferenced(java.lang.String authorityGroup)
                   throws ManifoldCFException

Return true if the specified authority group name is referenced.

Parameters:

authorityGroup - is the authority group name.

Returns:

true if referenced, false otherwise.

Throws:

ManifoldCFException

getAllConnections

IAuthorityConnection[] getAllConnections()
                                  throws ManifoldCFException

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

Returns:

an array of connection objects.

Throws:

ManifoldCFException

getDomainConnections

IAuthorityConnection[] getDomainConnections(java.lang.String authDomain)
                                     throws ManifoldCFException

Obtain a list of the authority connections which correspond to an auth domain.

Parameters:

authDomain - is the domain to get connections for.

Returns:

an array of connection objects.

Throws:

ManifoldCFException

load

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

Load a authority connection by name.

Parameters:

name - is the name of the authority connection.

Returns:

the loaded connection object, or null if not found.

Throws:

ManifoldCFException

loadMultiple

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

Load multiple repository connections by name.

Parameters:

names - are the names to load.

Returns:

the loaded connection objects.

Throws:

ManifoldCFException

create

IAuthorityConnection create()
                     throws ManifoldCFException

Create a new authority connection object.

Returns:

the new object.

Throws:

ManifoldCFException

save

boolean save(IAuthorityConnection object)
      throws ManifoldCFException

Save an authority 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 authority 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.

getAuthorityNameColumn

java.lang.String getAuthorityNameColumn()

Get the authority connection name column.

Returns:

the name column.

isMappingReferenced

boolean isMappingReferenced(java.lang.String mappingName)
                     throws ManifoldCFException

Return true if the specified mapping name is referenced.

Parameters:

mappingName - is the mapping name.

Returns:

true if referenced, false otherwise.

Throws:

ManifoldCFException