Package org.apache.manifoldcf.authorities.interfaces

Interface IAuthorizationDomainManager

All Known Implementing Classes:

AuthorizationDomainManager

public interface IAuthorizationDomainManager

This interface describes the authorization domain registry. Authorization domains are registered here, so that they can be made available when an authority connection is created.

Method Summary

Modifier and Type	Method	Description
void	deinstall()	Uninstall.
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.
void	registerDomain(java.lang.String description, java.lang.String domainName)	Register a new domain.
void	unregisterDomain(java.lang.String domainName)	Unregister a domain.

Method Detail

install

void install()
      throws ManifoldCFException

Install.

Throws:

ManifoldCFException

deinstall

void deinstall()
        throws ManifoldCFException

Uninstall.

Throws:

ManifoldCFException

registerDomain

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

Register a new domain.

Parameters:

description - is the description to use in the UI.

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

Throws:

ManifoldCFException

unregisterDomain

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

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

Parameters:

domainName - is the internal domain name to unregister.

Throws:

ManifoldCFException

getDomains

IResultSet getDomains()
               throws ManifoldCFException

Get ordered list of domains.

Returns:

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

Throws:

ManifoldCFException

getDescription

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

Get a description given a domain name.

Parameters:

domainName - is the domain name.

Returns:

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

Throws:

ManifoldCFException