public class ResourceHelper extends java.lang.Object implements JPropertiesListener
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_SKIN_PROP
Property used to retrieve the path to the default Portlet Wrapper.
|
static java.lang.String |
DEFAULT_TEMPLATE_PROP
Property used to retrieve the path to the default template usage.
|
static java.lang.String |
ICON_DBMEMBER_DEFAULT
Property used to retrieve the path of the default DBmembers' icon.
|
static java.lang.String |
ICON_GROUP_DEFAULT
Property used to retrieve the path of groups' icon.
|
static java.lang.String |
ICON_GROUP_LDAP_DEFAULT
Property used to retrieve the path of ldap groups' icon.
|
static java.lang.String |
ICON_GROUP_LDAP_PARENT
Property used to retrieve the path of ldap parent groups' icon.
|
static java.lang.String |
ICON_GROUP_PARENT
Property used to retrieve the path of parent groups' icon.
|
static java.lang.String |
ICON_LOGBACK
Property used to retrieve the path of the logback icon.
|
static java.lang.String |
ICON_LOGIN
Property used to retrieve the path of the login icon.
|
static java.lang.String |
ICON_LOGOUT
Property used to retrieve the path of the logout icon.
|
static java.lang.String |
ICON_MEMBER_ADMIN
Property used to retrieve the path of admins' member icon.
|
static java.lang.String |
ICON_MEMBER_CONTACT
Property used to retrieve the path of the contact DBmembers' icon.
|
static java.lang.String |
ICON_MEMBER_DEFAULT
Property used to retrieve the path of the default members' icon.
|
static java.lang.String |
ICON_MEMBER_LDAP_ADMIN
Property used to retrieve the path of admins' ldap member icon.
|
static java.lang.String |
ICON_MEMBER_LDAP_DEFAULT
Property used to retrieve the path of the default ldap members' icon.
|
static java.lang.String |
ICON_MEMBER_LDAP_WRITER
Property used to retrieve the path of ldap writers' member icon.
|
static java.lang.String |
ICON_MEMBER_LDAP_WSADMIN
Property used to retrieve the path of ldap workspace admins' ldap member icon.
|
static java.lang.String |
ICON_MEMBER_WRITER
Property used to retrieve the path of writers' icon.
|
static java.lang.String |
ICON_MEMBER_WSADMIN
Property used to retrieve the path of workspace admins' member icon.
|
static java.lang.String |
ICON_TOOLTIP
Property used to retrieve the path of the tooltip icon.
|
static java.lang.String |
LOGIN_PROP
Property used to retrieve the path of the login jsp/servlet.
|
static java.lang.String |
LOGOUT_PROP
Property used to retrieve the path of the loggout jsp/servlet.
|
static java.lang.String |
MAIL_PASSWORD_PROP
Property used to retrieve path of the mail password jsp/servlet.
|
protected java.util.Map<java.lang.String,java.lang.String> |
mapCSSHeader |
protected java.util.Map<java.lang.String,java.lang.String> |
mapHTTPEquiv |
protected java.util.Map<java.lang.String,java.lang.String> |
mapHTTPName |
protected java.util.Map<java.lang.String,java.lang.String> |
mapJSHeader |
protected java.util.Map<java.lang.String,java.lang.String> |
mapLESS |
static java.lang.String |
MEMBER_DISPLAY_PROP
Property used to retrieve the path of jsp/servlet to display a member.
|
static java.lang.String |
MEMBER_PHOTO
Property used to retrieve the path of the JSP to display the Member photo.
|
static java.lang.String |
MEMBER_PROFILE_PROP
Property used to retrieve the path of jsp/servlet to display a member profile.
|
static java.lang.String |
NOTIFICATION_EMAIL_HTML_JSP
Property used to retrieve the jsp sent as a notification
|
static java.lang.String |
PREVENT_ACCESS_TO_OVERRIDEN_JSP
Property name of the option enabing some JSP access check.
|
static java.lang.String |
PRIVATE_LOGIN_PROP
Property used to retrieve the path of the private login jsp/servlet.
|
static java.lang.String |
PRIVATE_MAIL_PASSWORD_PROP
Property used to retrieve path of the private mail password jsp/servlet.
|
static java.lang.String |
QUERY_PROP
Property used to retrieve the path of the query jsp/servlet.
|
static java.lang.String |
QUERYCSV_PROP
Property used to retrieve the path of the query jsp/servlet returning csv content.
|
static java.lang.String |
QUERYXML_PROP
Property used to retrieve the path of the query jsp/servlet return xml content.
|
static java.lang.String |
REFINE_PROP
Property used to retrieve the path of the refine jsp/servlet.
|
static java.lang.String |
SEARCH_PROP
Property used to retrieve the path of the advanced search jsp/servlet.
|
static java.lang.String |
SITE_TOPBAR
Property used to retrieve the path to the site topbar.
|
static java.lang.String |
WORKSPACE_WIZARD_PROP
Property used to retrieve the path to the workspace wizard jsp/servlet.
|
static java.lang.String |
WORKSPACES_LIST_PROP
Property used to retrieve the path to the workspaces list jsp/servlet.
|
REVISION
Modifier and Type | Method and Description |
---|---|
static boolean |
canBeAccessed(java.lang.String jspRelativePath,
JcmsJspContext jcmsContext)
Check if the specified JSP is authorized to be accessed (either directly or through dynamic include).
|
void |
compileLESS(boolean override) |
static java.lang.String |
getDBMemberDefaultIcon()
Retrieve the path of the default DB members' icon.
|
static java.lang.String |
getDefaultSkin()
Retrieve the relative path of the "default skin" jsp/servlet .
|
static java.lang.String |
getDefaultTemplate(java.lang.String usage)
Retrieve the relative path of the "default template" jsp/servlet .
|
static java.lang.String |
getGroupDefaultIcon()
Retrieve the path of groups' icon.
|
static java.lang.String |
getGroupLdapDefaultIcon()
Retrieve the path of ldap groups icon.
|
static java.lang.String |
getGroupLdapParentIcon()
Retrieve the path of ldap parent groups' icon.
|
static java.lang.String |
getGroupParentIcon()
Retrieve the path of parent groups' icon.
|
java.util.Map<java.lang.String,java.lang.String> |
getHTTPCSSHeaderMap() |
java.util.Map<java.lang.String,java.lang.String> |
getHTTPEquivHeaderMap() |
java.util.Map<java.lang.String,java.lang.String> |
getHTTPJSHeaderMap() |
java.util.Map<java.lang.String,java.lang.String> |
getHTTPNameHeaderMap() |
static ResourceHelper |
getInstance()
Returns the singleton.
|
java.util.Map<java.lang.String,java.lang.String> |
getLESSMap() |
static java.lang.String |
getLogbackIcon()
Retrieve the path of the logback icon.
|
static java.lang.String |
getLogin()
Retrieve the relative path of the "login" jsp/servlet that should be used
when accessing a site.
|
static java.lang.String |
getLoginIcon()
Retrieve the path of the login icon.
|
static java.lang.String |
getLogout()
Retrieve the relative path of the "logout" jsp/servlet that should be used
when quitting a site.
|
static java.lang.String |
getLogoutIcon()
Retrieve the path of the logout icon.
|
static java.lang.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 java.lang.String |
getMemberAdminIcon()
Retrieve the path of admins' member icon.
|
static java.lang.String |
getMemberContactIcon()
Retrieve the path of the contact members' icon.
|
static java.lang.String |
getMemberDefaultIcon()
Retrieve the path of the default members' icon.
|
static java.lang.String |
getMemberDisplay()
Retrieve the relative path of the "member display" jsp/servlet that should be used
to display a member's information.
|
static java.lang.String |
getMemberLdapAdminIcon()
Retrieve the path of admins' ldap member icon.
|
static java.lang.String |
getMemberLdapDefaultIcon()
Retrieve the path of the default ldap members' icon.
|
static java.lang.String |
getMemberLdapWriterIcon()
Retrieve the path of ldap writers' member icon.
|
static java.lang.String |
getMemberLdapWsAdminIcon()
Retrieve the path of ldap workspace admins' ldap member icon.
|
static java.lang.String |
getMemberProfile()
Retrieve the relative path of the "member profile" jsp/servlet that should be used
to display a member's profile.
|
static java.lang.String |
getMemberWriterIcon()
Retrieve the path of the default members' icon.
|
static java.lang.String |
getMemberWsAdminIcon()
Retrieve the path of workspace admins' member icon.
|
static java.lang.String |
getNotificationEmailHtml()
Retrieve the path to the jsp which produce the notification mail
|
static java.lang.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 java.lang.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 java.lang.String |
getQuery()
Retrieve the relative path of the "query" jsp/servlet that should be used
to perform a search and display the results.
|
static java.lang.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 java.lang.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 java.lang.String |
getRefine()
Retrieve the relative path of the "search" jsp/servlet that should be used
to provide the refine search form.
|
static java.lang.String |
getSearch()
Retrieve the relative path of the "search" jsp/servlet that should be used
to provide the advanced search form.
|
static java.lang.String |
getSiteTopbar() |
static java.lang.String |
getSpecificEdit(java.lang.Class<?> clazz)
Gives the JSP really used when a call to edit.jsp is done.
|
static java.lang.String |
getSpecificEdit(Data data)
Gives the JSP really used when a call to edit.jsp is done.
|
static java.lang.String |
getTooltipIcon()
Retrieve the path of tooltip icon.
|
static java.lang.String |
getWorkspacesList()
Retrieve the relative path of the "workspacesList" jsp/servlet .
|
static java.lang.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.
|
public static final java.lang.String LOGIN_PROP
getLogin()
public static final java.lang.String MAIL_PASSWORD_PROP
getMailPassword()
public static final java.lang.String PRIVATE_LOGIN_PROP
getPrivateLogin()
public static final java.lang.String PRIVATE_MAIL_PASSWORD_PROP
getPrivateMailPassword()
public static final java.lang.String LOGOUT_PROP
getLogout()
public static final java.lang.String WORKSPACE_WIZARD_PROP
getWorkspaceWizard()
public static final java.lang.String WORKSPACES_LIST_PROP
getWorkspacesList()
public static final java.lang.String DEFAULT_SKIN_PROP
getDefaultSkin()
public static final java.lang.String DEFAULT_TEMPLATE_PROP
getDefaultTemplate(String)
public static final java.lang.String SITE_TOPBAR
getSiteTopbar()
public static final java.lang.String SEARCH_PROP
getSearch()
public static final java.lang.String REFINE_PROP
getRefine()
public static final java.lang.String QUERY_PROP
getQuery()
public static final java.lang.String QUERYXML_PROP
getQueryXml()
public static final java.lang.String QUERYCSV_PROP
getQueryCsv()
public static final java.lang.String MEMBER_DISPLAY_PROP
getMemberDisplay()
public static final java.lang.String MEMBER_PROFILE_PROP
getMemberProfile()
public static final java.lang.String ICON_MEMBER_ADMIN
public static final java.lang.String ICON_MEMBER_WSADMIN
public static final java.lang.String ICON_MEMBER_WRITER
public static final java.lang.String ICON_MEMBER_DEFAULT
public static final java.lang.String ICON_MEMBER_LDAP_ADMIN
public static final java.lang.String ICON_MEMBER_LDAP_WSADMIN
public static final java.lang.String ICON_MEMBER_LDAP_WRITER
public static final java.lang.String ICON_MEMBER_LDAP_DEFAULT
public static final java.lang.String ICON_LOGIN
public static final java.lang.String ICON_LOGOUT
public static final java.lang.String ICON_LOGBACK
public static final java.lang.String ICON_DBMEMBER_DEFAULT
public static final java.lang.String ICON_MEMBER_CONTACT
public static final java.lang.String ICON_GROUP_DEFAULT
public static final java.lang.String ICON_GROUP_PARENT
public static final java.lang.String ICON_GROUP_LDAP_DEFAULT
public static final java.lang.String ICON_GROUP_LDAP_PARENT
public static final java.lang.String NOTIFICATION_EMAIL_HTML_JSP
public static final java.lang.String ICON_TOOLTIP
public static final java.lang.String MEMBER_PHOTO
public static final java.lang.String PREVENT_ACCESS_TO_OVERRIDEN_JSP
canBeAccessed(String, JcmsJspContext)
,
Constant Field Valuesprotected java.util.Map<java.lang.String,java.lang.String> mapHTTPEquiv
protected java.util.Map<java.lang.String,java.lang.String> mapHTTPName
protected java.util.Map<java.lang.String,java.lang.String> mapCSSHeader
protected java.util.Map<java.lang.String,java.lang.String> mapJSHeader
protected java.util.Map<java.lang.String,java.lang.String> mapLESS
public static boolean canBeAccessed(java.lang.String jspRelativePath, JcmsJspContext jcmsContext)
This check is performed only if enabled through following property :
jcms.resource.prevent-access-to-overriden-jsp: true
As of current version, this method enforce the following rules :
{original-resource-property-name}.authorize-original-jsp-access: true
is declared to exclude the JSP from this behavior, (see front/logout.jsp
in the example below)
Example :
jcms.prop
contains the following properties :
jcms.resource.prevent-access-to-overriden-jsp: true jcms.resource.login: front/login.jsp jcms.resource.logout: front/logout.jsp jcms.resource.logout.authorize-original-jsp-access: trueAnd a plugin overrides some of them as follow :
jcms.resource.login: plugins/MyPlugin/jsp/login.jsp jcms.resource.logout: plugins/MyPlugin/jsp/logout.jspIn such case, access to
front/login.jsp
is forbidden,
while front/logout.jsp
is still authorized.jspRelativePath
- the relative path of the JSP being accessed,
path may or may not start with a slash, e.g : "/front/login.jsp"
or "front/login.jsp"
jcmsContext
- current JcmsJspContext (optionnal)public static java.lang.String getLogin()
public static java.lang.String getMailPassword()
public static java.lang.String getPrivateLogin()
public static java.lang.String getPrivateMailPassword()
public static java.lang.String getLogout()
public static java.lang.String getWorkspaceWizard()
public static java.lang.String getWorkspacesList()
public static java.lang.String getDefaultSkin()
public static java.lang.String getDefaultTemplate(java.lang.String usage)
usage
- the usage or nullpublic static java.lang.String getSiteTopbar()
public static java.lang.String getSearch()
public static java.lang.String getRefine()
public static java.lang.String getQuery()
public static java.lang.String getQueryXml()
public static java.lang.String getQueryCsv()
public static java.lang.String getMemberDisplay()
public static java.lang.String getMemberProfile()
public static java.lang.String getMemberAdminIcon()
public static java.lang.String getMemberWsAdminIcon()
public static java.lang.String getMemberWriterIcon()
public static java.lang.String getMemberDefaultIcon()
public static java.lang.String getMemberLdapAdminIcon()
public static java.lang.String getMemberLdapWsAdminIcon()
public static java.lang.String getMemberLdapWriterIcon()
public static java.lang.String getMemberLdapDefaultIcon()
public static java.lang.String getLoginIcon()
public static java.lang.String getLogoutIcon()
public static java.lang.String getLogbackIcon()
public static java.lang.String getMemberContactIcon()
public static java.lang.String getDBMemberDefaultIcon()
public static java.lang.String getGroupDefaultIcon()
public static java.lang.String getGroupParentIcon()
public static java.lang.String getGroupLdapDefaultIcon()
public static java.lang.String getGroupLdapParentIcon()
public static java.lang.String getNotificationEmailHtml()
public static java.lang.String getTooltipIcon()
public static java.lang.String getSpecificEdit(java.lang.Class<?> clazz)
clazz
- the Java sub class of Data for which a specific edit JSP is mandatorypublic static java.lang.String getSpecificEdit(Data data)
data
- the Data for which a specific edit JSP is mandatorypublic static ResourceHelper getInstance()
public void propertiesChange(JProperties properties)
JPropertiesListener
You cannot alter the value received in parameters.
propertiesChange
in interface JPropertiesListener
properties
- the properties which have been modified (may not contain all JCMS properties)public java.util.Map<java.lang.String,java.lang.String> getHTTPEquivHeaderMap()
public java.util.Map<java.lang.String,java.lang.String> getHTTPNameHeaderMap()
public java.util.Map<java.lang.String,java.lang.String> getHTTPCSSHeaderMap()
public java.util.Map<java.lang.String,java.lang.String> getHTTPJSHeaderMap()
public java.util.Map<java.lang.String,java.lang.String> getLESSMap()
public void compileLESS(boolean override)
Copyright © 2001-2010 Jalios SA. All Rights Reserved.