org.olat.core.commons.contextHelp
Class ContextHelpDispatcher

java.lang.Object
  org.olat.core.logging.LogDelegator
      org.olat.core.commons.contextHelp.ContextHelpDispatcher

All Implemented Interfaces:

Dispatcher

public class ContextHelpDispatcher
extends LogDelegator
implements Dispatcher

Description:

The context help dispatcher displays context help files to a separate popup window.

The dispatcher can be used with an authenticated session or with a non-authenticated session.

Initial Date: 30.10.2008

Author:

Florian Gnaegi, frentix GmbH, http://www.frentix.com

Constructor Summary

ContextHelpDispatcher(java.lang.String contextHelpMapperPath)

Method Summary

static java.lang.String	createContextHelpURI(java.util.Locale locale, java.lang.String bundleName, java.lang.String page) Create an URL for the given locale, bundle and page that can be dispatched by this dispatcher
void	execute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String uriPrefix)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextHelpDispatcher

public ContextHelpDispatcher(java.lang.String contextHelpMapperPath)

Method Detail

execute

public void execute(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    java.lang.String uriPrefix)

Specified by:

execute in interface Dispatcher

See Also:

Dispatcher.execute(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)

createContextHelpURI

public static java.lang.String createContextHelpURI(java.util.Locale locale,
                                                    java.lang.String bundleName,
                                                    java.lang.String page)

Create an URL for the given locale, bundle and page that can be dispatched by this dispatcher

Parameters:

locale - The desired locale

bundleName - The bundle name, e.g. "org.olat.core"

page - The page, e.g. "my-file.html"

Returns: