Skip Headers

Oracle9i XML Reference
Release 1 (9.0.1)

Part Number A88899-01
Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index

Go to previous page Go to next page

3
Package oracle.xml.xsql

This package is also known as the XSQL Servlet.

Description

Class Summary 

 

Interfaces 

 

XSQLActionHandler 

Interface that must be implemented by all XSQL Action Element Handlers  

XSQLPageRequest 

Interface representing a request for an XSQL Page 

Classes 

 

Res 

 

XSQLActionHandlerImpl 

Base Implementation of XSQLActionHandler that can be extended to create your own custom handlers. 

XSQLCommandLine 

Command-line Utility to process XSQL Pages. 

XSQLDiagnostic 

 

XSQLHttpUtil 

 

XSQLPageRequestImpl 

Base implementation of the XSQLPageRequest interface that case be used to derive new kinds of page request implementations. 

XSQLParserHelper 

Common XML Parsing Routines 

XSQLRequest 

Programmatically process a request for an XSQL Page. 

XSQLServlet 

Servlet to enable HTTP GET-ing of and POST-ing to XSQL Pages 

XSQLServletPageRequest 

Implementation of XSQLPageRequest for Servlet-based XSQL Page requests. 

XSQLStylesheetProcessor 

XSLT Stylesheet Processing Engine 

XSQLUtil 

 


Res

Syntax

public class Res extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.xsql.Res

Description

Member Summary 

 

Fields 

 

CANTREAD_XSQL 

 

CANTREAD_XSQL_MSG 

 

CLASSNOTFOUND 

 

CLASSNOTFOUND_MSG 

 

CONN_FILE 

 

CONN_FILE_MSG 

 

ERR_OUTPUT 

 

ERR_OUTPUT_MSG 

 

ERRORINCLUDING 

 

ERRORINCLUDING_MSG 

 

ERRORLOADINGURL 

 

ERRORLOADINGURL_MSG 

 

ERRORREADINGPARAM 

 

ERRORREADINGPARAM_MSG 

 

FATAL_SHEETPOOL 

 

FATAL_SHEETPOOL_MSG 

 

ILLFORMEDXMLPARAMVAL 

 

ILLFORMEDXMLPARAMVAL_MSG 

 

ILLFORMEDXMLRESOURCE 

 

ILLFORMEDXMLRESOURCE_MSG 

 

INSTANTIATIONERR 

 

INSTANTIATIONERR_MSG 

 

INVALID_URI 

 

INVALID_URI_MSG 

 

INVALIDURL 

 

INVALIDURL_MSG 

 

MISSING_ARGS 

 

MISSING_ARGS_MSG 

 

MISSING_ATTR 

 

MISSING_ATTR_MSG 

 

NAMED_CONN 

 

NAMED_CONN_MSG 

 

NO_CONN 

 

NO_CONN_DEF 

 

NO_CONN_DEF_MSG 

 

NO_CONN_MSG 

 

NO_XSQL_FILE 

 

NO_XSQL_FILE_MSG 

 

NOFUNCTIONNAME 

 

NOFUNCTIONNAME_MSG 

 

NOPOSTEDXML 

 

NOPOSTEDXML_MSG 

 

NOQUERYSUPPLIED 

 

NOQUERYSUPPLIED_MSG 

 

NOTANACTIONHANDLER 

 

NOTANACTIONHANDLER_MSG 

 

NULLPARAM 

 

NULLPARAM_MSG 

 

OWAXMLMALFORMED 

 

OWAXMLMALFORMED_MSG 

 

POSTEDXML_ERR 

 

POSTEDXML_ERR_MSG 

 

UNHANDLED_ERR 

 

UNHANDLED_ERR_MSG 

 

UNHANDLED_ERR_XSL_PR 

 

UNHANDLED_ERR_XSL_PR_MSG 

 

UNHANDLED_ERR_XSL_RD 

 

UNHANDLED_ERR_XSL_RD_MSG 

 

XML_INS_ERR 

 

XML_INS_ERR_MSG 

 

XML_PARSE 

 

XML_PARSE_MSG 

 

XML_SQL_ERR 

 

XML_SQL_ERR_MSG 

 

XSL_ERRORS 

 

XSL_ERRORS_MSG 

 

XSL_NOFILE 

 

XSL_NOFILE_MSG 

 

XSL_PARSE 

 

XSL_PARSE_MSG 

 

XSLNOTFOUND 

 

XSLNOTFOUND_MSG 

 

Constructors 

 

Res() 

 

Methods 

 

format(int, String) 

 

getString(int) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Fields

CANTREAD_XSQL

public static final int CANTREAD_XSQL

CANTREAD_XSQL_MSG

public static final java.lang.String CANTREAD_XSQL_MSG

CLASSNOTFOUND

public static final int CLASSNOTFOUND

CLASSNOTFOUND_MSG

public static final java.lang.String CLASSNOTFOUND_MSG

CONN_FILE

public static final int CONN_FILE

CONN_FILE_MSG

public static final java.lang.String CONN_FILE_MSG

ERR_OUTPUT

public static final int ERR_OUTPUT

ERR_OUTPUT_MSG

public static final java.lang.String ERR_OUTPUT_MSG

ERRORINCLUDING

public static final int ERRORINCLUDING

ERRORINCLUDING_MSG

public static final java.lang.String ERRORINCLUDING_MSG

ERRORLOADINGURL

public static final int ERRORLOADINGURL

ERRORLOADINGURL_MSG

public static final java.lang.String ERRORLOADINGURL_MSG

ERRORREADINGPARAM

public static final int ERRORREADINGPARAM

ERRORREADINGPARAM_MSG

public static final java.lang.String ERRORREADINGPARAM_MSG

FATAL_SHEETPOOL

public static final int FATAL_SHEETPOOL

FATAL_SHEETPOOL_MSG

public static final java.lang.String FATAL_SHEETPOOL_MSG

ILLFORMEDXMLPARAMVAL

public static final int ILLFORMEDXMLPARAMVAL

