com.ebmwebsourcing.easycommons.xml
Class DocumentBuilderResourcePool

java.lang.Object
  com.ebmwebsourcing.easycommons.xml.DocumentBuilderResourcePool

public class DocumentBuilderResourcePool
extends java.lang.Object

This class represent a DocumentBuilder pool, which provided DocumentBuilder object as resource.

Author:

Nicolas Oddoux - EBM WebSourcing

Constructor Summary

DocumentBuilderResourcePool(int minPoolSize, int maxPoolSize, PoolPolicy poolPolicy)
Allowing to instantiate a new DocumentBuilderResourcePool containing DocumentBuilder resources.

Method Summary

void	release(javax.xml.parsers.DocumentBuilder documentBuilder) Release the specified DocumentBuilder After putting back the DocumentBuilder in the pool, the method onRelease() of the resource DocumentBuilder resource handler is called.
javax.xml.parsers.DocumentBuilder	take() Take one unused DocumentBuilder in the current pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentBuilderResourcePool

public DocumentBuilderResourcePool(int minPoolSize,
                                   int maxPoolSize,
                                   PoolPolicy poolPolicy)

Allowing to instantiate a new DocumentBuilderResourcePool containing DocumentBuilder resources.

Parameters:

minPoolSize - The minimum number of DocumentBuilder instances in the pool (created at the initialization).

maxPoolSize - the maximum number of DocumentBuilder instances in the current pool (limit of the pool). It must be greater or equals to the specified minSize. The maximum value is Integer.MAX_VALUE

poolPolicy - the PoolPolicy to adopt when the maximum size is reached. it must not be null.

Method Detail

take

public javax.xml.parsers.DocumentBuilder take()

Take one unused DocumentBuilder in the current pool. After getting a DocumentBuilder from the pool and before returning a DocumentBuilder, the method onTake() of the DocumentBuilder resource handler is called.

Returns:

one DocumentBuilder

Throws:

PoolException - if the current thread is interrupted for the pool policy WAIT or if there is no more available resource in the pool for the pool policy REJECT

release

public final void release(javax.xml.parsers.DocumentBuilder documentBuilder)

Release the specified DocumentBuilder After putting back the DocumentBuilder in the pool, the method onRelease() of the resource DocumentBuilder resource handler is called.

Parameters:

documentBuilder - The DocumentBuilder to release