org.apache.jetspeed.desktop.impl
Class JetspeedDesktopImpl

java.lang.Object
  org.apache.jetspeed.desktop.impl.JetspeedDesktopImpl

All Implemented Interfaces:

JetspeedDesktop, org.springframework.web.context.ServletContextAware

public class JetspeedDesktopImpl
extends java.lang.Object
implements JetspeedDesktop, org.springframework.web.context.ServletContextAware

Desktop Valve

Version:

$Id: JetspeedDesktopImpl.java $

Author:

David Sean Taylor, Steve Milek

Field Summary

Fields inherited from interface org.apache.jetspeed.desktop.JetspeedDesktop

DEFAULT_DESKTOP_ACTION_PIPELINE_PATH, DEFAULT_DESKTOP_CONFIGURE_PIPELINE_PATH, DEFAULT_DESKTOP_PIPELINE_PATH, DEFAULT_DESKTOP_RENDER_PIPELINE_PATH, DESKTOP_AJAX_REQUEST_PARAMETER, DESKTOP_ENABLED_REQUEST_ATTRIBUTE, DESKTOP_ENCODER_REQUEST_PARAMETER, DESKTOP_ENCODER_REQUEST_PARAMETER_VALUE, DESKTOP_REQUEST_NOT_AJAX_PARAMETER

Constructor Summary

JetspeedDesktopImpl(DecorationFactory decorationFactory, HeaderResourceFactory headerResourceFactory, JetspeedCache desktopContentCache, java.lang.String desktopServletPath, java.lang.String defaultLayoutTemplateExtension)

JetspeedDesktopImpl(DecorationFactory decorationFactory, HeaderResourceFactory headerResourceFactory, JetspeedCache desktopContentCache, java.lang.String desktopServletPath, java.lang.String defaultLayoutTemplateExtension, java.lang.String defaultDesktopLayoutDecoration, java.lang.String defaultDesktopPortletDecoration)

JetspeedDesktopImpl(DecorationFactory decorationFactory, HeaderResourceFactory headerResourceFactory, JetspeedCache desktopContentCache, java.lang.String desktopServletPath, java.lang.String defaultLayoutTemplateExtension, java.lang.String defaultDesktopLayoutDecoration, java.lang.String defaultDesktopPortletDecoration, BasePortalURL baseUrlAccess)

Method Summary

java.lang.String	getDesktopServletPath() Desktop servlet path ( e.g.
HeaderResourceFactory	getHeaderResourceFactory() Retrieve the header resource factory
java.lang.String	getPortalBaseUrl(RequestContext context) Portal base url ( e.g.
java.lang.String	getPortalBaseUrl(RequestContext context, boolean encode) Portal base url ( e.g.
java.lang.String	getPortalResourceUrl(RequestContext context, java.lang.String relativePath) Portal base url with relativePath argument appended ( e.g.
java.lang.String	getPortalResourceUrl(RequestContext context, java.lang.String relativePath, boolean encode) Portal base url with relativePath argument appended ( e.g.
java.lang.String	getPortalUrl(RequestContext context) Portal base servlet url ( e.g.
java.lang.String	getPortalUrl(RequestContext context, boolean encode) Portal base servlet url ( e.g.
java.lang.String	getPortalUrl(RequestContext context, java.lang.String relativePath) Portal base servlet url with relativePath argument appended ( e.g.
java.lang.String	getPortalUrl(RequestContext context, java.lang.String relativePath, boolean encode) Portal base servlet url with relativePath argument appended ( e.g.
javax.servlet.ServletContext	getServletContext()
boolean	isDesktopEnabled(RequestContext requestContext) Indicates whether /desktop is enabled for the current portal request.
void	render(RequestContext request) Render a desktop theme.
void	setServletContext(javax.servlet.ServletContext servletContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JetspeedDesktopImpl

public JetspeedDesktopImpl(DecorationFactory decorationFactory,
                           HeaderResourceFactory headerResourceFactory,
                           JetspeedCache desktopContentCache,
                           java.lang.String desktopServletPath,
                           java.lang.String defaultLayoutTemplateExtension)

JetspeedDesktopImpl

public JetspeedDesktopImpl(DecorationFactory decorationFactory,
                           HeaderResourceFactory headerResourceFactory,
                           JetspeedCache desktopContentCache,
                           java.lang.String desktopServletPath,
                           java.lang.String defaultLayoutTemplateExtension,
                           java.lang.String defaultDesktopLayoutDecoration,
                           java.lang.String defaultDesktopPortletDecoration)

JetspeedDesktopImpl

public JetspeedDesktopImpl(DecorationFactory decorationFactory,
                           HeaderResourceFactory headerResourceFactory,
                           JetspeedCache desktopContentCache,
                           java.lang.String desktopServletPath,
                           java.lang.String defaultLayoutTemplateExtension,
                           java.lang.String defaultDesktopLayoutDecoration,
                           java.lang.String defaultDesktopPortletDecoration,
                           BasePortalURL baseUrlAccess)

Method Detail

render

public void render(RequestContext request)

Description copied from interface: JetspeedDesktop

Render a desktop theme.

Specified by:

render in interface JetspeedDesktop

isDesktopEnabled

public boolean isDesktopEnabled(RequestContext requestContext)

Description copied from interface: JetspeedDesktop

Indicates whether /desktop is enabled for the current portal request. Located here due to range of jetspeed components which need this information and already have a DecorationFactory reference.

Specified by:

isDesktopEnabled in interface JetspeedDesktop

Parameters:

requestContext - current portal request.

Returns:

true if /desktop is enabled for the current portal request, otherwise false

getServletContext

public javax.servlet.ServletContext getServletContext()

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

getHeaderResourceFactory

public HeaderResourceFactory getHeaderResourceFactory()

Description copied from interface: JetspeedDesktop

Retrieve the header resource factory

Specified by:

getHeaderResourceFactory in interface JetspeedDesktop

Returns:

header resource factory

getDesktopServletPath

public java.lang.String getDesktopServletPath()

Desktop servlet path ( e.g. /desktop )

Specified by:

getDesktopServletPath in interface JetspeedDesktop

Returns:

portal base url

getPortalBaseUrl

public java.lang.String getPortalBaseUrl(RequestContext context)

Portal base url ( e.g. http://localhost:8080/jetspeed )

Specified by:

getPortalBaseUrl in interface JetspeedDesktop

Returns:

portal base url

getPortalBaseUrl

public java.lang.String getPortalBaseUrl(RequestContext context,
                                         boolean encode)

Portal base url ( e.g. http://localhost:8080/jetspeed )

Specified by:

getPortalBaseUrl in interface JetspeedDesktop

Returns:

portal base url

getPortalResourceUrl

public java.lang.String getPortalResourceUrl(RequestContext context,
                                             java.lang.String relativePath)

Portal base url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/javascript/dojo/ )

Specified by:

getPortalResourceUrl in interface JetspeedDesktop

Returns:

portal base url with relativePath argument appended

getPortalResourceUrl

public java.lang.String getPortalResourceUrl(RequestContext context,
                                             java.lang.String relativePath,
                                             boolean encode)

Portal base url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/javascript/dojo/ )

Specified by:

getPortalResourceUrl in interface JetspeedDesktop

Returns:

portal base url with relativePath argument appended

getPortalUrl

public java.lang.String getPortalUrl(RequestContext context)

Portal base servlet url ( e.g. http://localhost:8080/jetspeed/desktop/ )

Specified by:

getPortalUrl in interface JetspeedDesktop

Returns:

portal base servlet url

getPortalUrl

public java.lang.String getPortalUrl(RequestContext context,
                                     boolean encode)

Portal base servlet url ( e.g. http://localhost:8080/jetspeed/desktop/ )

Specified by:

getPortalUrl in interface JetspeedDesktop

Returns:

portal base servlet url

getPortalUrl

public java.lang.String getPortalUrl(RequestContext context,
                                     java.lang.String relativePath)

Portal base servlet url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/desktop/default-page.psml )

Specified by:

getPortalUrl in interface JetspeedDesktop

Returns:

portal base servlet url with relativePath argument appended

getPortalUrl

public java.lang.String getPortalUrl(RequestContext context,
                                     java.lang.String relativePath,
                                     boolean encode)

Portal base servlet url with relativePath argument appended ( e.g. http://localhost:8080/jetspeed/desktop/default-page.psml )

Specified by:

getPortalUrl in interface JetspeedDesktop

Returns:

portal base servlet url with relativePath argument appended