com.jalios.jcms
Class ResourceHelper

java.lang.Object
  com.jalios.jcms.ResourceHelper

All Implemented Interfaces:

JPropertiesListener

public class ResourceHelper
extends Object
implements JPropertiesListener

Helper class used to retrieve relative paths of jsp/servlet or icons used for various features of JCMS.

Since:

jcms-5.7.0

Field Summary

static String	DEFAULT_SKIN_PROP Property used to retrieve the path to the default Portlet Wrapper.
static String	DEFAULT_TEMPLATE_PROP Property used to retrieve the path to the default template usage.
static String	ICON_DBMEMBER_DEFAULT Property used to retrieve the path of the default DBmembers' icon.
static String	ICON_GROUP_DEFAULT Property used to retrieve the path of groups' icon.
static String	ICON_GROUP_LDAP_DEFAULT Property used to retrieve the path of ldap groups' icon.
static String	ICON_GROUP_LDAP_PARENT Property used to retrieve the path of ldap parent groups' icon.
static String	ICON_GROUP_PARENT Property used to retrieve the path of parent groups' icon.
static String	ICON_LOGBACK Property used to retrieve the path of the logback icon.
static String	ICON_LOGIN Property used to retrieve the path of the login icon.
static String	ICON_LOGOUT Property used to retrieve the path of the logout icon.
static String	ICON_MEMBER_ADMIN Property used to retrieve the path of admins' member icon.
static String	ICON_MEMBER_CONTACT Property used to retrieve the path of the contact DBmembers' icon.
static String	ICON_MEMBER_DEFAULT Property used to retrieve the path of the default members' icon.
static String	ICON_MEMBER_LDAP_ADMIN Property used to retrieve the path of admins' ldap member icon.
static String	ICON_MEMBER_LDAP_DEFAULT Property used to retrieve the path of the default ldap members' icon.
static String	ICON_MEMBER_LDAP_WRITER Property used to retrieve the path of ldap writers' member icon.
static String	ICON_MEMBER_LDAP_WSADMIN Property used to retrieve the path of ldap workspace admins' ldap member icon.
static String	ICON_MEMBER_WRITER Property used to retrieve the path of writers' icon.
static String	ICON_MEMBER_WSADMIN Property used to retrieve the path of workspace admins' member icon.
static String	ICON_TOOLTIP Property used to retrieve the path of the tooltip icon.
static String	LOGIN_PROP Property used to retrieve the path of the login jsp/servlet.
static String	LOGOUT_PROP Property used to retrieve the path of the loggout jsp/servlet.
static String	MAIL_PASSWORD_PROP Property used to retrieve path of the mail password jsp/servlet.
protected Map<String,String>	mapCSSHeader
protected Map<String,String>	mapHTTPEquiv
protected Map<String,String>	mapHTTPName
protected Map<String,String>	mapJSHeader
protected Map<String,String>	mapLESS
static String	MEMBER_DISPLAY_PROP Property used to retrieve the path of jsp/servlet to display a member.
static String	MEMBER_PROFILE_PROP Property used to retrieve the path of jsp/servlet to display a member profile.
static String	PRIVATE_LOGIN_PROP Property used to retrieve the path of the private login jsp/servlet.
static String	PRIVATE_MAIL_PASSWORD_PROP Property used to retrieve path of the private mail password jsp/servlet.
static String	QUERY_PROP Property used to retrieve the path of the query jsp/servlet.
static String	QUERYCSV_PROP Property used to retrieve the path of the query jsp/servlet returning csv content.
static String	QUERYXML_PROP Property used to retrieve the path of the query jsp/servlet return xml content.
static String	REFINE_PROP Property used to retrieve the path of the refine jsp/servlet.
static String	SEARCH_PROP Property used to retrieve the path of the advanced search jsp/servlet.
static String	SITE_TOPBAR Property used to retrieve the path to the site topbar.
static String	WORKSPACE_WIZARD_PROP Property used to retrieve the path to the workspace wizard jsp/servlet.
static String	WORKSPACES_LIST_PROP Property used to retrieve the path to the workspaces list jsp/servlet.

Fields inherited from interface com.jalios.util.JPropertiesListener

REVISION

Method Summary

void	compileLESS(boolean override)
static String	getDBMemberDefaultIcon() Retrieve the path of the default DB members' icon.
static String	getDefaultSkin() Retrieve the relative path of the "default skin" jsp/servlet .
static String	getDefaultTemplate(String usage) Retrieve the relative path of the "default template" jsp/servlet .
static String	getGroupDefaultIcon() Retrieve the path of groups' icon.
static String	getGroupLdapDefaultIcon() Retrieve the path of ldap groups icon.
static String	getGroupLdapParentIcon() Retrieve the path of ldap parent groups' icon.
static String	getGroupParentIcon() Retrieve the path of parent groups' icon.
Map<String,String>	getHTTPCSSHeaderMap()
Map<String,String>	getHTTPEquivHeaderMap()
Map<String,String>	getHTTPJSHeaderMap()
Map<String,String>	getHTTPNameHeaderMap()
static ResourceHelper	getInstance() Returns the singleton.
Map<String,String>	getLESSMap()
static String	getLogbackIcon() Retrieve the path of the logback icon.
static String	getLogin() Retrieve the relative path of the "login" jsp/servlet that should be used when accessing a site.
static String	getLoginIcon() Retrieve the path of the login icon.
static String	getLogout() Retrieve the relative path of the "logout" jsp/servlet that should be used when quitting a site.
static String	getLogoutIcon() Retrieve the path of the logout icon.
static String	getMailPassword() Retrieve the relative path of the "mail password" jsp/servlet that should be used when providing a way for a user to retrieve its password.
static String	getMemberAdminIcon() Retrieve the path of admins' member icon.
static String	getMemberContactIcon() Retrieve the path of the contact members' icon.
static String	getMemberDefaultIcon() Retrieve the path of the default members' icon.
static String	getMemberDisplay() Retrieve the relative path of the "member display" jsp/servlet that should be used to display a member's information.
static String	getMemberLdapAdminIcon() Retrieve the path of admins' ldap member icon.
static String	getMemberLdapDefaultIcon() Retrieve the path of the default ldap members' icon.
static String	getMemberLdapWriterIcon() Retrieve the path of ldap writers' member icon.
static String	getMemberLdapWsAdminIcon() Retrieve the path of ldap workspace admins' ldap member icon.
static String	getMemberProfile() Retrieve the relative path of the "member profile" jsp/servlet that should be used to display a member's profile.
static String	getMemberWriterIcon() Retrieve the path of the default members' icon.
static String	getMemberWsAdminIcon() Retrieve the path of workspace admins' member icon.
static String	getPrivateLogin() Retrieve the relative path of the "private login" jsp/servlet that should be used when accessing a private site (where authentication is required).
static String	getPrivateMailPassword() Retrieve the relative path of the "private mail password" jsp/servlet that should be used when providing a way for a user to retrieve its password when the site is private (where authentication is required).
static String	getQuery() Retrieve the relative path of the "query" jsp/servlet that should be used to perform a search and display the results.
static String	getQueryCsv() Retrieve the relative path of the "query" jsp/servlet that should be used to perform a search and display the results as CSV content.
static String	getQueryXml() Retrieve the relative path of the "query" jsp/servlet that should be used to perform a search and display the results as XML content.
static String	getRefine() Retrieve the relative path of the "search" jsp/servlet that should be used to provide the refine search form.
static String	getSearch() Retrieve the relative path of the "search" jsp/servlet that should be used to provide the advanced search form.
static String	getSiteTopbar()
static String	getSpecificEdit(Class<?> clazz) Gives the JSP really used when a call to edit.jsp is done.
static String	getSpecificEdit(Data data) Gives the JSP really used when a call to edit.jsp is done.
static String	getTooltipIcon() Retrieve the path of tooltip icon.
static String	getWorkspacesList() Retrieve the relative path of the "workspacesList" jsp/servlet .
static String	getWorkspaceWizard() Retrieve the relative path of the "workspaceWizard" jsp/servlet.
void	propertiesChange(JProperties properties) Invoked after properties have been modified in JCMS and save on disk.

Methods inherited from class java.lang.Object

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

Field Detail

LOGIN_PROP

public static final String LOGIN_PROP

Property used to retrieve the path of the login jsp/servlet. getLogin()

See Also:

Constant Field Values

MAIL_PASSWORD_PROP

public static final String MAIL_PASSWORD_PROP

Property used to retrieve path of the mail password jsp/servlet. getMailPassword()

See Also:

Constant Field Values

PRIVATE_LOGIN_PROP

public static final String PRIVATE_LOGIN_PROP

Property used to retrieve the path of the private login jsp/servlet. getPrivateLogin()

See Also:

Constant Field Values

PRIVATE_MAIL_PASSWORD_PROP

public static final String PRIVATE_MAIL_PASSWORD_PROP

Property used to retrieve path of the private mail password jsp/servlet. getPrivateMailPassword()

See Also:

Constant Field Values

LOGOUT_PROP

public static final String LOGOUT_PROP

Property used to retrieve the path of the loggout jsp/servlet. getLogout()

See Also:

Constant Field Values

WORKSPACE_WIZARD_PROP

public static final String WORKSPACE_WIZARD_PROP

Property used to retrieve the path to the workspace wizard jsp/servlet. getWorkspaceWizard()

See Also:

Constant Field Values

WORKSPACES_LIST_PROP

public static final String WORKSPACES_LIST_PROP

Property used to retrieve the path to the workspaces list jsp/servlet. getWorkspacesList()

See Also:

Constant Field Values

DEFAULT_SKIN_PROP

public static final String DEFAULT_SKIN_PROP

Property used to retrieve the path to the default Portlet Wrapper. getDefaultSkin()

See Also:

Constant Field Values

DEFAULT_TEMPLATE_PROP

public static final String DEFAULT_TEMPLATE_PROP

Property used to retrieve the path to the default template usage. getDefaultTemplate(String)

See Also:

Constant Field Values

SITE_TOPBAR

public static final String SITE_TOPBAR

Property used to retrieve the path to the site topbar. getSiteTopbar()

See Also:

Constant Field Values

SEARCH_PROP

public static final String SEARCH_PROP

Property used to retrieve the path of the advanced search jsp/servlet. getSearch()

See Also:

Constant Field Values

REFINE_PROP

public static final String REFINE_PROP

Property used to retrieve the path of the refine jsp/servlet. getRefine()

See Also:

Constant Field Values

QUERY_PROP

public static final String QUERY_PROP

Property used to retrieve the path of the query jsp/servlet. getQuery()

See Also:

Constant Field Values

QUERYXML_PROP

public static final String QUERYXML_PROP

Property used to retrieve the path of the query jsp/servlet return xml content. getQueryXml()

See Also:

Constant Field Values

QUERYCSV_PROP

public static final String QUERYCSV_PROP

Property used to retrieve the path of the query jsp/servlet returning csv content. getQueryCsv()

See Also:

Constant Field Values

MEMBER_DISPLAY_PROP

public static final String MEMBER_DISPLAY_PROP

Property used to retrieve the path of jsp/servlet to display a member. getMemberDisplay()

See Also:

Constant Field Values

MEMBER_PROFILE_PROP

public static final String MEMBER_PROFILE_PROP

Property used to retrieve the path of jsp/servlet to display a member profile. getMemberProfile()

See Also:

Constant Field Values

ICON_MEMBER_ADMIN

public static final String ICON_MEMBER_ADMIN

Property used to retrieve the path of admins' member icon.

See Also:

Constant Field Values

ICON_MEMBER_WSADMIN

public static final String ICON_MEMBER_WSADMIN

Property used to retrieve the path of workspace admins' member icon.

See Also:

Constant Field Values

ICON_MEMBER_WRITER

public static final String ICON_MEMBER_WRITER

Property used to retrieve the path of writers' icon.

See Also:

Constant Field Values

ICON_MEMBER_DEFAULT

public static final String ICON_MEMBER_DEFAULT

Property used to retrieve the path of the default members' icon.

See Also:

Constant Field Values

ICON_MEMBER_LDAP_ADMIN

public static final String ICON_MEMBER_LDAP_ADMIN

Property used to retrieve the path of admins' ldap member icon.

See Also:

Constant Field Values

ICON_MEMBER_LDAP_WSADMIN

public static final String ICON_MEMBER_LDAP_WSADMIN

Property used to retrieve the path of ldap workspace admins' ldap member icon.

See Also:

Constant Field Values

ICON_MEMBER_LDAP_WRITER

public static final String ICON_MEMBER_LDAP_WRITER

Property used to retrieve the path of ldap writers' member icon.

See Also:

Constant Field Values

ICON_MEMBER_LDAP_DEFAULT

public static final String ICON_MEMBER_LDAP_DEFAULT

Property used to retrieve the path of the default ldap members' icon.

See Also:

Constant Field Values

ICON_LOGIN

public static final String ICON_LOGIN

Property used to retrieve the path of the login icon.

See Also:

Constant Field Values

ICON_LOGOUT

public static final String ICON_LOGOUT

Property used to retrieve the path of the logout icon.

See Also:

Constant Field Values

ICON_LOGBACK

public static final String ICON_LOGBACK

Property used to retrieve the path of the logback icon.

See Also:

Constant Field Values

ICON_DBMEMBER_DEFAULT

public static final String ICON_DBMEMBER_DEFAULT

Property used to retrieve the path of the default DBmembers' icon.

See Also:

Constant Field Values

ICON_MEMBER_CONTACT

public static final String ICON_MEMBER_CONTACT

Property used to retrieve the path of the contact DBmembers' icon.

See Also:

Constant Field Values

ICON_GROUP_DEFAULT

public static final String ICON_GROUP_DEFAULT

Property used to retrieve the path of groups' icon.

See Also:

Constant Field Values

ICON_GROUP_PARENT

public static final String ICON_GROUP_PARENT

Property used to retrieve the path of parent groups' icon.

See Also:

Constant Field Values

ICON_GROUP_LDAP_DEFAULT

public static final String ICON_GROUP_LDAP_DEFAULT

Property used to retrieve the path of ldap groups' icon.

See Also:

Constant Field Values

ICON_GROUP_LDAP_PARENT

public static final String ICON_GROUP_LDAP_PARENT

Property used to retrieve the path of ldap parent groups' icon.

See Also:

Constant Field Values

ICON_TOOLTIP

public static final String ICON_TOOLTIP

Property used to retrieve the path of the tooltip icon.

See Also:

Constant Field Values

mapHTTPEquiv

protected Map<String,String> mapHTTPEquiv

mapHTTPName

protected Map<String,String> mapHTTPName

mapCSSHeader

protected Map<String,String> mapCSSHeader

mapJSHeader

protected Map<String,String> mapJSHeader

mapLESS

protected Map<String,String> mapLESS

Method Detail

getLogin

public static String getLogin()

Retrieve the relative path of the "login" jsp/servlet that should be used when accessing a site.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.0

getMailPassword

public static String getMailPassword()

Retrieve the relative path of the "mail password" jsp/servlet that should be used when providing a way for a user to retrieve its password.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.0

getPrivateLogin

public static String getPrivateLogin()

Retrieve the relative path of the "private login" jsp/servlet that should be used when accessing a private site (where authentication is required).

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.0

getPrivateMailPassword

public static String getPrivateMailPassword()

Retrieve the relative path of the "private mail password" jsp/servlet that should be used when providing a way for a user to retrieve its password when the site is private (where authentication is required).

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.0

getLogout

public static String getLogout()

Retrieve the relative path of the "logout" jsp/servlet that should be used when quitting a site.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.0

getWorkspaceWizard

public static String getWorkspaceWizard()

Retrieve the relative path of the "workspaceWizard" jsp/servlet.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.3

getWorkspacesList

public static String getWorkspacesList()

Retrieve the relative path of the "workspacesList" jsp/servlet .

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.3

getDefaultSkin

public static String getDefaultSkin()

Retrieve the relative path of the "default skin" jsp/servlet .

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.3

getDefaultTemplate

public static String getDefaultTemplate(String usage)

Retrieve the relative path of the "default template" jsp/servlet .

Parameters:

usage - the usage or null

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-6.0.0

getSiteTopbar

public static String getSiteTopbar()

getSearch

public static String getSearch()

Retrieve the relative path of the "search" jsp/servlet that should be used to provide the advanced search form.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.0

getRefine

public static String getRefine()

Retrieve the relative path of the "search" jsp/servlet that should be used to provide the refine search form.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.0

getQuery

public static String getQuery()

Retrieve the relative path of the "query" jsp/servlet that should be used to perform a search and display the results.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.0

getQueryXml

public static String getQueryXml()

Retrieve the relative path of the "query" jsp/servlet that should be used to perform a search and display the results as XML content.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-6.0.1

getQueryCsv

public static String getQueryCsv()

Retrieve the relative path of the "query" jsp/servlet that should be used to perform a search and display the results as CSV content.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-6.0.1

getMemberDisplay

public static String getMemberDisplay()

Retrieve the relative path of the "member display" jsp/servlet that should be used to display a member's information.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.2

getMemberProfile

public static String getMemberProfile()

Retrieve the relative path of the "member profile" jsp/servlet that should be used to display a member's profile.

Returns:

a path relative to the webapp (no starting slash).

Since:

jcms-5.7.2

getMemberAdminIcon

public static String getMemberAdminIcon()

Retrieve the path of admins' member icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getMemberWsAdminIcon

public static String getMemberWsAdminIcon()

Retrieve the path of workspace admins' member icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getMemberWriterIcon

public static String getMemberWriterIcon()

Retrieve the path of the default members' icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getMemberDefaultIcon

public static String getMemberDefaultIcon()

Retrieve the path of the default members' icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getMemberLdapAdminIcon

public static String getMemberLdapAdminIcon()

Retrieve the path of admins' ldap member icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getMemberLdapWsAdminIcon

public static String getMemberLdapWsAdminIcon()

Retrieve the path of ldap workspace admins' ldap member icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getMemberLdapWriterIcon

public static String getMemberLdapWriterIcon()

Retrieve the path of ldap writers' member icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getMemberLdapDefaultIcon

public static String getMemberLdapDefaultIcon()

Retrieve the path of the default ldap members' icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getLoginIcon

public static String getLoginIcon()

Retrieve the path of the login icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-6.1.1

getLogoutIcon

public static String getLogoutIcon()

Retrieve the path of the logout icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-6.1.1

getLogbackIcon

public static String getLogbackIcon()

Retrieve the path of the logback icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-6.1.1

getMemberContactIcon

public static String getMemberContactIcon()

Retrieve the path of the contact members' icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-6.1.0

getDBMemberDefaultIcon

public static String getDBMemberDefaultIcon()

Retrieve the path of the default DB members' icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-6.1

getGroupDefaultIcon

public static String getGroupDefaultIcon()

Retrieve the path of groups' icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getGroupParentIcon

public static String getGroupParentIcon()

Retrieve the path of parent groups' icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getGroupLdapDefaultIcon

public static String getGroupLdapDefaultIcon()

Retrieve the path of ldap groups icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getGroupLdapParentIcon

public static String getGroupLdapParentIcon()

Retrieve the path of ldap parent groups' icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-5.7.0

getTooltipIcon

public static String getTooltipIcon()

Retrieve the path of tooltip icon.

Returns:

an image path relative to the webapp (no starting slash), e.g. "images/something.gif" .

Since:

jcms-6.0.0

getSpecificEdit

public static String getSpecificEdit(Class<?> clazz)

Gives the JSP really used when a call to edit.jsp is done.

Parameters:

clazz - the Java sub class of Data for which a specific edit JSP is mandatory

Returns:

the specific Edit JSP

getSpecificEdit

public static String getSpecificEdit(Data data)

Gives the JSP really used when a call to edit.jsp is done.

Parameters:

data - the Data for which a specific edit JSP is mandatory

Returns:

the specific Edit JSP

getInstance

public static ResourceHelper getInstance()

Returns the singleton. Caution: This method is not thread-safe.

Returns:

the singleton.

Since:

jcms-7.1.0

propertiesChange

public void propertiesChange(JProperties properties)

Description copied from interface: JPropertiesListener

Invoked after properties have been modified in JCMS and save on disk.

You cannot alter the value received in parameters.

Specified by:

propertiesChange in interface JPropertiesListener

Parameters:

properties - the properties which have been modified (may not contain all JCMS properties)

getHTTPEquivHeaderMap

public Map<String,String> getHTTPEquivHeaderMap()

getHTTPNameHeaderMap

public Map<String,String> getHTTPNameHeaderMap()

getHTTPCSSHeaderMap

public Map<String,String> getHTTPCSSHeaderMap()

getHTTPJSHeaderMap

public Map<String,String> getHTTPJSHeaderMap()

getLESSMap

public Map<String,String> getLESSMap()

compileLESS

public void compileLESS(boolean override)