ILLFORMEDXMLPARAMVAL_MSG

public static final java.lang.String ILLFORMEDXMLPARAMVAL_MSG

ILLFORMEDXMLRESOURCE

public static final int ILLFORMEDXMLRESOURCE

ILLFORMEDXMLRESOURCE_MSG

public static final java.lang.String ILLFORMEDXMLRESOURCE_MSG

INSTANTIATIONERR

public static final int INSTANTIATIONERR

INSTANTIATIONERR_MSG

public static final java.lang.String INSTANTIATIONERR_MSG

INVALID_URI

public static final int INVALID_URI

INVALID_URI_MSG

public static final java.lang.String INVALID_URI_MSG

INVALIDURL

public static final int INVALIDURL

INVALIDURL_MSG

public static final java.lang.String INVALIDURL_MSG

MISSING_ARGS

public static final int MISSING_ARGS

MISSING_ARGS_MSG

public static final java.lang.String MISSING_ARGS_MSG

MISSING_ATTR

public static final int MISSING_ATTR

MISSING_ATTR_MSG

public static final java.lang.String MISSING_ATTR_MSG

NAMED_CONN

public static final int NAMED_CONN

NAMED_CONN_MSG

public static final java.lang.String NAMED_CONN_MSG

NO_CONN

public static final int NO_CONN

NO_CONN_DEF

public static final int NO_CONN_DEF

NO_CONN_DEF_MSG

public static final java.lang.String NO_CONN_DEF_MSG

NO_CONN_MSG

public static final java.lang.String NO_CONN_MSG

NO_XSQL_FILE

public static final int NO_XSQL_FILE

NO_XSQL_FILE_MSG

public static final java.lang.String NO_XSQL_FILE_MSG

NOFUNCTIONNAME

public static final int NOFUNCTIONNAME

NOFUNCTIONNAME_MSG

public static final java.lang.String NOFUNCTIONNAME_MSG

NOPOSTEDXML

public static final int NOPOSTEDXML

NOPOSTEDXML_MSG

public static final java.lang.String NOPOSTEDXML_MSG

NOQUERYSUPPLIED

public static final int NOQUERYSUPPLIED

NOQUERYSUPPLIED_MSG

public static final java.lang.String NOQUERYSUPPLIED_MSG

NOTANACTIONHANDLER

public static final int NOTANACTIONHANDLER

NOTANACTIONHANDLER_MSG

public static final java.lang.String NOTANACTIONHANDLER_MSG

NULLPARAM

public static final int NULLPARAM

NULLPARAM_MSG

public static final java.lang.String NULLPARAM_MSG

OWAXMLMALFORMED

public static final int OWAXMLMALFORMED

OWAXMLMALFORMED_MSG

public static final java.lang.String OWAXMLMALFORMED_MSG

POSTEDXML_ERR

public static final int POSTEDXML_ERR

POSTEDXML_ERR_MSG

public static final java.lang.String POSTEDXML_ERR_MSG

UNHANDLED_ERR

public static final int UNHANDLED_ERR

UNHANDLED_ERR_MSG

public static final java.lang.String UNHANDLED_ERR_MSG

UNHANDLED_ERR_XSL_PR

public static final int UNHANDLED_ERR_XSL_PR

UNHANDLED_ERR_XSL_PR_MSG

public static final java.lang.String UNHANDLED_ERR_XSL_PR_MSG

UNHANDLED_ERR_XSL_RD

public static final int UNHANDLED_ERR_XSL_RD

UNHANDLED_ERR_XSL_RD_MSG

public static final java.lang.String UNHANDLED_ERR_XSL_RD_MSG

XML_INS_ERR

public static final int XML_INS_ERR

XML_INS_ERR_MSG

public static final java.lang.String XML_INS_ERR_MSG

XML_PARSE

public static final int XML_PARSE

XML_PARSE_MSG

public static final java.lang.String XML_PARSE_MSG

XML_SQL_ERR

public static final int XML_SQL_ERR

XML_SQL_ERR_MSG

public static final java.lang.String XML_SQL_ERR_MSG

XSL_ERRORS

public static final int XSL_ERRORS

XSL_ERRORS_MSG

public static final java.lang.String XSL_ERRORS_MSG

XSL_NOFILE

public static final int XSL_NOFILE

XSL_NOFILE_MSG

public static final java.lang.String XSL_NOFILE_MSG

XSL_PARSE

public static final int XSL_PARSE

XSL_PARSE_MSG

public static final java.lang.String XSL_PARSE_MSG

XSLNOTFOUND

public static final int XSLNOTFOUND

XSLNOTFOUND_MSG

public static final java.lang.String XSLNOTFOUND_MSG

Constructors

Res()

public  Res()

Methods

format(int, String)

public static java.lang.String format(int id, java.lang.String s)

getString(int)

public static java.lang.String getString(int id)

XSQLActionHandler

Syntax

public interface XSQLActionHandler

All Known Implementing Classes:

XSQLActionHandlerImpl

Description

Interface that must be implemented by all XSQL Action Element Handlers

Upon encountering an XSQL Action Element of the form <xsql:xxxx> in an XSQL page, the XSQL Page Processor invokes the associated XSQL Action Handler by:

Constructing an instance of the handler using the no-args constructor

Invoking the XSQL Action Handler's handleAction() method

NOTE: conn parameter can be null if no connection specified for the XSQL page being processed.

Member Summary 

 

Methods 

 

handleAction(Node) 

Handle the action, typically by executing some code and appending new child DOM nodes to the rootNode. 

init(XSQLPageRequest, Element) 

Initialize the Action Handler 

Methods

handleAction(Node)

public void handleAction(oracle.xml.xsql.Node rootNode)

Handle the action, typically by executing some code and appending new child DOM nodes to the rootNode.

The XSQL Page Processor replaces the action element in the XSQL Page being processed with the document fragment of nodes that your handleAction method appends to the rootNode.

Parameters:

rootNode - Root node of generated document fragment

