oracle.xml.xsql
Interface XSQLPageRequest

All Known Implementing Classes:

XSQLPageRequestImpl

public interface XSQLPageRequest

Interface representing a request for an XSQL Page

Method Summary

java.lang.String	getConnectionName() Returns the name of the connection being used for this request May be null if no connection set/in-use.
java.io.PrintWriter	getErrorWriter() Returns a PrintWriter to print out errors processing this request
java.sql.Connection	getJDBCConnection() Gets the JDBC connection being used for this request (can be null)
java.lang.String	getPageEncoding() Returns encoding of source XSQL Page associated with this request
java.lang.String	getParameter(java.lang.String name) Returns the value of the requested parameter
org.w3c.dom.Document	getPostedDocument() Returns the content of Posted XML for this request as an XML Document
org.w3c.dom.Document	getRequestParamsAsXMLDocument() Returns the content of a Request parameters as an XML Document
java.lang.String	getRequestType() Returns a string identifying the type of page request being made.
java.lang.String	getSourceDocumentURI() Returns a String representation of the requested document's URI
java.lang.String	getStylesheetParameter(java.lang.String name) Gets a stylesheet parameter by name
java.util.Enumeration	getStylesheetParameters() Gets an enumeration of stylesheet parameter names
java.lang.String	getStylesheetURI() Returns the URI of the stylesheet to be used to process the result.
java.lang.String	getUserAgent() Returns a String identifier of the requesting program
java.io.PrintWriter	getWriter() Returns a PrintWriter used for writing out the results of a page request
oracle.xml.xsql.XSQLConnection	getXSQLConnection() Gets the XSQLConnection Object being used for this request Might be null.
boolean	isIncludedRequest() Returns true if this request is being included in another.
boolean	printedErrorHeader() Returns the state of whether an Error Header has been printed
void	requestProcessed() Allows Page Request to Perform end-of-request processing
void	setConnectionName(java.lang.String connName) Sets the connection name to use for this request
void	setContentType(java.lang.String mimetype) Sets the content type of the resulting page
void	setIncludingRequest(XSQLPageRequest includingEnv) Sets the Including Page Request object for this request.
void	setPageEncoding(java.lang.String enc) Sets encoding of source XSQL page associated with this request.
void	setPrintedErrorHeader(boolean yes) Sets whether an Error Header has been printed
void	setStylesheetParameter(java.lang.String name, java.lang.String value) Sets the value of a parameter to be passed to the associated stylesheet
void	setStylesheetURI(java.lang.String uri) Sets the URI of the stylesheet to be used to process the result.
java.lang.String	translateURL(java.lang.String url) Returns a string representing an absolute URL resolved relative to the base URI for this request.
boolean	useConnectionPooling() Returns true if connection pooling is desired for this request
boolean	useHTMLErrors() Returns true if HTML-formatted error messages are desired for this request

Method Detail

printedErrorHeader

public boolean printedErrorHeader()

Returns the state of whether an Error Header has been printed

setPrintedErrorHeader

public void setPrintedErrorHeader(boolean yes)

Sets whether an Error Header has been printed

getParameter

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

Returns the value of the requested parameter

Parameters:

name - the name of the parameter

getSourceDocumentURI

public java.lang.String getSourceDocumentURI()

Returns a String representation of the requested document's URI

getWriter

public java.io.PrintWriter getWriter()

Returns a PrintWriter used for writing out the results of a page 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

getErrorWriter

public java.io.PrintWriter getErrorWriter()

Returns a PrintWriter to print out errors processing this request

getUserAgent

public java.lang.String getUserAgent()

Returns a String identifier of the requesting program

setContentType

public void setContentType(java.lang.String mimetype)

Sets the content type of the resulting page

translateURL

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.

getRequestType

public java.lang.String getRequestType()

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

setStylesheetURI

public void setStylesheetURI(java.lang.String uri)

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

getStylesheetURI

public java.lang.String getStylesheetURI()

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

getPostedDocument

public org.w3c.dom.Document getPostedDocument()

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

getRequestParamsAsXMLDocument

public org.w3c.dom.Document getRequestParamsAsXMLDocument()

Returns the content of a Request parameters as an XML Document

setPageEncoding

public void setPageEncoding(java.lang.String enc)

Sets encoding of source XSQL page associated with this request.

getPageEncoding

public java.lang.String getPageEncoding()

Returns encoding of source XSQL Page associated with this request

setStylesheetParameter

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

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

getStylesheetParameters

public java.util.Enumeration getStylesheetParameters()

Gets an enumeration of stylesheet parameter names

getStylesheetParameter

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

Gets a stylesheet parameter by name

setConnectionName

public void setConnectionName(java.lang.String connName)
                       throws java.sql.SQLException

Sets the connection name to use for this 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.

getJDBCConnection

public java.sql.Connection getJDBCConnection()

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

requestProcessed

public void requestProcessed()

Allows Page Request to Perform end-of-request processing

getXSQLConnection

public oracle.xml.xsql.XSQLConnection getXSQLConnection()

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

setIncludingRequest

public void setIncludingRequest(XSQLPageRequest includingEnv)

Sets the Including Page Request object for this request.

isIncludedRequest

public boolean isIncludedRequest()

Returns true if this request is being included in another.