Oracle8i XML Reference Guide Release 3 (8.1.7) Part Number A83730-01 |
|
public class Res extends java.lang.Object java.lang.Object | +--oracle.xml.xsql.Res
Inherited Member Summary |
---|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public static final int CANTREAD_XSQL
public static final java.lang.String CANTREAD_XSQL_MSG
public static final int CLASSNOTFOUND
public static final java.lang.String CLASSNOTFOUND_MSG
public static final int CONN_FILE
public static final java.lang.String CONN_FILE_MSG
public static final int ERR_OUTPUT
public static final java.lang.String ERR_OUTPUT_MSG
public static final int ERRORINCLUDING
public static final java.lang.String ERRORINCLUDING_MSG
public static final int ERRORLOADINGURL
public static final java.lang.String ERRORLOADINGURL_MSG
public static final int ERRORREADINGPARAM
public static final java.lang.String ERRORREADINGPARAM_MSG
public static final int FATAL_SHEETPOOL
public static final java.lang.String FATAL_SHEETPOOL_MSG
public static final int ILLFORMEDXMLPARAMVAL
public static final java.lang.String ILLFORMEDXMLPARAMVAL_MSG
public static final int ILLFORMEDXMLRESOURCE
public static final java.lang.String ILLFORMEDXMLRESOURCE_MSG
public static final int INSTANTIATIONERR
public static final java.lang.String INSTANTIATIONERR_MSG
public static final int INVALID_URI
public static final java.lang.String INVALID_URI_MSG
public static final int INVALIDURL
public static final java.lang.String INVALIDURL_MSG
public static final int MISSING_ARGS
public static final java.lang.String MISSING_ARGS_MSG
public static final int MISSING_ATTR
public static final java.lang.String MISSING_ATTR_MSG
public static final int NAMED_CONN
public static final java.lang.String NAMED_CONN_MSG
public static final int NO_CONN
public static final int NO_CONN_DEF
public static final java.lang.String NO_CONN_DEF_MSG
public static final java.lang.String NO_CONN_MSG
public static final int NO_XSQL_FILE
public static final java.lang.String NO_XSQL_FILE_MSG
public static final int NOFUNCTIONNAME
public static final java.lang.String NOFUNCTIONNAME_MSG
public static final int NOPOSTEDXML
public static final java.lang.String NOPOSTEDXML_MSG
public static final int NOQUERYSUPPLIED
public static final java.lang.String NOQUERYSUPPLIED_MSG
public static final int NOTANACTIONHANDLER
public static final java.lang.String NOTANACTIONHANDLER_MSG
public static final int NULLPARAM
public static final java.lang.String NULLPARAM_MSG
public static final int OWAXMLMALFORMED
public static final java.lang.String OWAXMLMALFORMED_MSG
public static final int POSTEDXML_ERR
public static final java.lang.String POSTEDXML_ERR_MSG
public static final int UNHANDLED_ERR
public static final java.lang.String UNHANDLED_ERR_MSG
public static final int UNHANDLED_ERR_XSL_PR
public static final java.lang.String UNHANDLED_ERR_XSL_PR_MSG
public static final int UNHANDLED_ERR_XSL_RD
public static final java.lang.String UNHANDLED_ERR_XSL_RD_MSG
public static final int XML_INS_ERR
public static final java.lang.String XML_INS_ERR_MSG
public static final int XML_PARSE
public static final java.lang.String XML_PARSE_MSG
public static final int XML_SQL_ERR
public static final java.lang.String XML_SQL_ERR_MSG
public static final int XSL_ERRORS
public static final java.lang.String XSL_ERRORS_MSG
public static final int XSL_NOFILE
public static final java.lang.String XSL_NOFILE_MSG
public static final int XSL_PARSE
public static final java.lang.String XSL_PARSE_MSG
public static final int XSLNOTFOUND
public static final java.lang.String XSLNOTFOUND_MSG
public Res()
public static java.lang.String format(int id, java.lang.String s)
public static java.lang.String getString(int id)oracle.xml.xsql
public interface XSQLActionHandler
XSQLActionHandlerImpl
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 init() method Invoking the XSQL Action Handler's handleAction() methodNOTE: conn parameter can be null if no connection specified for the XSQL page being processed.
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.
rootNode - Root node of generated document fragment
public void init(XSQLPageRequest env, oracle.xml.xsql.Element e)
Initialize the Action Handler
env - XSQLPageRequest object
e - DOM element representing the Action Element being handled
oracle.xml.xsqlpublic abstract class XSQLActionHandlerImpl extends java.lang.Object implements XSQLActionHandler java.lang.Object | +--oracle.xml.xsql.XSQLActionHandlerImpl
XSQLActionHandler
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) |
|
public XSQLActionHandlerImpl()
public void init(XSQLPageRequest env, oracle.xml.xsql.Element e)
init(XSQLPageRequest, Element) in interface XSQLActionHandler
oracle.xml.xsqlpublic final class XSQLCommandLine extends java.lang.Object java.lang.Object | +--oracle.xml.xsql.XSQLCommandLine
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 |
public XSQLCommandLine()
public static void main(java.lang.String[] args)oracle.xml.xsql
public final class XSQLDiagnostic extends java.lang.Object java.lang.Object | +--oracle.xml.xsql.XSQLDiagnostic
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 |
public XSQLDiagnostic(java.lang.String diagFile)
public static void debugPrintToFile(java.lang.String msg, java.lang.String filename)
public void msg(java.lang.String text)oracle.xml.xsql
public final class XSQLHttpUtil extends java.lang.Object java.lang.Object | +--oracle.xml.xsql.XSQLHttpUtil
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 |
public XSQLHttpUtil()
public static oracle.xml.xsql.XMLDocument HttpRequestAsXMLDocument(oracle.xml.xsql.HttpServletRequest req, java.lang.String XSQLPageEncoding)
public static java.lang.String XL(java.lang.String s, java.lang.String enc)oracle.xml.xsql
public interface XSQLPageRequest
XSQLPageRequestImpl
Interface representing a request for an XSQL Page
public XSQLPageRequest createNestedRequest(java.net.URL pageurl, java.util.Dictionary params)
Returns an instance of a nested Request
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.
public java.io.PrintWriter getErrorWriter()
Returns a PrintWriter to print out errors processing this request
public java.sql.Connection getJDBCConnection()
Gets the JDBC connection being used for this request (can be null)
public java.lang.String getPageEncoding()
Returns encoding of source XSQL Page associated with this request
public java.lang.String getParameter(java.lang.String name)
Returns the value of the requested parameter
name - the name of the parameter
public oracle.xml.xsql.Document getPostedDocument()
Returns the content of Posted XML for this request as an XML Document
public oracle.xml.xsql.Document getRequestParamsAsXMLDocument()
Returns the content of a Request parameters as an XML Document
public java.lang.String getRequestType()
Returns a string identifying the type of page request being made.
public java.lang.String getSourceDocumentURI()
Returns a String representation of the requested document's URI
public java.lang.String getStylesheetParameter(java.lang.String name)
Gets a stylesheet parameter by name
public java.util.Enumeration getStylesheetParameters()
Gets an enumeration of stylesheet parameter names
public java.lang.String getStylesheetURI()
Returns the URI of the stylesheet to be used to process the result.
public java.lang.String getUserAgent()
Returns a String identifier of the requesting program
public java.io.PrintWriter getWriter()
Returns a PrintWriter used for writing out the results of a page request
public oracle.xml.xsql.XSQLConnection getXSQLConnection()
Gets the XSQLConnection Object being used for this request Might be null.
public boolean isIncludedRequest()
Returns true if this request is being included in another.
public boolean isOracleDriver()
Returns true if the current connection uses the Oracle JDBC Driver
public boolean printedErrorHeader()
Returns the state of whether an Error Header has been printed
public void requestProcessed()
Allows Page Request to Perform end-of-request processing
public void setConnectionName(java.lang.String connName)
Sets the connection name to use for this request
public void setContentType(java.lang.String mimetype)
Sets the content type of the resulting page
public void setIncludingRequest(XSQLPageRequest includingEnv)
Sets the Including Page Request object for this request.
public void setPageEncoding(java.lang.String enc)
Sets encoding of source XSQL page associated with this request.
public void setPageParam(java.lang.String name, java.lang.String value)
Sets a dynamic page parameter value.
public void setPostedDocument(oracle.xml.xsql.Document doc)
Allows programmatic setting of the Posted Document
public void setPrintedErrorHeader(boolean yes)
Sets whether an Error Header has been printed
public void setStylesheetParameter(java.lang.String name, java.lang.String value)
Sets the value of a parameter to be passed to the associated stylesheet
public void setStylesheetURI(java.lang.String uri)
Sets the URI of the stylesheet to be used to process the result.
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.
public boolean useConnectionPooling()
Returns true if connection pooling is desired for this request
public boolean useHTMLErrors()
Returns true if HTML-formatted error messages are desired for this request
oracle.xml.xsqlpublic abstract class XSQLPageRequestImpl extends java.lang.Object implements XSQLPageRequest java.lang.Object | +--oracle.xml.xsql.XSQLPageRequestImpl
XSQLServletPageRequest
XSQLPageRequest
Base implementation of the XSQLPageRequest interface that case be used to derive new kinds of page request implementations.
public XSQLPageRequestImpl()
public XSQLPageRequestImpl(java.util.Hashtable parameters)
public XSQLPageRequestImpl(java.lang.String pageurl, java.util.Hashtable parameters)
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.
getConnectionName() in interface XSQLPageRequest
public java.io.PrintWriter getErrorWriter()
getErrorWriter() in interface XSQLPageRequest
public java.sql.Connection getJDBCConnection()
Gets the JDBC connection being used for this request (can be null)
getJDBCConnection() in interface XSQLPageRequest
public java.lang.String getPageEncoding()
Returns encoding of source XSQL Page associated with this request
getPageEncoding() in interface XSQLPageRequest
public java.lang.String getParameter(java.lang.String name)
getParameter(String) in interface XSQLPageRequest
public oracle.xml.xsql.Document getPostedDocument()
getPostedDocument() in interface XSQLPageRequest
public oracle.xml.xsql.Document getRequestParamsAsXMLDocument()
getRequestParamsAsXMLDocument() in interface XSQLPageRequest
public java.lang.String getSourceDocumentURI()
getSourceDocumentURI() in interface XSQLPageRequest
public java.lang.String getStylesheetParameter(java.lang.String name)
Gets a stylesheet parameter by name
getStylesheetParameter(String) in interface XSQLPageRequest
public java.util.Enumeration getStylesheetParameters()
Gets an enumeration of stylesheet parameter names
getStylesheetParameters() in interface XSQLPageRequest
public java.lang.String getStylesheetURI()
getStylesheetURI() in interface XSQLPageRequest
public java.lang.String getUserAgent()
getUserAgent() in interface XSQLPageRequest
public java.io.PrintWriter getWriter()
getWriter() in interface XSQLPageRequest
public oracle.xml.xsql.XSQLConnection getXSQLConnection()
Gets the XSQLConnection Object being used for this request Might be null.
getXSQLConnection() in interface XSQLPageRequest
public boolean isIncludedRequest()
Returns true if this request is being included in another.
isIncludedRequest() in interface XSQLPageRequest
public boolean isOracleDriver()
Returns true if the current connection uses the Oracle JDBC Driver
isOracleDriver() in interface XSQLPageRequest
public boolean printedErrorHeader()
printedErrorHeader() in interface XSQLPageRequest
public void requestProcessed()
Allows Page Request to Perform end-of-request processing
requestProcessed() in interface XSQLPageRequest
public void setConnectionName(java.lang.String connName)
Sets the connection being used for this request (can be null)
setConnectionName(String) in interface XSQLPageRequest
public void setContentType(java.lang.String mimetype)
setContentType(String) in interface XSQLPageRequest
public void setIncludingRequest(XSQLPageRequest includingEnv)
Sets the Including Page Request object for this request.
setIncludingRequest(XSQLPageRequest) in interface XSQLPageRequest
public void setPageEncoding(java.lang.String enc)
Associates an XSQL Page with the request
setPageEncoding(String) in interface XSQLPageRequest
public void setPageParam(java.lang.String name, java.lang.String value)
Sets a dynamic page parameter value.
setPageParam(String, String) in interface XSQLPageRequest
public void setPostedDocument(oracle.xml.xsql.Document doc)
setPostedDocument(Document) in interface XSQLPageRequest
public void setPrintedErrorHeader(boolean yes)
setPrintedErrorHeader(boolean) in interface XSQLPageRequest
public void setStylesheetParameter(java.lang.String name, java.lang.String value)
setStylesheetParameter(String, String) in interface XSQLPageRequest
public void setStylesheetURI(java.lang.String uri)
setStylesheetURI(String) in interface XSQLPageRequest
public java.lang.String translateURL(java.lang.String filename)
translateURL(String) in interface XSQLPageRequest
public boolean useConnectionPooling()
useConnectionPooling() in interface XSQLPageRequest
public boolean useHTMLErrors()
useHTMLErrors() in interface XSQLPageRequest
oracle.xml.xsqlpublic final class XSQLParserHelper extends java.lang.Object java.lang.Object | +--oracle.xml.xsql.XSQLParserHelper
Common XML Parsing Routines
Inherited Member Summary |
---|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public XSQLParserHelper()
public static oracle.xml.xsql.Document newDocument()
public static oracle.xml.xsql.Document parse(java.io.InputStream is, java.net.URL baseUrl, java.io.PrintWriter errorWriter)
public static oracle.xml.xsql.Document parse(java.io.Reader r, java.io.PrintWriter errorWriter)
public static oracle.xml.xsql.Document parse(java.net.URL url, java.io.PrintWriter errorWriter)
public static oracle.xml.xsql.Document parseFromString(java.lang.StringBuffer xmlString, java.io.PrintWriter errorWriter)
public static oracle.xml.xsql.Document parseFromString(java.lang.String xmlString, java.io.PrintWriter errorWriter)
public static void print(oracle.xml.xsql.Document d, java.io.PrintWriter out)oracle.xml.xsql
public class XSQLRequest extends java.lang.Object java.lang.Object | +--oracle.xml.xsql.XSQLRequest
Programmatically process a request for an XSQL Page.
Inherited Member Summary |
---|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public XSQLRequest(java.lang.String url)
Create a Request for an XSQL Page
url - String representation of an URL to an XSQL Page
public XSQLRequest(java.lang.String url, XSQLPageRequest env)
Create a Request for an XSQL Page
url - String representation of an URL to an XSQL Page
env - Calling XSQLPageRequest environment
public XSQLRequest(java.net.URL url)
Create a Request for an XSQL Page
url - URL to an XSQL Page
public XSQLRequest(java.net.URL url, XSQLPageRequest env)
Create a Request for an XSQL Page
url - URL to an XSQL Page
env - Calling XSQLPageRequest environment
public void process()
Process the request, writing output/errors to System.out/System.err
public void process(java.util.Dictionary params)
Process the request, writing output/errors to System.out/System.err
params - Dictionary (e.g. Hashtable) with XSQL Page parameters
public void process(java.util.Dictionary params, java.io.PrintWriter out, java.io.PrintWriter err)
Process the request, writing output/errors to respective PrintWriters
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
public void process(java.io.PrintWriter out, java.io.PrintWriter err)
Process the request, writing output/errors to respective PrintWriters
out - PrintWriter to use to write the resulting page results
err - PrintWriter to use to write the resulting page errors
public org.w3c.dom.Document processToXML()
Process the request, writing output/errors to System.out/System.err
public org.w3c.dom.Document processToXML(java.util.Dictionary params)
Process the request, writing output/errors to System.out/System.err
params - Dictionary (e.g. Hashtable) with XSQL Page parameters
public org.w3c.dom.Document processToXML(java.util.Dictionary params, java.io.PrintWriter err)
Process the request, writing output/errors to respective PrintWriters
params - Dictionary (e.g. Hashtable) with XSQL Page parameters
err - PrintWriter to use to write the resulting page errors
public org.w3c.dom.Document processToXML(java.io.PrintWriter err)
Process the request, writing errors to respective PrintWriters
err - PrintWriter to use to write the resulting page errors
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.
postedDoc - DOM Document
oracle.xml.xsqlpublic final class XSQLServlet oracle.xml.xsql.XSQLServlet
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() |
|
public XSQLServlet()
public void doGet(oracle.xml.xsql.HttpServletRequest request, oracle.xml.xsql.HttpServletResponse response)
public void doPost(oracle.xml.xsql.HttpServletRequest request, oracle.xml.xsql.HttpServletResponse response)
public java.lang.String getServletInfo()
public void init(oracle.xml.xsql.ServletConfig config)
public static boolean inJServ()oracle.xml.xsql
public final class XSQLServletPageRequest extends XSQLPageRequestImpl java.lang.Object | +--XSQLPageRequestImpl | +--oracle.xml.xsql.XSQLServletPageRequest
XSQLPageRequest
Implementation of XSQLPageRequest for Servlet-based XSQL Page requests.
public XSQLServletPageRequest(oracle.xml.xsql.HttpServletRequest req, oracle.xml.xsql.HttpServletResponse resp)
public XSQLPageRequest createNestedRequest(java.net.URL pageurl, java.util.Dictionary params)
Returns an instance of a nested Request
public java.lang.String getCookie(java.lang.String name)
public oracle.xml.xsql.HttpServletRequest getHttpServletRequest()
Get the HttpServletRequest that initiated this XSQL Page Request.
public oracle.xml.xsql.HttpServletResponse getHttpServletResponse()
Get the HttpServletResponse that is associated with this XSQL Page Request
public java.lang.String getParameter(java.lang.String name)
Use HTTP Parameters as the source of parameters instead
getParameter(String) in class XSQLPageRequestImpl
public oracle.xml.xsql.Document getPostedDocument()
getPostedDocument() in class XSQLPageRequestImpl
public oracle.xml.xsql.Document getRequestParamsAsXMLDocument()
getRequestParamsAsXMLDocument() in class XSQLPageRequestImpl
public java.lang.String getRequestType()
public java.lang.String getUserAgent()
getUserAgent() in class XSQLPageRequestImpl
public void setContentType(java.lang.String mimetype)
setContentType(String) in class XSQLPageRequestImpl
public void setPageEncoding(java.lang.String enc)
setPageEncoding(String) in class XSQLPageRequestImpl
public java.lang.String translateURL(java.lang.String path)
translateURL(String) in class XSQLPageRequestImpl
public boolean useHTMLErrors()
useHTMLErrors() in class XSQLPageRequestImpl
oracle.xml.xsqlpublic final class XSQLStylesheetProcessor extends java.lang.Object java.lang.Object | +--oracle.xml.xsql.XSQLStylesheetProcessor
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 |
public XSQLStylesheetProcessor()
public static oracle.xml.xsql.Document processToDocument(oracle.xml.xsql.Document xml, java.lang.String xslURI, XSQLPageRequest env)
public static void processToWriter(oracle.xml.xsql.Document xml, java.lang.String xslURI, XSQLPageRequest env)oracle.xml.xsql
public final class XSQLUtil extends java.lang.Object java.lang.Object | +--oracle.xml.xsql.XSQLUtil
Inherited Member Summary |
---|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public XSQLUtil()
public static oracle.xml.xsql.XMLDocument DictionaryOfParamsAsXMLDocument(java.util.Dictionary dict)
public static java.lang.String safeURLAsString(java.net.URL u)
public static oracle.xml.xsql.NodeList select(oracle.xml.xsql.Document d, java.lang.String pattern)
public static oracle.xml.xsql.NodeList select(oracle.xml.xsql.Element n, java.lang.String pattern)
public static oracle.xml.xsql.NodeList select(oracle.xml.xsql.XMLDocument d, java.lang.String pattern)
public static oracle.xml.xsql.NodeList select(oracle.xml.xsql.XMLElement n, java.lang.String pattern)
public static oracle.xml.xsql.Node selectFirst(oracle.xml.xsql.Document d, java.lang.String pattern)
public static oracle.xml.xsql.Node selectFirst(oracle.xml.xsql.Element n, java.lang.String pattern)
public static oracle.xml.xsql.Node selectFirst(oracle.xml.xsql.XMLDocument d, java.lang.String pattern)
public static oracle.xml.xsql.Node selectFirst(oracle.xml.xsql.XMLElement n, java.lang.String pattern)
public static java.lang.String stringParamValue(java.lang.Object val)
public static java.lang.String translate(java.lang.String u, java.lang.String path)
public static java.lang.String translate(java.net.URL u, java.lang.String path)
public static java.lang.String valueOf(oracle.xml.xsql.Element n, java.lang.String pattern)
public static java.lang.String valueOf(oracle.xml.xsql.Node n, java.lang.String pattern)
public static java.lang.String valueOf(oracle.xml.xsql.XMLElement n, java.lang.String pattern)
public static java.lang.String valueOf(oracle.xml.xsql.XMLNode n, java.lang.String pattern)
public static java.lang.String XL(java.lang.String s, java.lang.String enc)
|
![]() Copyright © 1996-2000, Oracle Corporation. All Rights Reserved. |
|