org.apache.jetspeed.container.url.impl
Class AbstractPortalURL

java.lang.Object
  extended byorg.apache.jetspeed.container.url.impl.AbstractPortalURL
All Implemented Interfaces:
org.apache.jetspeed.container.url.PortalURL
Direct Known Subclasses:
PathInfoEncodingPortalURL, QueryStringEncodingPortalURL

public abstract class AbstractPortalURL
extends Object
implements org.apache.jetspeed.container.url.PortalURL

AbstractPortalURL delivers the base implemention for parsing Jetspeed Portal URLs and creating new Portlet URLs. Not implemented is the encoding and decoding of the NavigationState parameter in the URL, allowing concrete implementations to supply different algorithms for it like encoding it as pathInfo or as query string parameter.

Version:
$Id: AbstractPortalURL.java 231479 2005-08-11 16:26:27Z sgala $
Author:
Ate Douma

Field Summary
private  String basePath
           
private  String characterEncoding
           
private  String contextPath
           
static String DEFAULT_NAV_STATE_PARAMETER
           
private  String encodedNavState
           
private  org.apache.jetspeed.container.state.NavigationalState navState
           
private static String navStateParameter
           
private  String nonSecureBaseURL
           
private  String path
           
private  boolean secure
           
private  String secureBaseURL
           
private  String serverName
           
private  int serverPort
           
private  String serverScheme
           
 
Fields inherited from interface org.apache.jetspeed.container.url.PortalURL
HTTP, HTTPS
 
Constructor Summary
AbstractPortalURL(javax.servlet.http.HttpServletRequest request, String characterEncoding, org.apache.jetspeed.container.state.NavigationalState navState, PortalContext portalContext)
           
AbstractPortalURL(org.apache.jetspeed.container.state.NavigationalState navState, PortalContext portalContext)
           
AbstractPortalURL(String characterEncoding, org.apache.jetspeed.container.state.NavigationalState navState, PortalContext portalContext)
           
 
Method Summary
 String createPortletURL(org.apache.pluto.om.window.PortletWindow window, Map parameters, javax.portlet.PortletMode mode, javax.portlet.WindowState state, boolean action, boolean secure)
           
 String createPortletURL(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode, javax.portlet.WindowState state, boolean secure)
           
protected abstract  String createPortletURL(String encodedNavState, boolean secure)
           
protected  void decodeBasePath(javax.servlet.http.HttpServletRequest request)
           
protected  void decodeBaseURL(javax.servlet.http.HttpServletRequest request)
           
protected abstract  void decodePathAndNavigationalState(javax.servlet.http.HttpServletRequest request)
           
 String getBasePath()
           
 String getBaseURL()
           
 String getBaseURL(boolean secure)
           
 org.apache.jetspeed.container.state.NavigationalState getNavigationalState()
           
static String getNavigationalStateParameterName()
           
 String getPageBasePath()
           
 String getPath()
           
 boolean isSecure()
           
 void setCharacterEncoding(String characterEncoding)
           
protected  void setEncodedNavigationalState(String encodedNavigationalState)
           
protected  void setPath(String path)
           
 void setRequest(javax.servlet.http.HttpServletRequest request)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_NAV_STATE_PARAMETER

public static final String DEFAULT_NAV_STATE_PARAMETER
See Also:
Constant Field Values

navStateParameter

private static String navStateParameter

navState

private org.apache.jetspeed.container.state.NavigationalState navState

serverName

private String serverName

serverScheme

private String serverScheme

contextPath

private String contextPath

basePath

private String basePath

path

private String path

encodedNavState

private String encodedNavState

secureBaseURL

private String secureBaseURL

nonSecureBaseURL

private String nonSecureBaseURL

serverPort

private int serverPort

secure

private boolean secure

characterEncoding

private String characterEncoding
Constructor Detail

AbstractPortalURL

public AbstractPortalURL(org.apache.jetspeed.container.state.NavigationalState navState,
                         PortalContext portalContext)

AbstractPortalURL

public AbstractPortalURL(String characterEncoding,
                         org.apache.jetspeed.container.state.NavigationalState navState,
                         PortalContext portalContext)

AbstractPortalURL

public AbstractPortalURL(javax.servlet.http.HttpServletRequest request,
                         String characterEncoding,
                         org.apache.jetspeed.container.state.NavigationalState navState,
                         PortalContext portalContext)
Method Detail

getNavigationalStateParameterName

public static String getNavigationalStateParameterName()

decodeBaseURL

protected void decodeBaseURL(javax.servlet.http.HttpServletRequest request)

decodeBasePath

protected void decodeBasePath(javax.servlet.http.HttpServletRequest request)

setEncodedNavigationalState

protected void setEncodedNavigationalState(String encodedNavigationalState)

setPath

protected void setPath(String path)

getBaseURL

public String getBaseURL()
Specified by:
getBaseURL in interface org.apache.jetspeed.container.url.PortalURL

getBaseURL

public String getBaseURL(boolean secure)
Specified by:
getBaseURL in interface org.apache.jetspeed.container.url.PortalURL

getBasePath

public String getBasePath()
Specified by:
getBasePath in interface org.apache.jetspeed.container.url.PortalURL

getPath

public String getPath()
Specified by:
getPath in interface org.apache.jetspeed.container.url.PortalURL

getPageBasePath

public String getPageBasePath()
Specified by:
getPageBasePath in interface org.apache.jetspeed.container.url.PortalURL

isSecure

public boolean isSecure()
Specified by:
isSecure in interface org.apache.jetspeed.container.url.PortalURL

getNavigationalState

public org.apache.jetspeed.container.state.NavigationalState getNavigationalState()
Specified by:
getNavigationalState in interface org.apache.jetspeed.container.url.PortalURL

createPortletURL

public String createPortletURL(org.apache.pluto.om.window.PortletWindow window,
                               Map parameters,
                               javax.portlet.PortletMode mode,
                               javax.portlet.WindowState state,
                               boolean action,
                               boolean secure)
Specified by:
createPortletURL in interface org.apache.jetspeed.container.url.PortalURL

createPortletURL

public String createPortletURL(org.apache.pluto.om.window.PortletWindow window,
                               javax.portlet.PortletMode mode,
                               javax.portlet.WindowState state,
                               boolean secure)
Specified by:
createPortletURL in interface org.apache.jetspeed.container.url.PortalURL

decodePathAndNavigationalState

protected abstract void decodePathAndNavigationalState(javax.servlet.http.HttpServletRequest request)

createPortletURL

protected abstract String createPortletURL(String encodedNavState,
                                           boolean secure)

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)
Specified by:
setRequest in interface org.apache.jetspeed.container.url.PortalURL

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)
Specified by:
setCharacterEncoding in interface org.apache.jetspeed.container.url.PortalURL


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.