org.opensaml.xml.parse
Class BasicParserPool.DocumentBuilderProxy

java.lang.Object
  javax.xml.parsers.DocumentBuilder
      org.opensaml.xml.parse.BasicParserPool.DocumentBuilderProxy

Enclosing class:

BasicParserPool

protected class BasicParserPool.DocumentBuilderProxy
extends javax.xml.parsers.DocumentBuilder

A proxy that prevents the manages document builders retrieved from the parser pool.

Constructor Summary

BasicParserPool.DocumentBuilderProxy(javax.xml.parsers.DocumentBuilder target, BasicParserPool owner, long version)
Constructor.

Method Summary

protected void	checkValidState() Check whether the parser is in a valid and usable state, and if not, throw a runtime exception.
protected void	finalize()
org.w3c.dom.DOMImplementation	getDOMImplementation()
protected ParserPool	getOwningPool() Gets the pool that owns this parser.
protected long	getPoolVersion() Gets the version of the pool that owns this parser at the time of the proxy's creation.
protected javax.xml.parsers.DocumentBuilder	getProxiedBuilder() Gets the proxied document builder.
javax.xml.validation.Schema	getSchema()
boolean	isNamespaceAware()
protected boolean	isReturned() Check accounting state as to whether this parser has been returned to the owning pool.
boolean	isValidating()
boolean	isXIncludeAware()
org.w3c.dom.Document	newDocument()
org.w3c.dom.Document	parse(java.io.File f)
org.w3c.dom.Document	parse(org.xml.sax.InputSource is)
org.w3c.dom.Document	parse(java.io.InputStream is)
org.w3c.dom.Document	parse(java.io.InputStream is, java.lang.String systemId)
org.w3c.dom.Document	parse(java.lang.String uri)
void	reset()
void	setEntityResolver(org.xml.sax.EntityResolver er)
void	setErrorHandler(org.xml.sax.ErrorHandler eh)
protected void	setReturned(boolean isReturned) Set accounting state as to whether this parser has been returned to the owning pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicParserPool.DocumentBuilderProxy

public BasicParserPool.DocumentBuilderProxy(javax.xml.parsers.DocumentBuilder target,
                                            BasicParserPool owner,
                                            long version)

Constructor.

Parameters:

target - document builder to proxy

owner - the owning pool

version - the owning pool's version

Method Detail

getDOMImplementation

public org.w3c.dom.DOMImplementation getDOMImplementation()

Specified by:

getDOMImplementation in class javax.xml.parsers.DocumentBuilder

getSchema

public javax.xml.validation.Schema getSchema()

Overrides:

getSchema in class javax.xml.parsers.DocumentBuilder

isNamespaceAware

public boolean isNamespaceAware()

Specified by:

isNamespaceAware in class javax.xml.parsers.DocumentBuilder

isValidating

public boolean isValidating()

Specified by:

isValidating in class javax.xml.parsers.DocumentBuilder

isXIncludeAware

public boolean isXIncludeAware()

Overrides:

isXIncludeAware in class javax.xml.parsers.DocumentBuilder

newDocument

public org.w3c.dom.Document newDocument()

Specified by:

newDocument in class javax.xml.parsers.DocumentBuilder

parse

public org.w3c.dom.Document parse(java.io.File f)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException

Overrides:

parse in class javax.xml.parsers.DocumentBuilder

Throws:

org.xml.sax.SAXException

java.io.IOException

parse

public org.w3c.dom.Document parse(org.xml.sax.InputSource is)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException

Specified by:

parse in class javax.xml.parsers.DocumentBuilder

Throws:

org.xml.sax.SAXException

java.io.IOException

parse

public org.w3c.dom.Document parse(java.io.InputStream is)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException

Overrides:

parse in class javax.xml.parsers.DocumentBuilder

Throws:

org.xml.sax.SAXException

java.io.IOException

parse

public org.w3c.dom.Document parse(java.io.InputStream is,
                                  java.lang.String systemId)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException

Overrides:

parse in class javax.xml.parsers.DocumentBuilder

Throws:

org.xml.sax.SAXException

java.io.IOException

parse

public org.w3c.dom.Document parse(java.lang.String uri)
                           throws org.xml.sax.SAXException,
                                  java.io.IOException

Overrides:

parse in class javax.xml.parsers.DocumentBuilder

Throws:

org.xml.sax.SAXException

java.io.IOException

reset

public void reset()

Overrides:

reset in class javax.xml.parsers.DocumentBuilder

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver er)

Specified by:

setEntityResolver in class javax.xml.parsers.DocumentBuilder

setErrorHandler

public void setErrorHandler(org.xml.sax.ErrorHandler eh)

Specified by:

setErrorHandler in class javax.xml.parsers.DocumentBuilder

getOwningPool

protected ParserPool getOwningPool()

Gets the pool that owns this parser.

Returns:

pool that owns this parser

getPoolVersion

protected long getPoolVersion()

Gets the version of the pool that owns this parser at the time of the proxy's creation.

Returns:

version of the pool that owns this parser at the time of the proxy's creation

getProxiedBuilder

protected javax.xml.parsers.DocumentBuilder getProxiedBuilder()

Gets the proxied document builder.

Returns:

proxied document builder

isReturned

protected boolean isReturned()

Check accounting state as to whether this parser has been returned to the owning pool.

Returns:

true if parser has been returned to the owning pool, otherwise false

setReturned

protected void setReturned(boolean isReturned)

Set accounting state as to whether this parser has been returned to the owning pool.

Parameters:

isReturned - set true to indicate that parser has been returned to the owning pool

checkValidState

protected void checkValidState()
                        throws java.lang.IllegalStateException

Check whether the parser is in a valid and usable state, and if not, throw a runtime exception.

Throws:

java.lang.IllegalStateException - thrown if the parser is in a state such that it can not be used

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable