oracle.cabo.servlet.url
Interface PageDecoder

All Known Implementing Classes:

BasePageEncoder

public interface PageDecoder

Interface for decoding URLS into pages and page events.

Generally, developers will implement this interface and PageEncoder on exactly the same class, since implementations of these are necessarily closely coupled. The interfaces are separated, though. This separation allows transitions from one encoding scheme to another to be handled properly.

PageDecoder instances are always tied to a specific servlet request, and should not be cached by users.

Method Summary

Page	decodePage(java.lang.String fullPageName) Returns the Page object for an string-encoded page name.
PageEvent	decodePageEvent(java.util.Dictionary parameters) Returns the PageEvent object for a list of requested parameters.
PageEvent	decodePageEvent(java.lang.String queryString) Returns the PageEvent object for a query string.
Page	decodeRequestedPage() Returns the Page object for the current servlet request.
PageEvent	decodeRequestedPageEvent() Returns the PageEvent object for the current servlet request, or null if there is no event.
java.lang.String	encodeParameter(java.lang.String key) Given the logical name of a parameter, return the parameter key that was used in the URL.
java.lang.String	getRequestCharacterEncoding() Gets the request character encoding, to be used to decode parameters.
void	setRequestCharacterEncoding(java.lang.String encoding) Sets the request character encoding, to be used to decode parameters.

Method Detail

decodeRequestedPage

public Page decodeRequestedPage()

Returns the Page object for the current servlet request.

decodePage

public Page decodePage(java.lang.String fullPageName)

Returns the Page object for an string-encoded page name.

Parameters:

fullPageName - the encoded page name

decodeRequestedPageEvent

public PageEvent decodeRequestedPageEvent()

Returns the PageEvent object for the current servlet request, or null if there is no event.

decodePageEvent

public PageEvent decodePageEvent(java.util.Dictionary parameters)

Returns the PageEvent object for a list of requested parameters.

decodePageEvent

public PageEvent decodePageEvent(java.lang.String queryString)

Returns the PageEvent object for a query string.

encodeParameter

public java.lang.String encodeParameter(java.lang.String key)

Given the logical name of a parameter, return the parameter key that was used in the URL.

getRequestCharacterEncoding

public java.lang.String getRequestCharacterEncoding()

Gets the request character encoding, to be used to decode parameters.

setRequestCharacterEncoding

public void setRequestCharacterEncoding(java.lang.String encoding)
                                 throws java.io.UnsupportedEncodingException

Sets the request character encoding, to be used to decode parameters.

If set to null, the decoder will not attempt to convert the character set. As a consequence, do not set the encoding away from "null" when using a servlet engine that implements this automatically. (For example, Servlet 2.3 API if ServletRequest.setCharacterEncoding() is called).