org.apache.manifoldcf.crawler.interfaces
Interface IRepositoryConnection

All Known Implementing Classes:

RepositoryConnection

public interface IRepositoryConnection

An instance of this interface represents a paper object that describes a repository connection. This is the paper object meant for editing and manipulation.

Field Summary

static java.lang.String

_rcsid

Method Summary

void	addThrottleValue(java.lang.String match, java.lang.String description, float throttle) Add a throttle value.
void	clearThrottleValues() Clear all throttle values.
void	deleteThrottleValue(java.lang.String match) Delete a throttle.
java.lang.String	getACLAuthority() Get the ACL authority name.
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.Float	getThrottle() Get the maximum number of document fetches per millisecond, for all bins (.*).
java.lang.String	getThrottleDescription(java.lang.String match) Get the description for a throttle.
java.lang.String[]	getThrottles() Get throttles.
float	getThrottleValue(java.lang.String match) Get the throttle value for a throttle.
void	setACLAuthority(java.lang.String authorityName) Set the ACL authority name.
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	setThrottle(java.lang.Float rate) Set the maximum number of document fetches per millisecond, for all bins (.*).

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

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.

setACLAuthority

void setACLAuthority(java.lang.String authorityName)

Set the ACL authority name.

Parameters:

authorityName - is the ACL authority name.

getACLAuthority

java.lang.String getACLAuthority()

Get the ACL authority name.

Returns:

the ACL authority name.

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.

clearThrottleValues

void clearThrottleValues()

Clear all throttle values.

addThrottleValue

void addThrottleValue(java.lang.String match,
                      java.lang.String description,
                      float throttle)

Add a throttle value.

Parameters:

description - is the throttle description.

match - is the regexp to be applied to the bin names.

throttle - is the fetch rate to use, in fetches per millisecond.

deleteThrottleValue

void deleteThrottleValue(java.lang.String match)

Delete a throttle.

Parameters:

match - is the regexp describing the throttle to be removed.

getThrottles

java.lang.String[] getThrottles()

Get throttles. This will return a list of match strings, ordered by description and then match string.

Returns:

the ordered list of throttles.

getThrottleDescription

java.lang.String getThrottleDescription(java.lang.String match)

Get the description for a throttle.

Parameters:

match - describes the throttle.

Returns:

the description.

getThrottleValue

float getThrottleValue(java.lang.String match)

Get the throttle value for a throttle.

Parameters:

match - describes the throttle.

Returns:

the throttle value, in fetches per millisecond.

setThrottle

void setThrottle(java.lang.Float rate)

Set the maximum number of document fetches per millisecond, for all bins (.*).

Parameters:

rate - is the rate, in fetches/millisecond.

getThrottle

java.lang.Float getThrottle()

Get the maximum number of document fetches per millisecond, for all bins (.*).

Returns:

fetches/ms, or null if there is no such throttle.