BasicParserPool (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- org.opensaml.xml.parse.BasicParserPool

すべての実装されたインタフェース:

ParserPool
```
public class BasicParserPool
extends Object
implements ParserPool
```
A pool of JAXP 1.3 DocumentBuilders.
This implementation of ParserPool allows its properties to be modified over time and versions the builders it manages appropriately. There are certain performance penalties for doing this. For a more performant implementation that does not support versioning or property modification over time, see StaticBasicParserPool.

This is a pool implementation of the caching factory variety, and as such imposes no upper bound on the number of DocumentBuilders allowed to be concurrently checked out and in use. It does however impose a limit on the size of the internal cache of idle builder instances via the value configured via setMaxPoolSize(int).

Builders retrieved from this pool may (but are not required to) be returned to the pool with the method returnBuilder(DocumentBuilder). Builders checked out prior to a change in the pool's properties will not be effected by the change and will be appropriately dealt with when they are returned.

References to builders are kept by way of SoftReference so that the garbage collector may reap the builders if the system is running out of memory.

ネストされたクラスの概要

ネストされたクラス
修飾子とタイプ	クラスと説明
`protected class`	`BasicParserPool.DocumentBuilderProxy` A proxy that prevents the manages document builders retrieved from the parser pool.

コンストラクタの概要

コンストラクタ
コンストラクタと説明

BasicParserPool()
Constructor.

コンストラクタ
コンストラクタと説明
`BasicParserPool()` Constructor.

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`protected DocumentBuilder`	`createBuilder()` Creates a new document builder.
`DocumentBuilder`	`getBuilder()` Gets a builder from the pool.
`Map<String,Object>`	`getBuilderAttributes()` Gets the builder attributes used when creating builders.
`Map<String,Boolean>`	`getBuilderFeatures()` Gets the builders' features.
`boolean`	`getCreateBuildersAtPoolLimit()` 推奨されていません。
`boolean`	`getIgnoreComments()` Gets whether the builders ignore comments.
`int`	`getMaxPoolSize()` Gets the max number of builders the pool will hold.
`protected int`	`getPoolSize()` Gets the size of the current pool storage.
`protected long`	`getPoolVersion()` Gets the current pool version.
`Schema`	`getSchema()` Gets the schema builders use to validate.
`protected void`	`initializePool()` Initializes the pool with a new set of configuration options.
`boolean`	`isCoalescing()` Gets whether the builders are coalescing.
`boolean`	`isDTDValidating()` Gets whether the builders are validating.
`boolean`	`isExpandEntityReferences()` Gets whether builders expand entity references.
`boolean`	`isIgnoreElementContentWhitespace()` Get whether the builders ignore element content whitespace.
`boolean`	`isNamespaceAware()` Gets whether the builders are namespace aware.
`boolean`	`isXincludeAware()` Gets whether the builders are XInclude aware.
`Document`	`newDocument()` Convience method for creating a new document with a pooled builder.
`Document`	`parse(InputStream input)` Convience method for parsing an XML file using a pooled builder.
`Document`	`parse(Reader input)` Convience method for parsing an XML file using a pooled builder.
`void`	`returnBuilder(DocumentBuilder builder)` Returns a builder to the pool.
`protected void`	`setAttributes(DocumentBuilderFactory factory, Map<String,Object> attributes)` Sets document builder attributes.
`void`	`setBuilderAttributes(Map<String,Object> newAttributes)` Sets the builder attributes used when creating builders.
`void`	`setBuilderFeatures(Map<String,Boolean> newFeatures)` Sets the the builders' features.
`void`	`setCoalescing(boolean isCoalescing)` Sets whether the builders are coalescing.
`void`	`setCreateBuildersAtPoolLimit(boolean createBuilders)` 推奨されていません。
`void`	`setDTDValidating(boolean isValidating)` Sets whether the builders are validating.
`void`	`setExpandEntityReferences(boolean expand)` Sets whether builders expand entity references.
`protected void`	`setFeatures(DocumentBuilderFactory factory, Map<String,Boolean> features)` Sets document builder features.
`void`	`setIgnoreComments(boolean ignore)` Sets whether the builders ignore comments.
`void`	`setIgnoreElementContentWhitespace(boolean ignore)` Sets whether the builders ignore element content whitespace.
`void`	`setMaxPoolSize(int newSize)` Sets the max number of builders the pool will hold.
`void`	`setNamespaceAware(boolean isNamespaceAware)` Sets whether the builders are namespace aware.
`void`	`setSchema(Schema newSchema)` Sets the schema builders use to validate.
`void`	`setXincludeAware(boolean isXIncludeAware)` Sets whether the builders are XInclude aware.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - BasicParserPool
```
public BasicParserPool()
```
    Constructor.
- メソッドの詳細
  - getBuilder
```
public DocumentBuilder getBuilder()
                           throws XMLParserException
```
    Gets a builder from the pool.
    
    定義:
    
    getBuilder インタフェース内 ParserPool
    
    戻り値:
    a builder from the pool
    
    例外:
    
    XMLParserException - thrown if the document builder factory is misconfigured
  - returnBuilder
```
public void returnBuilder(DocumentBuilder builder)
```
    Returns a builder to the pool.
    
    定義:
    
    returnBuilder インタフェース内 ParserPool
    
    パラメータ:
    builder - the builder to return
  - newDocument
```
public Document newDocument()
                     throws XMLParserException
```
    Convience method for creating a new document with a pooled builder.
    
    定義:
    
    newDocument インタフェース内 ParserPool
    
    戻り値:
    created document
    
    例外:
    
    XMLParserException - thrown if there is a problem retrieving a builder
  - parse
```
public Document parse(InputStream input)
               throws XMLParserException
```
    Convience method for parsing an XML file using a pooled builder.
    
    定義:
    
    parse インタフェース内 ParserPool
    
    パラメータ:
    input - XML to parse
    
    戻り値:
    parsed document
    
    例外:
    
    XMLParserException - thrown if there is a problem retrieving a builder, the input stream can not be read, or the XML was invalid
  - parse
```
public Document parse(Reader input)
               throws XMLParserException
```
    Convience method for parsing an XML file using a pooled builder.
    
    定義:
    
    parse インタフェース内 ParserPool
    
    パラメータ:
    input - XML to parse
    
    戻り値:
    parsed document
    
    例外:
    
    XMLParserException - thrown if there is a problem retrieving a builder, the input stream can not be read, or the XML was invalid
  - getMaxPoolSize
```
public int getMaxPoolSize()
```
    Gets the max number of builders the pool will hold.
    
    戻り値:
    max number of builders the pool will hold
  - setMaxPoolSize
```
public void setMaxPoolSize(int newSize)
```
    Sets the max number of builders the pool will hold.
    
    パラメータ:
    newSize - max number of builders the pool will hold
  - getCreateBuildersAtPoolLimit
```
public boolean getCreateBuildersAtPoolLimit()
```
    推奨されていません。
    
    Gets whether new builders will be created when the max pool size is reached.
    Note this method is deprecated and will be removed in the next release. It is also currently functionally non-operational.
    
    戻り値:
    whether new builders will be created when the max pool size is reached
  - setCreateBuildersAtPoolLimit
```
public void setCreateBuildersAtPoolLimit(boolean createBuilders)
```
    推奨されていません。
    
    Sets whether new builders will be created when the max pool size is reached.
    Note this method is deprecated and will be removed in the next release. It is also currently functionally non-operational.
    
    パラメータ:
    createBuilders - whether new builders will be created when the max pool size is reached
  - getBuilderAttributes
```
public Map<String,Object> getBuilderAttributes()
```
    Gets the builder attributes used when creating builders. This collection is unmodifiable.
    
    戻り値:
    builder attributes used when creating builders
  - setBuilderAttributes
```
public void setBuilderAttributes(Map<String,Object> newAttributes)
```
    Sets the builder attributes used when creating builders.
    
    パラメータ:
    newAttributes - builder attributes used when creating builders
  - isCoalescing
```
public boolean isCoalescing()
```
    Gets whether the builders are coalescing.
    
    戻り値:
    whether the builders are coalescing
  - setCoalescing
```
public void setCoalescing(boolean isCoalescing)
```
    Sets whether the builders are coalescing.
    
    パラメータ:
    isCoalescing - whether the builders are coalescing
  - isExpandEntityReferences
```
public boolean isExpandEntityReferences()
```
    Gets whether builders expand entity references.
    
    戻り値:
    whether builders expand entity references
  - setExpandEntityReferences
```
public void setExpandEntityReferences(boolean expand)
```
    Sets whether builders expand entity references.
    
    パラメータ:
    expand - whether builders expand entity references
  - getBuilderFeatures
```
public Map<String,Boolean> getBuilderFeatures()
```
    Gets the builders' features. This collection is unmodifiable.
    
    戻り値:
    the builders' features
  - setBuilderFeatures
```
public void setBuilderFeatures(Map<String,Boolean> newFeatures)
```
    Sets the the builders' features.
    
    パラメータ:
    newFeatures - the builders' features
  - getIgnoreComments
```
public boolean getIgnoreComments()
```
    Gets whether the builders ignore comments.
    
    戻り値:
    whether the builders ignore comments
  - setIgnoreComments
```
public void setIgnoreComments(boolean ignore)
```
    Sets whether the builders ignore comments.
    
    パラメータ:
    ignore - The ignoreComments to set.
  - isIgnoreElementContentWhitespace
```
public boolean isIgnoreElementContentWhitespace()
```
    Get whether the builders ignore element content whitespace.
    
    戻り値:
    whether the builders ignore element content whitespace
  - setIgnoreElementContentWhitespace
```
public void setIgnoreElementContentWhitespace(boolean ignore)
```
    Sets whether the builders ignore element content whitespace.
    
    パラメータ:
    ignore - whether the builders ignore element content whitespace
  - isNamespaceAware
```
public boolean isNamespaceAware()
```
    Gets whether the builders are namespace aware.
    
    戻り値:
    whether the builders are namespace aware
  - setNamespaceAware
```
public void setNamespaceAware(boolean isNamespaceAware)
```
    Sets whether the builders are namespace aware.
    
    パラメータ:
    isNamespaceAware - whether the builders are namespace aware
  - getSchema
```
public Schema getSchema()
```
    Gets the schema builders use to validate.
    
    定義:
    
    getSchema インタフェース内 ParserPool
    
    戻り値:
    the schema builders use to validate
  - setSchema
```
public void setSchema(Schema newSchema)
```
    Sets the schema builders use to validate.
    
    定義:
    
    setSchema インタフェース内 ParserPool
    
    パラメータ:
    newSchema - the schema builders use to validate
  - isDTDValidating
```
public boolean isDTDValidating()
```
    Gets whether the builders are validating.
    
    戻り値:
    whether the builders are validating
  - setDTDValidating
```
public void setDTDValidating(boolean isValidating)
```
    Sets whether the builders are validating.
    
    パラメータ:
    isValidating - whether the builders are validating
  - isXincludeAware
```
public boolean isXincludeAware()
```
    Gets whether the builders are XInclude aware.
    
    戻り値:
    whether the builders are XInclude aware
  - setXincludeAware
```
public void setXincludeAware(boolean isXIncludeAware)
```
    Sets whether the builders are XInclude aware.
    
    パラメータ:
    isXIncludeAware - whether the builders are XInclude aware
  - getPoolVersion
```
protected long getPoolVersion()
```
    Gets the current pool version.
    
    戻り値:
    current pool version
  - getPoolSize
```
protected int getPoolSize()
```
    Gets the size of the current pool storage.
    
    戻り値:
    current pool storage size
  - initializePool
```
protected void initializePool()
                       throws XMLParserException
```
    Initializes the pool with a new set of configuration options.
    
    例外:
    
    XMLParserException - thrown if there is a problem initialzing the pool
  - setAttributes
```
protected void setAttributes(DocumentBuilderFactory factory,
                 Map<String,Object> attributes)
```
    Sets document builder attributes. If an attribute is not supported it is ignored.
    
    パラメータ:
    factory - document builder factory upon which the attribute will be set
    attributes - the set of attributes to be set
  - setFeatures
```
protected void setFeatures(DocumentBuilderFactory factory,
               Map<String,Boolean> features)
```
    Sets document builder features. If an features is not supported it is ignored.
    
    パラメータ:
    factory - document builder factory upon which the attribute will be set
    features - the set of features to be set
  - createBuilder
```
protected DocumentBuilder createBuilder()
                                 throws XMLParserException
```
    Creates a new document builder.
    
    戻り値:
    newly created document builder
    
    例外:
    
    XMLParserException - thrown if their is a configuration error with the builder factory

クラス BasicParserPool

ネストされたクラスの概要

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

BasicParserPool

メソッドの詳細

getBuilder

returnBuilder

newDocument

parse

parse

getMaxPoolSize

setMaxPoolSize

getCreateBuildersAtPoolLimit

setCreateBuildersAtPoolLimit

getBuilderAttributes

setBuilderAttributes

isCoalescing

setCoalescing

isExpandEntityReferences

setExpandEntityReferences

getBuilderFeatures

setBuilderFeatures

getIgnoreComments

setIgnoreComments

isIgnoreElementContentWhitespace

setIgnoreElementContentWhitespace

isNamespaceAware

setNamespaceAware

getSchema

setSchema

isDTDValidating

setDTDValidating

isXincludeAware

setXincludeAware

getPoolVersion

getPoolSize

initializePool

setAttributes

setFeatures

createBuilder