|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dss.thin.servlet.ServletQueryParameterProvider
Default implementation of a QueryParameterProvider.
Constructor Summary | |
ServletQueryParameterProvider(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Constructor that creates a ServletQueryParameterProvider that uses the Servlet API's default character encoding ( ISO-8859-1 ). | |
ServletQueryParameterProvider(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, oracle.cabo.share.url.URLEncoder encoder, java.lang.String characterEncoding) Constructor that creates a ServletQueryParameterProvider that uses a custom character encoding. |
Method Summary | |
void |
addErrorHandler(ErrorHandler eh) Adds a single error handler to the bean. |
java.lang.String |
getApplicationQueryParameter(java.lang.String name) Returns an application query parameter value from the current request's URL. |
java.lang.String[] |
getApplicationQueryParameterValues(java.lang.String name) Returns an application query parameter's values from the current request's URL. |
java.lang.Object |
getAttributeValue(java.lang.String name) Retrieve an attribute by name. |
java.lang.String |
getCharacterEncoding() Retrieve the character encoding |
javax.servlet.http.HttpServletRequest |
getHttpServletRequest() Retrieve the current HttpServletRequest. |
javax.servlet.http.HttpServletResponse |
getHttpServletResponse() Retrieve the current HttpServletResponse |
java.lang.String |
getQueryParameter(java.lang.String name) Returns a query parameter value from the current request's URL. |
java.lang.String[] |
getQueryParameterValues(java.lang.String name) Returns a query parameter's values from the current request's URL. |
oracle.cabo.share.url.URLEncoder |
getURLEncoder() Retrieve the URLEncoder for this QueryParameterProvider |
void |
removeErrorHandler() Removes the error handler from the bean. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ServletQueryParameterProvider(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
In addition, since no URLEncoder is used, query parameter names are not transformed to alternate names.
request
- the current HttpServletRequestresponse
- the current HttpServletResponsepublic ServletQueryParameterProvider(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, oracle.cabo.share.url.URLEncoder encoder, java.lang.String characterEncoding)
If a URLEncoder is passed in, then it is used to transform query parameter names. The URLEncoder that is passed in should match the URLEncoder that is set on the RenderingContext that was used to generate the HTML page that generated this request.
request
- the current HttpServletRequestresponse
- the current HttpServletResponsecharacterEncoding
- the character encoding that is used to decode request parameter values. A null value specifies no character encoding.encoder
- the URLEncoder that is used to transform query parameter names. A null value specifies no URLEncoderMethod Detail |
public java.lang.Object getAttributeValue(java.lang.String name)
The base implementation of this method retrieves values from an existing HttpSession that is accessed via the HttpServletRequest. If an application does not have access to a HttpServletRequest or if an application does not have an HttpSession, then this method should be overridden to fetch application attributes from an application defined attribute store.
getAttributeValue
in interface QueryParameterProvider
public javax.servlet.http.HttpServletRequest getHttpServletRequest()
getHttpServletRequest
in interface QueryParameterProvider
public javax.servlet.http.HttpServletResponse getHttpServletResponse()
getHttpServletResponse
in interface QueryParameterProvider
public oracle.cabo.share.url.URLEncoder getURLEncoder()
public java.lang.String getCharacterEncoding()
getCharacterEncoding
in interface QueryParameterProvider
public java.lang.String getQueryParameter(java.lang.String name)
Returns a query parameter value from the current request's URL. If the implementation of QueryParameterProvider has an HTTPServletRequest, then the query parameters can be fetched from the request using the getQueryParameter() method on the HTTPServletRequest.
It is the responsibility of the QueryParameterProvider to "encode"/transform the query parameter name using UIX's oracle.cabo.share.url.URLEncoder
class before trying to fetch the query parameter from the HTTPServletRequest. The URLEncoder
is used to isolate ThinBeanUI event parameter names from application query parameter names.
Note : Applications should use the getApplicationQueryParameter() method to retrieve application query parameters that were added to events via hidden form fields or EventTarget
s. This is due to the fact that application query parameters do not have their names encoded using a URLEncoder.
It is also the responsibility of the QueryParameterProvider to decode all query parameter values using the correct character set encoding. We recommend using the static oracle.cabo.share.util.CaboHttpUtils.decodeRequestParameter() method provided by to decode values.
getQueryParameter
in interface QueryParameterProvider
name
- the query parameter namepublic java.lang.String[] getQueryParameterValues(java.lang.String name)
Returns a query parameter's values from the current request's URL. If the implementation of QueryParameterProvider has an HTTPServletRequest, then the query parameters can be fetched from the request using the getQueryParameterValues() method on the HTTPServletRequest.
It is the responsibility of the QueryParameterProvider to "encode"/transform the query parameter name using UIX's oracle.cabo.share.url.URLEncoder
class before trying to fetch the query parameter from the HTTPServletRequest. The URLEncoder
is used to isolate ThinBeanUI event parameter names from application query parameter names.
Note : Applications should use the getApplicationQueryParameter() method to retrieve application query parameters that were added to events via hidden form fields or EventTarget
s. This is due to the fact that application query parameters do not have their names encoded using a URLEncoder.
It is also the responsibility of the QueryParameterProvider to decode all query parameter values using the correct character set encoding. We recommend using the static oracle.cabo.share.util.CaboHttpUtils.decodeRequestParameter() method provided by to decode values.
getQueryParameterValues
in interface QueryParameterProvider
name
- the query parameter namepublic java.lang.String getApplicationQueryParameter(java.lang.String name)
Returns an application query parameter value from the current request's URL. If the implementation of QueryParameterProvider has an HTTPServletRequest, then the query parameters can be fetched from the request using the getQueryParameter() method on the HTTPServletRequest.
Note : Applications should use this method to retrieve application query parameters that were added to events via hidden form fields or EventTarget
s.
It is also the responsibility of the QueryParameterProvider to decode all query parameter values using the correct character set encoding. We recommend using the static oracle.cabo.share.util.CaboHttpUtils.decodeRequestParameter() method provided by to decode values.
getApplicationQueryParameter
in interface QueryParameterProvider
name
- the query parameter namepublic java.lang.String[] getApplicationQueryParameterValues(java.lang.String name)
Returns an application query parameter's values from the current request's URL. If the implementation of QueryParameterProvider has an HTTPServletRequest, then the query parameters can be fetched from the request using the getQueryParameter() method on the HTTPServletRequest.
Note : Applications should use this method to retrieve application query parameters that were added to events via hidden form fields or EventTarget
s.
It is also the responsibility of the QueryParameterProvider to decode all query parameter values using the correct character set encoding. We recommend using the static oracle.cabo.share.util.CaboHttpUtils.decodeRequestParameter() method provided by to decode values.
getApplicationQueryParameterValues
in interface QueryParameterProvider
name
- the query parameter namepublic void addErrorHandler(ErrorHandler eh)
addErrorHandler
in interface ErrorHandlerCallback
eh
- The error handler to add.public void removeErrorHandler()
removeErrorHandler
in interface ErrorHandlerCallback
|
Oracle™ Business Intelligence Beans Java API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |