javax.servlet.jsp.tagext
public abstract class TagLibraryValidator extends Object
The TLD file associates a TagLibraryValidator class and some init arguments with a tag library.
The JSP container is reponsible for locating an appropriate instance of the appropriate subclass by
A TagLibraryValidator instance may create auxiliary objects internally to perform the validation (e.g. an XSchema validator) and may reuse it for all the pages in a given translation run.
The JSP container is not guaranteed to serialize invocations of validate() method, and TagLibraryValidators should perform any synchronization they may require.
As of JSP 2.0, a JSP container must provide a jsp:id attribute to provide higher quality validation errors. The container will track the JSP pages as passed to the container, and will assign to each element a unique "id", which is passed as the value of the jsp:id attribute. Each XML element in the XML view available will be extended with this attribute. The TagLibraryValidator can then use the attribute in one or more ValidationMessage objects. The container then, in turn, can use these values to provide more precise information on the location of an error.
The actual prefix of the id
attribute may or may not be
jsp
but it will always map to the namespace
http://java.sun.com/JSP/Page
. A TagLibraryValidator
implementation must rely on the uri, not the prefix, of the id
attribute.
Constructor Summary | |
---|---|
TagLibraryValidator()
Sole constructor. |
Method Summary | |
---|---|
Map | getInitParameters()
Get the init parameters data as an immutable Map.
|
void | release()
Release any data kept by this instance for validation purposes. |
void | setInitParameters(Map map)
Set the init data in the TLD for this validator.
|
ValidationMessage[] | validate(String prefix, String uri, PageData page)
Validate a JSP page.
|
Returns: The init parameters as an immutable map.
Parameters: map A Map describing the init parameters
Parameters: prefix the first prefix with which the tag library is associated, in the XML view. Note that some tags may use a different prefix if the namespace is redefined. uri the tag library's unique identifier page the JspData page object
Returns: A null object, or zero length array if no errors, an array of ValidationMessages otherwise.