init(XSQLPageRequest, Element)

public void init(XSQLPageRequest env, oracle.xml.xsql.Element e)

Initialize the Action Handler

Parameters:

env - XSQLPageRequest object

e - DOM element representing the Action Element being handled


XSQLActionHandlerImpl

Syntax

public abstract class XSQLActionHandlerImpl extends java.lang.Object implements 
XSQLActionHandler
 
java.lang.Object
  |
  +--oracle.xml.xsql.XSQLActionHandlerImpl

All Implemented Interfaces:

XSQLActionHandler

Description

Base Implementation of XSQLActionHandler that can be extended to create your own custom handlers.

Includes a set of useful helper methods.

NOTE: If you extend this class and override the init() method, make sure to call:

super.init(env,e);

Member Summary 

 

Constructors 

 

XSQLActionHandlerImpl() 

 

Methods 

 

init(XSQLPageRequest, Element) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Methods inherited from interface XSQLActionHandler 

handleAction(Node) 

Constructors

XSQLActionHandlerImpl()

public  XSQLActionHandlerImpl()

Methods

init(XSQLPageRequest, Element)

public void init(XSQLPageRequest env, oracle.xml.xsql.Element e)

Specified By:

init(XSQLPageRequest, Element) in interface XSQLActionHandler


XSQLCommandLine

Syntax

public final class XSQLCommandLine extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.xsql.XSQLCommandLine

Description

Command-line Utility to process XSQL Pages.

Member Summary 

 

Constructors 

 

XSQLCommandLine() 

 

Methods 

 

main(String[]) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Constructors

XSQLCommandLine()

public  XSQLCommandLine()

Methods

main(String[])

public static void main(java.lang.String[] args)

XSQLDiagnostic

Syntax

public final class XSQLDiagnostic extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.xsql.XSQLDiagnostic

Description

Member Summary 

 

Constructors 

 

XSQLDiagnostic(String) 

 

Methods 

 

debugPrintToFile(String, String) 

 

msg(String) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Constructors

XSQLDiagnostic(String)

public  XSQLDiagnostic(java.lang.String diagFile)

Methods

debugPrintToFile(String, String)

public static void debugPrintToFile(java.lang.String msg, java.lang.String 
filename)

msg(String)

public void msg(java.lang.String text)

XSQLHttpUtil

Syntax

public final class XSQLHttpUtil extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.xsql.XSQLHttpUtil

Description

Member Summary 

 

Constructors 

 

XSQLHttpUtil() 

 

Methods 

 

HttpRequestAsXMLDocument(HttpServletRequest, String) 

 

XL(String, String) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Constructors

XSQLHttpUtil()

public  XSQLHttpUtil()

Methods

HttpRequestAsXMLDocument(HttpServletRequest, String)

public static oracle.xml.xsql.XMLDocument 
HttpRequestAsXMLDocument(oracle.xml.xsql.HttpServletRequest req, 
java.lang.String XSQLPageEncoding)

XL(String, String)

public static java.lang.String XL(java.lang.String s, java.lang.String enc)

XSQLPageRequest

Syntax

public interface XSQLPageRequest

All Known Implementing Classes:

XSQLPageRequestImpl

Description

Interface representing a request for an XSQL Page

Member Summary 

 

Methods 

 

createNestedRequest(URL, Dictionary) 

Returns an instance of a nested Request 

getConnectionName() 

Returns the name of the connection being used for this request May be null if no connection set/in-use. 

getErrorWriter() 

Returns a PrintWriter to print out errors processing this request 

getJDBCConnection() 

Gets the JDBC connection being used for this request (can be null) 

getPageEncoding() 

Returns encoding of source XSQL Page associated with this request 

getParameter(String) 

Returns the value of the requested parameter 

getPostedDocument() 

Returns the content of Posted XML for this request as an XML Document 

getRequestParamsAsXMLDocument() 

Returns the content of a Request parameters as an XML Document 

getRequestType() 

Returns a string identifying the type of page request being made. 

getSourceDocumentURI() 

Returns a String representation of the requested document's URI 

getStylesheetParameter(String) 

Gets a stylesheet parameter by name 

getStylesheetParameters() 

Gets an enumeration of stylesheet parameter names 

getStylesheetURI() 

Returns the URI of the stylesheet to be used to process the result. 

getUserAgent() 

Returns a String identifier of the requesting program 

getWriter() 

Returns a PrintWriter used for writing out the results of a page request 

getXSQLConnection() 

Gets the XSQLConnection Object being used for this request Might be null. 

isIncludedRequest() 

Returns true if this request is being included in another. 

isOracleDriver() 

Returns true if the current connection uses the Oracle JDBC Driver 

printedErrorHeader() 

Returns the state of whether an Error Header has been printed 

requestProcessed() 

Allows Page Request to Perform end-of-request processing 

setConnectionName(String) 

Sets the connection name to use for this request 

setContentType(String) 

Sets the content type of the resulting page 

setIncludingRequest(XSQLPageRequest) 

Sets the Including Page Request object for this request. 

setPageEncoding(String) 

Sets encoding of source XSQL page associated with this request. 

setPageParam(String, String) 

Sets a dynamic page parameter value. 

setPostedDocument(Document) 

Allows programmatic setting of the Posted Document 

setPrintedErrorHeader(boolean) 

Sets whether an Error Header has been printed 

setStylesheetParameter(String, String) 

Sets the value of a parameter to be passed to the associated stylesheet 

setStylesheetURI(String) 

Sets the URI of the stylesheet to be used to process the result. 

translateURL(String) 

Returns a string representing an absolute URL resolved relative to the base URI for this request. 

useConnectionPooling() 

Returns true if connection pooling is desired for this request 

useHTMLErrors() 

Returns true if HTML-formatted error messages are desired for this request 

Methods

createNestedRequest(URL, Dictionary)

public XSQLPageRequest createNestedRequest(java.net.URL pageurl, 
java.util.Dictionary params)

Returns an instance of a nested Request

getConnectionName()

public java.lang.String getConnectionName()

Returns the name of the connection being used for this request May be null if no connection set/in-use.

getErrorWriter()

public java.io.PrintWriter getErrorWriter()

Returns a PrintWriter to print out errors processing this request

getJDBCConnection()

public java.sql.Connection getJDBCConnection()

Gets the JDBC connection being used for this request (can be null)

getPageEncoding()

public java.lang.String getPageEncoding()

Returns encoding of source XSQL Page associated with this request

getParameter(String)

public java.lang.String getParameter(java.lang.String name)

Returns the value of the requested parameter

Parameters:

name - the name of the parameter

getPostedDocument()

public oracle.xml.xsql.Document getPostedDocument()

Returns the content of Posted XML for this request as an XML Document

getRequestParamsAsXMLDocument()

public oracle.xml.xsql.Document getRequestParamsAsXMLDocument()

Returns the content of a Request parameters as an XML Document

getRequestType()

public java.lang.String getRequestType()

Returns a string identifying the type of page request being made.

getSourceDocumentURI()

public java.lang.String getSourceDocumentURI()

Returns a String representation of the requested document's URI

getStylesheetParameter(String)

public java.lang.String getStylesheetParameter(java.lang.String name)

Gets a stylesheet parameter by name

getStylesheetParameters()

public java.util.Enumeration getStylesheetParameters()

Gets an enumeration of stylesheet parameter names

getStylesheetURI()

public java.lang.String getStylesheetURI()

Returns the URI of the stylesheet to be used to process the result.

getUserAgent()

public java.lang.String getUserAgent()

Returns a String identifier of the requesting program

getWriter()

public java.io.PrintWriter getWriter()

Returns a PrintWriter used for writing out the results of a page request

getXSQLConnection()

public oracle.xml.xsql.XSQLConnection getXSQLConnection()

Gets the XSQLConnection Object being used for this request Might be null.

isIncludedRequest()

public boolean isIncludedRequest()

Returns true if this request is being included in another.

isOracleDriver()

public boolean isOracleDriver()

Returns true if the current connection uses the Oracle JDBC Driver

printedErrorHeader()

public boolean printedErrorHeader()

Returns the state of whether an Error Header has been printed

requestProcessed()

public void requestProcessed()

Allows Page Request to Perform end-of-request processing

setConnectionName(String)

public void setConnectionName(java.lang.String connName)

Sets the connection name to use for this request

setContentType(String)

public void setContentType(java.lang.String mimetype)

Sets the content type of the resulting page

setIncludingRequest(XSQLPageRequest)

public void setIncludingRequest(XSQLPageRequest includingEnv)

Sets the Including Page Request object for this request.

setPageEncoding(String)

public void setPageEncoding(java.lang.String enc)

Sets encoding of source XSQL page associated with this request.

setPageParam(String, String)

public void setPageParam(java.lang.String name, java.lang.String value)

Sets a dynamic page parameter value.

setPostedDocument(Document)

public void setPostedDocument(oracle.xml.xsql.Document doc)

Allows programmatic setting of the Posted Document

setPrintedErrorHeader(boolean)

public void setPrintedErrorHeader(boolean yes)

Sets whether an Error Header has been printed

setStylesheetParameter(String, String)

public void setStylesheetParameter(java.lang.String name, java.lang.String 
value)

Sets the value of a parameter to be passed to the associated stylesheet

setStylesheetURI(String)

public void setStylesheetURI(java.lang.String uri)

Sets the URI of the stylesheet to be used to process the result.

translateURL(String)

public java.lang.String translateURL(java.lang.String url)

Returns a string representing an absolute URL resolved relative to the base URI for this request.

useConnectionPooling()

public boolean useConnectionPooling()

Returns true if connection pooling is desired for this request

useHTMLErrors()

public boolean useHTMLErrors()

Returns true if HTML-formatted error messages are desired for this request

setRequestObject

void setRequestObject(java.lang.String name, java.lang.Object obj)

Sets a request-scope object

getRequestObject

java.lang.Object getRequestObject(java.lang.String name)

Gets a request-scope object


XSQLPageRequestImpl

Syntax

public abstract class XSQLPageRequestImpl extends java.lang.Object implements 
XSQLPageRequest
 
java.lang.Object
  |
  +--oracle.xml.xsql.XSQLPageRequestImpl

Direct Known Subclasses:

XSQLServletPageRequest

All Implemented Interfaces:

XSQLPageRequest

Description

Base implementation of the XSQLPageRequest interface that case be used to derive new kinds of page request implementations.

Member Summary 

 

Constructors 

 

XSQLPageRequestImpl() 

 

XSQLPageRequestImpl(Hashtable) 

 

XSQLPageRequestImpl(String, Hashtable) 

 

Methods 

 

getConnectionName() 

Returns the name of the connection being used for this request May be null if no connection set/in-use. 

getErrorWriter() 

 

getJDBCConnection() 

Gets the JDBC connection being used for this request (can be null) 

getPageEncoding() 

Returns encoding of source XSQL Page associated with this request 

getParameter(String) 

 

getPostedDocument() 

 

getRequestParamsAsXMLDocument() 

 

getSourceDocumentURI() 

 

getStylesheetParameter(String) 

Gets a stylesheet parameter by name 

getStylesheetParameters() 

Gets an enumeration of stylesheet parameter names 

getStylesheetURI() 

 

getUserAgent() 

 

getWriter() 

 

getXSQLConnection() 

Gets the XSQLConnection Object being used for this request Might be null. 

isIncludedRequest() 

Returns true if this request is being included in another. 

isOracleDriver() 

Returns true if the current connection uses the Oracle JDBC Driver 

printedErrorHeader() 

 

requestProcessed() 

Allows Page Request to Perform end-of-request processing 

setConnectionName(String) 

Sets the connection being used for this request (can be null) 

setContentType(String) 

 

setIncludingRequest(XSQLPageRequest) 

Sets the Including Page Request object for this request. 

setPageEncoding(String) 

Associates an XSQL Page with the request 

setPageParam(String, String) 

Sets a dynamic page parameter value. 

setPostedDocument(Document) 

 

setPrintedErrorHeader(boolean) 

 

setStylesheetParameter(String, String) 

 

setStylesheetURI(String) 

 

translateURL(String) 

 

useConnectionPooling() 

 

useHTMLErrors() 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Methods inherited from interface XSQLPageRequest 

createNestedRequest(URL, Dictionary), getRequestType() 

Constructors

XSQLPageRequestImpl()

public  XSQLPageRequestImpl()

XSQLPageRequestImpl(Hashtable)

public  XSQLPageRequestImpl(java.util.Hashtable parameters)

XSQLPageRequestImpl(String, Hashtable)

public  XSQLPageRequestImpl(java.lang.String pageurl, java.util.Hashtable 
parameters)

Methods

getConnectionName()

public java.lang.String getConnectionName()

Returns the name of the connection being used for this request May be null if no connection set/in-use.

Specified By:

getConnectionName() in interface XSQLPageRequest

getErrorWriter()

public java.io.PrintWriter getErrorWriter()

Specified By:

getErrorWriter() in interface XSQLPageRequest

getJDBCConnection()

public java.sql.Connection getJDBCConnection()

Gets the JDBC connection being used for this request (can be null)

Specified By:

getJDBCConnection() in interface XSQLPageRequest

getPageEncoding()

public java.lang.String getPageEncoding()

Returns encoding of source XSQL Page associated with this request

Specified By:

getPageEncoding() in interface XSQLPageRequest

getParameter(String)

public java.lang.String getParameter(java.lang.String name)

Specified By:

getParameter(String) in interface XSQLPageRequest

getPostedDocument()

public oracle.xml.xsql.Document getPostedDocument()

Specified By:

getPostedDocument() in interface XSQLPageRequest

getRequestParamsAsXMLDocument()

public oracle.xml.xsql.Document getRequestParamsAsXMLDocument()

Specified By:

getRequestParamsAsXMLDocument() in interface XSQLPageRequest

getSourceDocumentURI()

public java.lang.String getSourceDocumentURI()

Specified By:

getSourceDocumentURI() in interface XSQLPageRequest

getStylesheetParameter(String)

public java.lang.String getStylesheetParameter(java.lang.String name)

Gets a stylesheet parameter by name

Specified By:

getStylesheetParameter(String) in interface XSQLPageRequest

getStylesheetParameters()

public java.util.Enumeration getStylesheetParameters()

Gets an enumeration of stylesheet parameter names

Specified By:

getStylesheetParameters() in interface XSQLPageRequest

getStylesheetURI()

public java.lang.String getStylesheetURI()

Specified By:

getStylesheetURI() in interface XSQLPageRequest

getUserAgent()

public java.lang.String getUserAgent()

Specified By:

getUserAgent() in interface XSQLPageRequest

getWriter()

public java.io.PrintWriter getWriter()

Specified By:

getWriter() in interface XSQLPageRequest

getXSQLConnection()

public oracle.xml.xsql.XSQLConnection getXSQLConnection()

Gets the XSQLConnection Object being used for this request Might be null.

Specified By:

getXSQLConnection() in interface XSQLPageRequest

isIncludedRequest()

public boolean isIncludedRequest()

Returns true if this request is being included in another.

Specified By:

isIncludedRequest() in interface XSQLPageRequest

isOracleDriver()

public boolean isOracleDriver()

Returns true if the current connection uses the Oracle JDBC Driver

Specified By:

isOracleDriver() in interface XSQLPageRequest

printedErrorHeader()

public boolean printedErrorHeader()

Specified By:

printedErrorHeader() in interface XSQLPageRequest

requestProcessed()

public void requestProcessed()

Allows Page Request to Perform end-of-request processing

Specified By:

requestProcessed() in interface XSQLPageRequest

setConnectionName(String)

public void setConnectionName(java.lang.String connName)

Sets the connection being used for this request (can be null)

Specified By:

setConnectionName(String) in interface XSQLPageRequest

setContentType(String)

public void setContentType(java.lang.String mimetype)

Specified By:

setContentType(String) in interface XSQLPageRequest

setIncludingRequest(XSQLPageRequest)

public void setIncludingRequest(XSQLPageRequest includingEnv)

Sets the Including Page Request object for this request.

Specified By:

setIncludingRequest(XSQLPageRequest) in interface XSQLPageRequest

setPageEncoding(String)

public void setPageEncoding(java.lang.String enc)

Associates an XSQL Page with the request

Specified By:

setPageEncoding(String) in interface XSQLPageRequest

setPageParam(String, String)

public void setPageParam(java.lang.String name, java.lang.String value)

Sets a dynamic page parameter value.

Specified By:

setPageParam(String, String) in interface XSQLPageRequest

setPostedDocument(Document)

public void setPostedDocument(oracle.xml.xsql.Document doc)

Specified By:

setPostedDocument(Document) in interface XSQLPageRequest

setPrintedErrorHeader(boolean)

public void setPrintedErrorHeader(boolean yes)

Specified By:

setPrintedErrorHeader(boolean) in interface XSQLPageRequest

setStylesheetParameter(String, String)

public void setStylesheetParameter(java.lang.String name, java.lang.String 
value)

Specified By:

setStylesheetParameter(String, String) in interface XSQLPageRequest

setStylesheetURI(String)

public void setStylesheetURI(java.lang.String uri)

Specified By:

setStylesheetURI(String) in interface XSQLPageRequest

translateURL(String)

public java.lang.String translateURL(java.lang.String filename)

Specified By:

translateURL(String) in interface XSQLPageRequest

useConnectionPooling()

public boolean useConnectionPooling()

Specified By:

useConnectionPooling() in interface XSQLPageRequest

useHTMLErrors()

public boolean useHTMLErrors()

Specified By:

useHTMLErrors() in interface XSQLPageRequest

setRequestObject

void setRequestObject(java.lang.String name, java.lang.Object obj)

Sets a request-scope object

getRequestObject

java.lang.Object getRequestObject(java.lang.String name)

Gets a request-scope object


XSQLParserHelper

Syntax

public final class XSQLParserHelper extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.xsql.XSQLParserHelper

Description

Common XML Parsing Routines

Member Summary 

 

Constructors 

 

XSQLParserHelper() 

 

Methods 

 

newDocument() 

 

parse(InputStream, URL, PrintWriter) 

 

parse(Reader, PrintWriter) 

 

parse(URL, PrintWriter) 

 

parseFromString(StringBuffer, PrintWriter) 

 

parseFromString(String, PrintWriter) 

 

print(Document, PrintWriter) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Constructors

XSQLParserHelper()

public  XSQLParserHelper()

Methods

newDocument()

public static oracle.xml.xsql.Document newDocument()

parse(InputStream, URL, PrintWriter)

public static oracle.xml.xsql.Document parse(java.io.InputStream is, 
java.net.URL baseUrl, java.io.PrintWriter errorWriter)

parse(Reader, PrintWriter)

public static oracle.xml.xsql.Document parse(java.io.Reader r, 
java.io.PrintWriter errorWriter)

parse(URL, PrintWriter)

public static oracle.xml.xsql.Document parse(java.net.URL url, 
java.io.PrintWriter errorWriter)

parseFromString(StringBuffer, PrintWriter)

public static oracle.xml.xsql.Document parseFromString(java.lang.StringBuffer 
xmlString, java.io.PrintWriter errorWriter)

parseFromString(String, PrintWriter)

public static oracle.xml.xsql.Document parseFromString(java.lang.String 
xmlString, java.io.PrintWriter errorWriter)

print(Document, PrintWriter)

public static void print(oracle.xml.xsql.Document d, java.io.PrintWriter out)

XSQLRequest

Syntax

public class XSQLRequest extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.xsql.XSQLRequest

Description

Programmatically process a request for an XSQL Page.

Member Summary 

 

Constructors 

 

XSQLRequest(String) 

Create a Request for an XSQL Page 

XSQLRequest(String, XSQLPageRequest) 

Create a Request for an XSQL Page 

XSQLRequest(URL) 

Create a Request for an XSQL Page 

XSQLRequest(oracle.xml.parser.v2.XMLDocument page, java.net.URL baseURL)

 

Create a Request for an XSQL Page

 

XSQLRequest(XSQLConnectionManagerFactory fact, java.lang.String url)

 

Create a Request for an XSQL Page using a custom connection manager factory

 

XSQLRequest(XSQLConnectionManagerFactory fact, java.net.URL url)

 

Create a Request for an XSQL Page with a custom connection manager factory.

 

XSQLRequest(XSQLConnectionManagerFactory fact, oracle.xml.parser.v2.XMLDocument page, java.net.URL baseURL)

 

Create a Request for an XSQL Page

 

XSQLRequest(URL, XSQLPageRequest) 

Create a Request for an XSQL Page 

Methods 

 

process() 

Process the request, writing output/errors to System.out/System.err 

process(Dictionary) 

Process the request, writing output/errors to System.out/System.err 

process(Dictionary, PrintWriter, PrintWriter) 

Process the request, writing output/errors to respective PrintWriters 

process(PrintWriter, PrintWriter) 

Process the request, writing output/errors to respective PrintWriters 

processToXML() 

Process the request, writing output/errors to System.out/System.err 

processToXML(Dictionary) 

Process the request, writing output/errors to System.out/System.err 

processToXML(Dictionary, PrintWriter) 

Process the request, writing output/errors to respective PrintWriters 

processToXML(PrintWriter) 

Process the request, writing errors to respective PrintWriters 

setPostedDocument(Document) 

Programmatically set an XML Document to be treated the same as if it were posted as part of the request. 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Constructors

XSQLRequest(String)

public  XSQLRequest(java.lang.String url)

Create a Request for an XSQL Page

Parameters:

url - String representation of an URL to an XSQL Page

XSQLRequest(String, XSQLPageRequest)

public  XSQLRequest(java.lang.String url, XSQLPageRequest env)

Create a Request for an XSQL Page

Parameters:

url - String representation of an URL to an XSQL Page

env - Calling XSQLPageRequest environment

XSQLRequest(URL)

public  XSQLRequest(java.net.URL url)

Create a Request for an XSQL Page

Parameters:

url - URL to an XSQL Page

XSQLRequest(URL, XSQLPageRequest)

public  XSQLRequest(java.net.URL url, XSQLPageRequest env)

Create a Request for an XSQL Page

Parameters:

url - URL to an XSQL Page

env - Calling XSQLPageRequest environment

Methods

process()

public void process()

Process the request, writing output/errors to System.out/System.err

process(Dictionary)

public void process(java.util.Dictionary params)

Process the request, writing output/errors to System.out/System.err

Parameters:

params - Dictionary (e.g. Hashtable) with XSQL Page parameters

process(Dictionary, PrintWriter, PrintWriter)

public void process(java.util.Dictionary params, java.io.PrintWriter out, 
java.io.PrintWriter err)

Process the request, writing output/errors to respective PrintWriters

Parameters:

params - Dictionary (e.g. Hashtable) with XSQL Page parameters

out - PrintWriter to use to write the resulting page results

err - PrintWriter to use to write the resulting page errors

process(PrintWriter, PrintWriter)

public void process(java.io.PrintWriter out, java.io.PrintWriter err)

Process the request, writing output/errors to respective PrintWriters

Parameters:

out - PrintWriter to use to write the resulting page results

err - PrintWriter to use to write the resulting page errors

processToXML()

public org.w3c.dom.Document processToXML()

Process the request, writing output/errors to System.out/System.err

processToXML(Dictionary)

public org.w3c.dom.Document processToXML(java.util.Dictionary params)

Process the request, writing output/errors to System.out/System.err

Parameters:

params - Dictionary (e.g. Hashtable) with XSQL Page parameters

processToXML(Dictionary, PrintWriter)

public org.w3c.dom.Document processToXML(java.util.Dictionary params, 
java.io.PrintWriter err)

Process the request, writing output/errors to respective PrintWriters

Parameters:

params - Dictionary (e.g. Hashtable) with XSQL Page parameters

err - PrintWriter to use to write the resulting page errors

processToXML(PrintWriter)

public org.w3c.dom.Document processToXML(java.io.PrintWriter err)

Process the request, writing errors to respective PrintWriters

Parameters:

err - PrintWriter to use to write the resulting page errors

setPostedDocument(Document)

public void setPostedDocument(org.w3c.dom.Document postedDoc)

Programmatically set an XML Document to be treated the same as if it were posted as part of the request.

Parameters:

postedDoc - DOM Document

XSQLRequestObjectListener

Interface that an object created by an action handler can implement to be notified when the current page request processing is completed. It has a single method:

void pageProcessingCompleted()

Objects that implement this interface and which are added to the current request context using XSQLPageRequest::setRequestObject() will be notified when the page processing of the outermost page is completed.


XSQLServlet

Syntax

public final class XSQLServlet
 
oracle.xml.xsql.XSQLServlet

Description

Servlet to enable HTTP GET-ing of and POST-ing to XSQL Pages

Member Summary 

 

Constructors 

 

XSQLServlet() 

 

Methods 

 

doGet(HttpServletRequest, HttpServletResponse) 

 

doPost(HttpServletRequest, HttpServletResponse) 

 

getServletInfo() 

 

init(ServletConfig) 

 

inJServ() 

 

Constructors

XSQLServlet()

public  XSQLServlet()

Methods

doGet(HttpServletRequest, HttpServletResponse)

public void doGet(oracle.xml.xsql.HttpServletRequest request, 
oracle.xml.xsql.HttpServletResponse response)

doPost(HttpServletRequest, HttpServletResponse)

public void doPost(oracle.xml.xsql.HttpServletRequest request, 
oracle.xml.xsql.HttpServletResponse response)

getServletInfo()

public java.lang.String getServletInfo()

init(ServletConfig)

public void init(oracle.xml.xsql.ServletConfig config)

inJServ()

public static boolean inJServ()

XSQLServletPageRequest

Syntax

public final class XSQLServletPageRequest extends XSQLPageRequestImpl
 
java.lang.Object
  |
  +--XSQLPageRequestImpl
        |
        +--oracle.xml.xsql.XSQLServletPageRequest

All Implemented Interfaces:

XSQLPageRequest

Description

Implementation of XSQLPageRequest for Servlet-based XSQL Page requests.

Member Summary 

 

Constructors 

 

XSQLServletPageRequest(HttpServletRequest, HttpServletResponse) 

 

Methods 

 

createNestedRequest(URL, Dictionary) 

Returns an instance of a nested Request 

getCookie(String) 

 

getHttpServletRequest() 

Get the HttpServletRequest that initiated this XSQL Page Request. 

getHttpServletResponse() 

Get the HttpServletResponse that is associated with this XSQL Page Request 

getParameter(String) 

Use HTTP Parameters as the source of parameters instead 

getPostedDocument() 

 

getRequestParamsAsXMLDocument() 

 

getRequestType() 

 

getUserAgent() 

 

setContentType(String) 

 

setPageEncoding(String) 

 

translateURL(String) 

 

useHTMLErrors() 

 

Inherited Member Summary 

Methods inherited from class XSQLPageRequestImpl 

getConnectionName(), getErrorWriter(), getJDBCConnection(), getPageEncoding(), getSourceDocumentURI(), getStylesheetParameter(String), getStylesheetParameters(), getStylesheetURI(), getWriter(), getXSQLConnection(), isIncludedRequest(), isOracleDriver(), printedErrorHeader(), requestProcessed(), setConnectionName(String), setIncludingRequest(XSQLPageRequest), setPageParam(String, String), setPostedDocument(Document), setPrintedErrorHeader(boolean), setStylesheetParameter(String, String), setStylesheetURI(String), useConnectionPooling() 

Methods inherited from class java.lang.Object 

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

Methods inherited from interface XSQLPageRequest 

getConnectionName(), getErrorWriter(), getJDBCConnection(), getPageEncoding(), getSourceDocumentURI(), getStylesheetParameter(String), getStylesheetParameters(), getStylesheetURI(), getWriter(), getXSQLConnection(), isIncludedRequest(), isOracleDriver(), printedErrorHeader(), requestProcessed(), setConnectionName(String), setIncludingRequest(XSQLPageRequest), setPageParam(String, String), setPostedDocument(Document), setPrintedErrorHeader(boolean), setStylesheetParameter(String, String), setStylesheetURI(String), useConnectionPooling() 

Constructors

XSQLServletPageRequest(HttpServletRequest, HttpServletResponse)

public  XSQLServletPageRequest(oracle.xml.xsql.HttpServletRequest req, 
oracle.xml.xsql.HttpServletResponse resp)

Methods

createNestedRequest(URL, Dictionary)

public XSQLPageRequest createNestedRequest(java.net.URL pageurl, 
java.util.Dictionary params)

Returns an instance of a nested Request

getCookie(String)

public java.lang.String getCookie(java.lang.String name)

getHttpServletRequest()

public oracle.xml.xsql.HttpServletRequest getHttpServletRequest()

Get the HttpServletRequest that initiated this XSQL Page Request.

getHttpServletResponse()

public oracle.xml.xsql.HttpServletResponse getHttpServletResponse()

Get the HttpServletResponse that is associated with this XSQL Page Request

getParameter(String)

public java.lang.String getParameter(java.lang.String name)

Use HTTP Parameters as the source of parameters instead

Overrides:

getParameter(String) in class XSQLPageRequestImpl

getPostedDocument()

public oracle.xml.xsql.Document getPostedDocument()

