org.apache.manifoldcf.authorities.interfaces

Interface IAuthorityConnection

All Known Implementing Classes:

AuthorityConnection

public interface IAuthorityConnection

This interface describes a paper object which is an authority connection.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthDomain() Get the authorization domain.
java.lang.String	getAuthGroup() Get the authorization group.
java.lang.String	getClassName() Get the class name.
ConfigParams	getConfigParams() Get the configuration parameters.
java.lang.String	getDescription() Get description.
boolean	getIsNew() Get 'isnew' condition.
int	getMaxConnections() Get the maximum size of the connection pool.
java.lang.String	getName() Get name.
java.lang.String	getPrerequisiteMapping() Get the prerequisite mapper, if any.
void	setAuthDomain(java.lang.String domain) Set the authorization domain.
void	setAuthGroup(java.lang.String groupName) Set authorization group.
void	setClassName(java.lang.String className) Set the class name.
void	setDescription(java.lang.String description) Set description.
void	setIsNew(boolean isnew) Set 'isnew' condition.
void	setMaxConnections(int maxCount) Set the maximum size of the connection pool.
void	setName(java.lang.String name) Set name.
void	setPrerequisiteMapping(java.lang.String mapping) Set the prerequisite mapper, if any.

Method Detail

setIsNew

void setIsNew(boolean isnew)

Set 'isnew' condition.

Parameters:

isnew - true if this is a new instance.

getIsNew

boolean getIsNew()

Get 'isnew' condition.

Returns:

true if this is a new connection, false otherwise.

setName

void setName(java.lang.String name)

Set name.

Parameters:

name - is the name.

getName

java.lang.String getName()

Get name.

Returns:

the name

setDescription

void setDescription(java.lang.String description)

Set description.

Parameters:

description - is the description.

getDescription

java.lang.String getDescription()

Get description.

Returns:

the description

setClassName

void setClassName(java.lang.String className)

Set the class name.

Parameters:

className - is the class name.

getClassName

java.lang.String getClassName()

Get the class name.

Returns:

the class name

getConfigParams

ConfigParams getConfigParams()

Get the configuration parameters.

Returns:

the map. Can be modified.

setMaxConnections

void setMaxConnections(int maxCount)

Set the maximum size of the connection pool.

Parameters:

maxCount - is the maximum connection count per JVM.

getMaxConnections

int getMaxConnections()

Get the maximum size of the connection pool.

Returns:

the maximum size.

setPrerequisiteMapping

void setPrerequisiteMapping(java.lang.String mapping)

Set the prerequisite mapper, if any.

Parameters:

mapping - is the name of the mapping connection to use to get the input user name, or null.

getPrerequisiteMapping

java.lang.String getPrerequisiteMapping()

Get the prerequisite mapper, if any.

Returns:

the mapping connection name whose output should be used as the input user name.

setAuthDomain

void setAuthDomain(java.lang.String domain)

Set the authorization domain.

Parameters:

domain - is the authorization domain.

getAuthDomain

java.lang.String getAuthDomain()

Get the authorization domain.

Returns:

the authorization domain.

setAuthGroup

void setAuthGroup(java.lang.String groupName)

Set authorization group.

Parameters:

groupName - is the name of the group.

getAuthGroup

java.lang.String getAuthGroup()

Get the authorization group.

Returns:

the group.