Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.state.accessors.url
Interface URLWriterProvider
Optional interface which is supposed to be implemented by ServletResponseWrapper classes. Allows to provide a custom Writer which is used by the portal framework to write portal URLs of type EngineURL.
- Since:
- 6.1
- Note:
This interface is designed to be implemented by clients.
Method Summary java.io.Writer getURLWriter(java.io.Writer out)
Method which allows to provide a custom Writer which is called by the portal framework when a EngineURL is written.
Method Detail getURLWriter
java.io.Writer getURLWriter(java.io.Writer out) throws java.io.IOException
Method which allows to provide a custom Writer which is called by the portal framework when a EngineURL is written. Note that the returned writer must dispatch to the given output writer; otherwise the URL will not be written to the response. The writer must not make any assumptions about whether a absolute, server-relative, or relative URL is written.
For performance reasons, it is recommended to avoid returning a writer that buffers the complete URL. After the URL has been completely written, the portal framework will invoke the close() method on the returned writer.
- Parameters:
- out - The original writer. Must not be null.
- Returns:
- The destination writer, the portal URL should be written to. Not null.
- Throws:
- java.io.IOException
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD