Jakarta EE 11.0.0 · com.sun.faces.config.manager.tasks.ParseConfigResourceToDOMTask

Field Summary

Modifier and Type	Field and Description
private final URI	documentURI
private static final String	EMPTY_FACES_CONFIG
private static final String	FACELET_TAGLIB_TAGNAME
private static final String	FACES_CONFIG_TAGNAME
private static final String	FACES_TO_1_1_PRIVATE_XSL Stylesheet to convert 1.0 and 1.1 based faces-config documents to our private 1.1 schema for validation.
private DocumentBuilderFactory	factory
private static final Logger	LOGGER
private final ServletContext	servletContext
private final boolean	validating
public static final String	WEB_INF_MARKER Name of the attribute added by ParseTask to indicate a `Document` instance as a representation of `/WEB-INF/faces-config.xml`.

Constructor Summary

Access	Constructor and Description
public	ParseConfigResourceToDOMTask(ServletContext the servlet context. servletContext, boolean whether or not we're validating validating, URI a URL to the configuration resource to be parsed documentURI) Constructs a new ParseTask instance

Method Summary

Modifier and Type	Method and Description
public DocumentInfo	Returns: the result of the parse operation (a DOM) call() Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.
private Schema	findMatchingSchema(String documentNS, String version, String localName)
private DocumentBuilder	getBuilderForSchema(Schema schema)
private Document	Returns: `Document` based on `documentURI`. getDocument()
private Document	getEmptyFacesConfig(DocumentBuilder documentBuilder)
private static InputStream	Returns: an `InputStream` to the resource referred to by `url` getInputStream(URL source `URL` url)
private DocumentBuilder	getNonValidatingBuilder()
private static Transformer	Returns: a new Tranformer instance getTransformer(String documentNS) Obtain a `Transformer` using the style sheet referenced by the `XSL` constant.
private String	getVersion(Node documentElement)
private boolean	isNonFacesConfigDocument(String rootElementTagName)
private Document	loadDocument(Schema schema, DOMSource domSource)
private Document	loadDocument(Schema schema, DOMResult domResult)
private Document	parseDocumentFromURL(DocumentBuilder documentBuilder, URL documentURL)
private boolean	streamIsZeroLengthOrEmpty(InputStream is)
private static DOMResult	transformDocument(String documentNS, DOMSource domSource)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

documentURI	back to summary
private final URI documentURI

EMPTY_FACES_CONFIG	back to summary
private static final String EMPTY_FACES_CONFIG

FACELET_TAGLIB_TAGNAME	back to summary
private static final String FACELET_TAGLIB_TAGNAME

FACES_CONFIG_TAGNAME	back to summary
private static final String FACES_CONFIG_TAGNAME

FACES_TO_1_1_PRIVATE_XSL	back to summary
private static final String FACES_TO_1_1_PRIVATE_XSL Stylesheet to convert 1.0 and 1.1 based faces-config documents to our private 1.1 schema for validation.

factory	back to summary
private DocumentBuilderFactory factory

LOGGER	back to summary
private static final Logger LOGGER

servletContext	back to summary
private final ServletContext servletContext

validating	back to summary
private final boolean validating

WEB_INF_MARKER	back to summary
public static final String WEB_INF_MARKER Name of the attribute added by ParseTask to indicate a `Document` instance as a representation of `/WEB-INF/faces-config.xml`.

Constructor Detail

ParseConfigResourceToDOMTask	back to summary
public ParseConfigResourceToDOMTask(ServletContext servletContext, boolean validating, URI documentURI) throws Exception Constructs a new ParseTask instance Parameters servletContext:ServletContext the servlet context. validating:boolean whether or not we're validating documentURI:URI a URL to the configuration resource to be parsed Exceptions Exception: general error

ParseConfigResourceToDOMTask

back to summary

public ParseConfigResourceToDOMTask(ServletContext servletContext, boolean validating, URI documentURI) throws Exception

Constructs a new ParseTask instance

Parameters

servletContext:ServletContext: the servlet context.
validating:boolean: whether or not we're validating
documentURI:URI: a URL to the configuration resource to be parsed

Exceptions

Exception:: general error

Method Detail

call	back to summary
public DocumentInfo call() throws Exception Implements java.util.concurrent.Callable.call. Doc from java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so. Returns:DocumentInfo the result of the parse operation (a DOM) Annotations @Override Exceptions Exception: if an error occurs during the parsing process

call

back to summary

public DocumentInfo call() throws Exception

Implements java.util.concurrent.Callable.call.

Doc from java.util.concurrent.Callable.call.

Computes a result, or throws an exception if unable to do so.

Returns:DocumentInfo

the result of the parse operation (a DOM)

Annotations

@Override

Exceptions

Exception:: if an error occurs during the parsing process

findMatchingSchema	back to summary
private Schema findMatchingSchema(String documentNS, String version, String localName)

getBuilderForSchema	back to summary
private DocumentBuilder getBuilderForSchema(Schema schema) throws Exception

getDocument	back to summary
private Document getDocument() throws Exception Returns:Document `Document` based on `documentURI`. Exceptions Exception: if an error occurs during the process of building a `Document`

getEmptyFacesConfig	back to summary
private Document getEmptyFacesConfig(DocumentBuilder documentBuilder) throws SAXException, IOException

getInputStream	back to summary
private static InputStream getInputStream(URL url) throws IOException Parameters url:URL source `URL` Returns:InputStream an `InputStream` to the resource referred to by `url` Exceptions IOException: if an error occurs

getNonValidatingBuilder	back to summary
private DocumentBuilder getNonValidatingBuilder() throws Exception

getTransformer back to summary

getTransformer	back to summary
private static Transformer getTransformer(String documentNS) throws Exception Obtain a `Transformer` using the style sheet referenced by the `XSL` constant. Returns:Transformer a new Tranformer instance Exceptions Exception: if a Tranformer instance could not be created

private static Transformer getTransformer(String documentNS) throws Exception

Obtain a Transformer using the style sheet referenced by the XSL constant.

Returns:Transformer

a new Tranformer instance

Exceptions

Exception:: if a Tranformer instance could not be created

getVersion	back to summary
private String getVersion(Node documentElement)

isNonFacesConfigDocument	back to summary
private boolean isNonFacesConfigDocument(String rootElementTagName)

loadDocument	back to summary
private Document loadDocument(Schema schema, DOMSource domSource) throws Exception

loadDocument	back to summary
private Document loadDocument(Schema schema, DOMResult domResult) throws Exception

parseDocumentFromURL	back to summary
private Document parseDocumentFromURL(DocumentBuilder documentBuilder, URL documentURL) throws SAXException, IOException

streamIsZeroLengthOrEmpty	back to summary
private boolean streamIsZeroLengthOrEmpty(InputStream is) throws IOException

transformDocument	back to summary
private static DOMResult transformDocument(String documentNS, DOMSource domSource) throws Exception

public Class ParseConfigResourceToDOMTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail