[ You are here:
XTF ->
Tag Reference -> Error Generator Stylesheet ]
Error Generator Stylesheet
The purpose of the
Error Generator stylesheet is to generate a web-page that displays user friendly messages when crossQuery or
dynaXML errors occur. Since its output is simply HTML, the only tags that this reference section covers are the input XML tags passed to the
Error Generator by the servlets.
For convenience, all of the error information passed into the
Error Generator stylesheet as XML tags is also available in the following XSLT parameters:
$exception |
A string containing the name of the exception that occurred. This will be the name of one of the error/exception tags listed below (e.g., ExcessiveWork, TermLimit, etc.) |
$message |
The descriptive message for the error/exception (if any; may be an empty string.) |
$stackTrace |
The HTML-Formatted Java Stack Trace generated by the exception, (if any; may be an empty string.) |
Query Format Error Tag
This error tag is issued by the
Query Parser or
Document Request Parser stylesheet if its code determines that there is an error in the query URL received from the user. It has the form:
<QueryFormat>
<message>Error Message</message>
</QueryFormat>
To generate such an error, the
Query Parser simply issues a
<error message="Error Message"/>
tag instead of a query tag. The error message specified by the parser's error tag is then transferred to the
Query Format Error Tag, for processing by the servlet's
Error Generator stylesheet.
Term Limit Error Tag
This error tag is issued by the
Query Parser or
Document Request Parser stylesheet if the number terms or clauses in a query exceeds the maximum term limit established by the
termLimit attribute of the
query tag produced by the
Query Parser. It has the form:
<TermLimit>
<message>Error Message</message>
</TermLimit>
This error is most often generated by the expansion of wildcard and range queries.
Excessive Work Error Tag
This error tag is issued by the
Query Parser or
Document Request Parser stylesheet if a query exceeds the maximum work limit established by the
workLimit attribute of the
query tag produced by the
Query Parser. It has the form:
<ExcessiveWork>
<message>Error Message</message>
</ExcessiveWork>
Invalid Document Error Tag
This error tag is issued by the dynaXML servlet if a document requested by the
Document Request Parser stylesheet (in the
<source> tag) cannot be located. This tag has the form:
<InvalidDocument>
<message>Error Message</message>
<docId>Document Identifier</message>
</InvalidDocument>
Usually, this error is generated when a request is made for a document that doesn't exist (for instance, it might have been removed, or the document ID might be invalid.)
No Permission Error Tag
This error tag is issued by the dynaXML servlet if the authentication (specified by the
Document Request Parser stylesheet) fails for some reason. For instance, if IP-based authentication has been specified, and the requestor's IP address isn't in the IP list, this error will be issued. This tag has the form:
<NoPermission>
<message>Error Message</message>
<ipAddr>IP Address</message>
</NoPermission>
Note that the IP address will only be included for requests that failed during IP-list authentication (and not for LDAP or external authentication, for example.)
Unsupported Query Error Tag
This error tag is issued by the dynaXML servlet if a document request issued by the
Document Request Parser stylesheet specifies a text query, and the document being queried is not present in the index. Searching can only be performed on documents that have been indexed. This tag has the form:
<UnsupportedQuery>
<message>Error Message</message>
</UnsupportedQuery>
Usually, this error is generated when a
query tag has been used in a document request without the required
index tag.
General Exception Error Tag
This error tag is generated whenever an internal exception occurs in any Servlet. This tag looks as follows:
<GeneralExceptionName>
<message>Error Message</message>
<stackTrace>HTML-Formatted Java Stack Trace</stackTrace>
</GeneralExceptionName>
Exceptions are usually generated by anomalous fatal conditions like missing required files, corrupted indexes, files locked by other applications, or bugs in the XTF code itself.