org.apache.manifoldcf.authorities.interfaces

Interface IAuthorityGroupManager

All Known Implementing Classes:

AuthorityGroupManager

public interface IAuthorityGroupManager

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

Method Summary

Modifier and Type	Method and Description
IAuthorityGroup	create() Create a new authority group object.
void	deinstall() Uninstall the manager.
void	delete(java.lang.String name) Delete an authority group.
void	exportConfiguration(java.io.OutputStream os) Export configuration
IAuthorityGroup[]	getAllGroups() Obtain a list of the authority groups, ordered by name.
java.lang.String	getGroupDescriptionColumn() Get the authority connection description column.
java.lang.String	getGroupNameColumn() Get the authority 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.
IAuthorityGroup	load(java.lang.String name) Load a authority group by name.
IAuthorityGroup[]	loadMultiple(java.lang.String[] names) Load multiple authority groups by name.
boolean	save(IAuthorityGroup object) Save an authority group 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

getAllGroups

IAuthorityGroup[] getAllGroups()
                        throws ManifoldCFException

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

Returns:

an array of group objects.

Throws:

ManifoldCFException

load

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

Load a authority group by name.

Parameters:

name - is the name of the authority group.

Returns:

the loaded group object, or null if not found.

Throws:

ManifoldCFException

loadMultiple

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

Load multiple authority groups by name.

Parameters:

names - are the names to load.

Returns:

the loaded group objects.

Throws:

ManifoldCFException

create

IAuthorityGroup create()
                throws ManifoldCFException

Create a new authority group object.

Returns:

the new object.

Throws:

ManifoldCFException

save

boolean save(IAuthorityGroup object)
      throws ManifoldCFException

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

Parameters:

name - is the name of the group 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.

getGroupNameColumn

java.lang.String getGroupNameColumn()

Get the authority connection name column.

Returns:

the name column.

getGroupDescriptionColumn

java.lang.String getGroupDescriptionColumn()

Get the authority connection description column.

Returns:

the description column.