org.tigris.scarab.util.word
Class IssueSearchFactory

java.lang.Object
  org.tigris.scarab.util.word.IssueSearchFactory

public class IssueSearchFactory

extends java.lang.Object

Creates new IssueSearch objects and acts as a regulator on the number of concurrent searches.

Since:

0.16.25

Version:

$Id: IssueSearchFactory.java 10404 2006-12-28 15:33:29Z ronvoe122 $

Author:

John McNally

Field Summary

static IssueSearchFactory

INSTANCE

Constructor Summary

(package private)

IssueSearchFactory()

Method Summary

IssueSearch	getInstance(Issue issue, ScarabUser searcher)
IssueSearch	getInstance(MITList mitList, ScarabUser searcher)
IssueSearch	getInstance(Module module, IssueType issueType, ScarabUser searcher)
(package private) int	getMaxInstances() Maximum number of concurrent searches.
(package private) int	getMaxWait() How long to wait (in seconds) for a search object if one is not immediately available.
void	notifyDone()
(package private) void	register()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final IssueSearchFactory INSTANCE

Constructor Detail

IssueSearchFactory

IssueSearchFactory()

Method Detail

getMaxInstances

int getMaxInstances()

Maximum number of concurrent searches. Given by the scarab.concurrent.search.max property. if not given or value is negative, unlimited concurrent searches are allowed (will then be limited by db connections). A value of 0 will disable searching. Implementation note: this method is package-private to facilitate testing.

getMaxWait

int getMaxWait()

How long to wait (in seconds) for a search object if one is not immediately available. Given by the scarab.concurrent.search.wait property. if not given or value is negative, we block till an IssueSearch can be created. A value of 0 will fail immediately. Implementation note: this method is package-private to facilitate testing.

getInstance

public IssueSearch getInstance(Issue issue,
                               ScarabUser searcher)
                        throws java.lang.Exception,
                               MaxConcurrentSearchException

Throws:

java.lang.Exception

MaxConcurrentSearchException

getInstance

public IssueSearch getInstance(Module module,
                               IssueType issueType,
                               ScarabUser searcher)
                        throws java.lang.Exception,
                               MaxConcurrentSearchException

Throws:

java.lang.Exception

MaxConcurrentSearchException

getInstance

public IssueSearch getInstance(MITList mitList,
                               ScarabUser searcher)
                        throws java.lang.Exception,
                               MaxConcurrentSearchException

Throws:

java.lang.Exception

MaxConcurrentSearchException

register

void register()
        throws ScarabException,
               java.lang.InterruptedException

Throws:

ScarabException

java.lang.InterruptedException

notifyDone

public void notifyDone()