Overrides:

getPostedDocument() in class XSQLPageRequestImpl

getRequestParamsAsXMLDocument()

public oracle.xml.xsql.Document getRequestParamsAsXMLDocument()

Overrides:

getRequestParamsAsXMLDocument() in class XSQLPageRequestImpl

getRequestType()

public java.lang.String getRequestType()

getUserAgent()

public java.lang.String getUserAgent()

Overrides:

getUserAgent() in class XSQLPageRequestImpl

setContentType(String)

public void setContentType(java.lang.String mimetype)

Overrides:

setContentType(String) in class XSQLPageRequestImpl

setPageEncoding(String)

public void setPageEncoding(java.lang.String enc)

Overrides:

setPageEncoding(String) in class XSQLPageRequestImpl

translateURL(String)

public java.lang.String translateURL(java.lang.String path)

Overrides:

translateURL(String) in class XSQLPageRequestImpl

useHTMLErrors()

public boolean useHTMLErrors()

Overrides:

useHTMLErrors() in class XSQLPageRequestImpl


XSQLStylesheetProcessor

Syntax

public final class XSQLStylesheetProcessor extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.xsql.XSQLStylesheetProcessor

Description

XSLT Stylesheet Processing Engine

Member Summary 

 

Constructors 

 

XSQLStylesheetProcessor() 

 

Methods 

 

processToDocument(Document, String, XSQLPageRequest) 

 

processToWriter(Document, String, XSQLPageRequest) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Constructors

XSQLStylesheetProcessor()

public  XSQLStylesheetProcessor()

Methods

processToDocument(Document, String, XSQLPageRequest)

public static oracle.xml.xsql.Document 
processToDocument(oracle.xml.xsql.Document xml, java.lang.String xslURI, 
XSQLPageRequest env)

processToWriter(Document, String, XSQLPageRequest)

public static void processToWriter(oracle.xml.xsql.Document xml, 
java.lang.String xslURI, XSQLPageRequest env)

getServletContext()

javax.servlet.ServletContext getServletContext()

Gets the Http Servlet Context


XSQLUtil

Syntax

public final class XSQLUtil extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.xsql.XSQLUtil

Description

Member Summary 

 

Constructors 

 

XSQLUtil() 

 

Methods 

 

DictionaryOfParamsAsXMLDocument(Dictionary) 

 

safeURLAsString(URL) 

 

select(Document, String) 

 

select(Element, String) 

 

select(XMLDocument, String) 

 

select(XMLElement, String) 

 

selectFirst(Document, String) 

 

selectFirst(Element, String) 

 

selectFirst(XMLDocument, String) 

 

selectFirst(XMLElement, String) 

 

stringParamValue(Object) 

 

translate(String, String) 

 

translate(URL, String) 

 

valueOf(Element, String) 

 

valueOf(Node, String) 

 

valueOf(XMLElement, String) 

 

valueOf(XMLNode, String) 

 

XL(String, String) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

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

Constructors

XSQLUtil()

public  XSQLUtil()

Methods

DictionaryOfParamsAsXMLDocument(Dictionary)

public static oracle.xml.xsql.XMLDocument 
DictionaryOfParamsAsXMLDocument(java.util.Dictionary dict)

safeURLAsString(URL)

public static java.lang.String safeURLAsString(java.net.URL u)

select(Document, String)

public static oracle.xml.xsql.NodeList select(oracle.xml.xsql.Document d, 
java.lang.String pattern)

select(Element, String)

public static oracle.xml.xsql.NodeList select(oracle.xml.xsql.Element n, 
java.lang.String pattern)

select(XMLDocument, String)

public static oracle.xml.xsql.NodeList select(oracle.xml.xsql.XMLDocument d, 
java.lang.String pattern)

select(XMLElement, String)

public static oracle.xml.xsql.NodeList select(oracle.xml.xsql.XMLElement n, 
java.lang.String pattern)

selectFirst(Document, String)

public static oracle.xml.xsql.Node selectFirst(oracle.xml.xsql.Document d, 
java.lang.String pattern)

selectFirst(Element, String)

public static oracle.xml.xsql.Node selectFirst(oracle.xml.xsql.Element n, 
java.lang.String pattern)

selectFirst(XMLDocument, String)

public static oracle.xml.xsql.Node selectFirst(oracle.xml.xsql.XMLDocument d, 
java.lang.String pattern)

selectFirst(XMLElement, String)

public static oracle.xml.xsql.Node selectFirst(oracle.xml.xsql.XMLElement n, 
java.lang.String pattern)

stringParamValue(Object)

public static java.lang.String stringParamValue(java.lang.Object val)

translate(String, String)

public static java.lang.String translate(java.lang.String u, java.lang.String 
path)

translate(URL, String)

public static java.lang.String translate(java.net.URL u, java.lang.String path)

valueOf(Element, String)

public static java.lang.String valueOf(oracle.xml.xsql.Element n, 
java.lang.String pattern)

valueOf(Node, String)

public static java.lang.String valueOf(oracle.xml.xsql.Node n, java.lang.String 
pattern)

valueOf(XMLElement, String)

public static java.lang.String valueOf(oracle.xml.xsql.XMLElement n, 
java.lang.String pattern)

valueOf(XMLNode, String)

public static java.lang.String valueOf(oracle.xml.xsql.XMLNode n, 
java.lang.String pattern)

XL(String, String)

public static java.lang.String XL(java.lang.String s, java.lang.String enc)

XSQLRequestObjectListener

Interface that an object created by an action handler can implement to be notified when the current page request processing is completed. It has a single method: void pageProcessingCompleted() Objects that implement this interface and which are added to the current request context using XSQLPageRequest::setRequestObject() will be notified when the page processing of the outermost page is completed.

The following constructors were added to oracle.xml.xsql.XSQLRequest class:

The following are new interfaces:


Go to previous page Go to next page
Oracle
Copyright © 1996-2001, Oracle Corporation.

All Rights Reserved.
Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index