org.apache.geronimo.console.gbean
Interface ContextForward

All Known Implementing Classes:

ContextForwardGBean

public interface ContextForward

Interface for a GBean that describes a context forward (that is, a certain URL pattern in the console should be forwarded to a similar URL in one of the portlet web applications without requiring a separate login). This is managed by a single servlet in the portal web app (say, mapped to /forwards/*). Therefore each ContextForward must specify three pieces of information -- the prefix under the portal servlet that should be forwarded, the context to forward to, and the path to forward to within the context. For example, if it specified "myimages/", "myportlet", and "images" then a request to /console/forwards/myimages/foo.png would be forwarded to /myportlet/images/foo.png

Method Summary

String	getPortalPathPrefix() Gets the prefix for the portal servlet's path that should be forwarded according to this definition.
String	getPortletContextPath() Gets the context root that this request should forward to ("myportlet" in the example above).
String	getPortletServletPath() Gets the servlet path that this request should forward to in the destination context.

Method Detail

getPortalPathPrefix

String getPortalPathPrefix()

Gets the prefix for the portal servlet's path that should be forwarded according to this definition. This is "myimages/" in the example above.

getPortletContextPath

String getPortletContextPath()

Gets the context root that this request should forward to ("myportlet" in the example above).

getPortletServletPath

String getPortletServletPath()

Gets the servlet path that this request should forward to in the destination context. Any data after the servlet path and portal path prefix in the original URL will be appended to the portlet context path and servlet path to construct the destination URL.