org.ametys.plugins.core.ui.help

Class HelpUrlProvider

java.lang.Object

org.ametys.plugins.core.ui.help.HelpUrlProvider

All Implemented Interfaces:

Component, Configurable, Contextualizable

public class HelpUrlProvider
extends Object
implements Contextualizable, Configurable, Component

Provides the url associated to an help identifier

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	__DEFAULT_HELP_ID Key of the default url
protected static String	__SEARCH_HELP_ID Key of the search url
protected Context	_context Cocoon context
protected static Map<String,String>	_helpMapping The map that links help identifiers and urls
private long	_lastUpdate

Constructor Summary

Constructors

Constructor and Description
HelpUrlProvider()

Method Summary

Modifier and Type	Method and Description
private String	_getHelpUrl(String helpId)
private String	_getSearchUrl(String searchQuery)
private void	_updateHelpUrls()
void	configure(Configuration configuration)
void	contextualize(Context context)
Map<String,Object>	getDefaultHelpUrl() Get the default help url
Map<String,Object>	getHelpUrl(String helpId) Get the default help url
Map<String,Object>	getSearchUrl(String searchQuery) Get the search url

Methods inherited from class java.lang.Object

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

Field Detail

__DEFAULT_HELP_ID

protected static final String __DEFAULT_HELP_ID

Key of the default url

See Also:

Constant Field Values

__SEARCH_HELP_ID

protected static final String __SEARCH_HELP_ID

Key of the search url

See Also:

Constant Field Values

_helpMapping

protected static Map<String,String> _helpMapping

The map that links help identifiers and urls

_context

protected Context _context

Cocoon context

_lastUpdate

private long _lastUpdate

Constructor Detail

HelpUrlProvider

public HelpUrlProvider()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getDefaultHelpUrl

public Map<String,Object> getDefaultHelpUrl()

Get the default help url

Returns:

The result (map with an url key, or possible error)

getHelpUrl

public Map<String,Object> getHelpUrl(String helpId)

Get the default help url

Parameters:

helpId - The help identifer

Returns:

The result (map with an url key, or possible error)

_getHelpUrl

private String _getHelpUrl(String helpId)

getSearchUrl

public Map<String,Object> getSearchUrl(String searchQuery)

Get the search url

Parameters:

searchQuery - The query string for this search

Returns:

The result (map with an url key, or possible error)

_getSearchUrl

private String _getSearchUrl(String searchQuery)

_updateHelpUrls

private void _updateHelpUrls()
                      throws ConfigurationException

Throws:

ConfigurationException