All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencms.jsp.Messages Maven / Gradle / Ivy

Go to download

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0
Show newest version
/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software GmbH & Co. KG, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.jsp;

import org.opencms.file.CmsObject;
import org.opencms.file.CmsRequestContext;
import org.opencms.flex.CmsFlexController;
import org.opencms.i18n.A_CmsMessageBundle;
import org.opencms.i18n.CmsMessageContainer;
import org.opencms.i18n.I_CmsMessageBundle;

import java.util.Locale;

import javax.servlet.ServletRequest;
import javax.servlet.jsp.PageContext;

/**
 * Convenience class to access the localized messages of this OpenCms package.
 * 

* * * Additionally two utility methods for localization in the context of * {@link javax.servlet.jsp.tagext.TagSupport} implementations of the org.opencms.jsp * package are provided . *

* * The javax.servlet.jsp.tagext.TagSupport API constraint only allows to throw * certain Exception types which forbids to use {@link org.opencms.main.CmsException} * which will be localized with the current user's locale at the time the request is evaluated. *

* * At the same time TagSupport implementations may use their member * pageContext to get the CmsObject and therefore the user request's * locale. *

* * These methods provided here factor out the localization of exception messages and return Strings * for the org.opencms.jsp pacakge. *

* * @since 6.0.0 */ public final class Messages extends A_CmsMessageBundle { /** Message constant for key in the resource bundle. */ public static final String ERR_BAD_REQUEST_RESPONSE_0 = "ERR_BAD_REQUEST_RESPONSE_0"; /** Message constant for key in the resource bundle. */ public static final String ERR_COLLECTOR_NOT_FOUND_1 = "ERR_COLLECTOR_NOT_FOUND_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_CONTAINER_PAGE_ELEMENT_RENDER_ERROR_2 = "ERR_CONTAINER_PAGE_ELEMENT_RENDER_ERROR_2"; /** Message constant for key in the resource bundle. */ public static final String ERR_CONTAINER_PAGE_NO_TYPE_3 = "ERR_CONTAINER_PAGE_NO_TYPE_3"; /** Message constant for key in the resource bundle. */ public static final String ERR_CONTAINER_PAGE_NOT_FOUND_3 = "ERR_CONTAINER_PAGE_NOT_FOUND_3"; /** Message constant for key in the resource bundle. */ public static final String ERR_DIRECT_EDIT_PROVIDER_1 = "ERR_DIRECT_EDIT_PROVIDER_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_IMAGE_TAG_VFS_ACCESS_1 = "ERR_IMAGE_TAG_VFS_ACCESS_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_MISSING_CMS_CONTROLLER_1 = "ERR_MISSING_CMS_CONTROLLER_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_PARENTLESS_TAG_1 = "ERR_PARENTLESS_TAG_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_PROCESS_TAG_1 = "ERR_PROCESS_TAG_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_READING_REQUIRED_RESOURCE_1 = "ERR_READING_REQUIRED_RESOURCE_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_RESOURCE_IS_NOT_RELEASE_OR_EXPIRED_1 = "ERR_RESOURCE_IS_NOT_RELEASE_OR_EXPIRED_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_RUNTIME_1 = "ERR_RUNTIME_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_TAG_CONTENTCHECK_WRONG_PARENT_0 = "ERR_TAG_CONTENTCHECK_WRONG_PARENT_0"; /** Message constant for key in the resource bundle. */ public static final String ERR_TAG_CONTENTLOAD_INDEX_SIZE_0 = "ERR_TAG_CONTENTLOAD_INDEX_SIZE_0"; /** Message constant for key in the resource bundle. */ public static final String ERR_TAG_CONTENTLOAD_MISSING_COLLECTOR_0 = "ERR_TAG_CONTENTLOAD_MISSING_COLLECTOR_0"; /** Message constant for key in the resource bundle. */ public static final String ERR_TAG_CONTENTLOAD_MISSING_PARAM_0 = "ERR_TAG_CONTENTLOAD_MISSING_PARAM_0"; /** Message constant for key in the resource bundle. */ public static final String ERR_TAG_RESOURCELOAD_INDEX_SIZE_0 = "ERR_TAG_RESOURCELOAD_INDEX_SIZE_0"; /** Message constant for key in the resource bundle. */ public static final String ERR_TAG_RESOURCELOAD_MISSING_COLLECTOR_0 = "ERR_TAG_RESOURCELOAD_MISSING_COLLECTOR_0"; /** Message constant for key in the resource bundle. */ public static final String ERR_TAG_RESOURCELOAD_MISSING_PARAM_0 = "ERR_TAG_RESOURCELOAD_MISSING_PARAM_0"; /** Message constant for key in the resource bundle. */ public static final String ERR_TAG_INVALID_LOCALE_1 = "ERR_TAG_INVALID_LOCALE_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_XML_DOCUMENT_UNMARSHAL_1 = "ERR_XML_DOCUMENT_UNMARSHAL_1"; /** Message constant for key in the resource bundle. */ public static final String ERR_XSD_NO_TEMPLATE_FORMATTER_3 = "ERR_XSD_NO_TEMPLATE_FORMATTER_3"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_ACTIONELEM_NOT_INIT_0 = "GUI_ERR_ACTIONELEM_NOT_INIT_0"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_FILE_PROP_MISSING_2 = "GUI_ERR_FILE_PROP_MISSING_2"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_GEN_LINK_1 = "GUI_ERR_GEN_LINK_1"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_IMG_SCALE_2 = "GUI_ERR_IMG_SCALE_2"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_INFO_PROP_READ_1 = "GUI_ERR_INFO_PROP_READ_1"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_INVALID_INFO_PROP_0 = "GUI_ERR_INVALID_INFO_PROP_0"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_INVALID_INFO_PROP_1 = "GUI_ERR_INVALID_INFO_PROP_1"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_INVALID_USER_PROP_1 = "GUI_ERR_INVALID_USER_PROP_1"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_TAG_ATTRIBUTE_INVALID_3 = "GUI_ERR_TAG_ATTRIBUTE_INVALID_3"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_TAG_ATTRIBUTE_MISSING_2 = "GUI_ERR_TAG_ATTRIBUTE_MISSING_2"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_USER_PROP_READ_1 = "GUI_ERR_USER_PROP_READ_1"; /** Message constant for key in the resource bundle. */ public static final String GUI_ERR_WORKPL_LABEL_READ_1 = "GUI_ERR_WORKPL_LABEL_READ_1"; /** Message constant for key in the resource bundle. */ public static final String GUI_LABEL_STACKTRACE_0 = "GUI_LABEL_STACKTRACE_0"; /** Message constant for key in the resource bundle. */ public static final String GUI_TAG_USER_ADDITIONALINFO_0 = "GUI_TAG_USER_ADDITIONALINFO_0"; /** Message constant for key in the resource bundle. */ public static final String LOG_CONTAINER_NOT_FOUND_3 = "LOG_CONTAINER_NOT_FOUND_3"; /** Message constant for key in the resource bundle. */ public static final String LOG_DEBUG_INTERRUPTED_EXCEPTION_1 = "LOG_DEBUG_INTERRUPTED_EXCEPTION_1"; /** Message constant for key in the resource bundle. */ public static final String LOG_ERR_CONTENT_SHOW_1 = "LOG_ERR_CONTENT_SHOW_1"; /** Message constant for key in the resource bundle. */ public static final String LOG_ERR_JSP_BEAN_0 = "LOG_ERR_JSP_BEAN_0"; /** Message constant for key in the resource bundle. */ public static final String LOG_ERR_JSP_WRITE_0 = "LOG_ERR_JSP_WRITE_0"; /** Message constant for key in the resource bundle. */ public static final String LOG_LOGIN_FAILED_3 = "LOG_LOGIN_FAILED_3"; /** Message constant for key in the resource bundle. */ public static final String LOG_LOGIN_FAILED_DB_REASON_3 = "LOG_LOGIN_FAILED_DB_REASON_3"; /** Message constant for key in the resource bundle. */ public static final String LOG_LOGIN_FAILED_DISABLED_3 = "LOG_LOGIN_FAILED_DISABLED_3"; /** Message constant for key in the resource bundle. */ public static final String LOG_LOGIN_FAILED_NO_USER_3 = "LOG_LOGIN_FAILED_NO_USER_3"; /** Message constant for key in the resource bundle. */ public static final String LOG_LOGIN_FAILED_TEMP_DISABLED_5 = "LOG_LOGIN_FAILED_TEMP_DISABLED_5"; /** Message constant for key in the resource bundle. */ public static final String LOG_LOGIN_FAILED_WITH_MESSAGE_4 = "LOG_LOGIN_FAILED_WITH_MESSAGE_4"; /** Message constant for key in the resource bundle. */ public static final String LOG_LOGIN_SUCCESSFUL_3 = "LOG_LOGIN_SUCCESSFUL_3"; /** Message constant for key in the resource bundle. */ public static final String LOG_LOGOUT_SUCCESFUL_3 = "LOG_LOGOUT_SUCCESFUL_3"; /** Message constant for key in the resource bundle. */ public static final String LOG_MAXELEMENTS_NOT_SET_2 = "LOG_MAXELEMENTS_NOT_SET_2"; /** Message constant for key in the resource bundle. */ public static final String LOG_WRONG_CONTAINER_MAXELEMENTS_3 = "LOG_WRONG_CONTAINER_MAXELEMENTS_3"; /** Message constant for key in the resource bundle. */ public static final String LOG_WRONG_CONTAINER_TYPE_4 = "LOG_WRONG_CONTAINER_TYPE_4"; /** Message constant for key in the resource bundle. */ public static final String LOG_WRONG_DEVICE_TYPE_2 = "LOG_WRONG_DEVICE_TYPE_2"; /** Message constant for key in the resource bundle. */ public static final String LOG_TAG_SEARCH_SEARCH_FAILED_0 = "LOG_TAG_SEARCH_SEARCH_FAILED_0"; /** Name of the used resource bundle. */ private static final String BUNDLE_NAME = "org.opencms.jsp.messages"; /** Static instance member. */ private static final I_CmsMessageBundle INSTANCE = new Messages(); /** * Hides the public constructor for this utility class. *

*/ private Messages() { // hide the constructor } /** * Returns an instance of this localized message accessor. *

* * @return an instance of this localized message accessor */ public static I_CmsMessageBundle get() { return INSTANCE; } /** * Returns the String for the given CmsMessageContainer localized to the current user's locale * if available or to the default locale else. *

* * This method is needed for localization of non- {@link org.opencms.main.CmsException} * instances that have to be thrown here due to API constraints (javax.servlet.jsp). *

* * @param container A CmsMessageContainer containing the message to localize. * @param cms the CmsObject belonging to the current user (e.g. obtained with * CmsFlexController.getCmsObject(ServletRequest)). * @return the String for the given CmsMessageContainer localized to the current user's locale * if available or to the default locale else. *

*/ public static String getLocalizedMessage(CmsMessageContainer container, CmsObject cms) { Locale locale; if (cms != null) { CmsRequestContext context = cms.getRequestContext(); locale = (context != null) ? context.getLocale() : Locale.getDefault(); } else { locale = Locale.getDefault(); } return container.key(locale); } /** * Returns the String for the given CmsMessageContainer localized to the current user's locale * if available or to the default locale else. *

* * This method is needed for localization of non- {@link org.opencms.main.CmsException} * instances that have to be thrown here due to API constraints (javax.servlet.jsp). *

* * @param container A CmsMessageContainer containing the message to localize. * @param context The page context that is known to any calling * {@link javax.servlet.jsp.tagext.TagSupport} instance (member * pageContext). * @return the String for the given CmsMessageContainer localized to the current user's locale * if available or to the default locale else. *

*/ public static String getLocalizedMessage(CmsMessageContainer container, PageContext context) { return Messages.getLocalizedMessage(container, context.getRequest()); } /** * Returns the String for the given CmsMessageContainer localized to the current user's locale * if available or to the default locale else. *

* * This method allows a static method ({@link CmsJspTagInfo#infoTagAction(String, javax.servlet.http.HttpServletRequest)}) * that has no pageContext in scope to lookup the locale at request time. *

* * @see #getLocalizedMessage(CmsMessageContainer, PageContext) * @param container A CmsMessageContainer containing the message to localize. * @param request The current request. * @return the String for the given CmsMessageContainer localized to the current user's locale * if available or to the default locale else. *

*/ public static String getLocalizedMessage(CmsMessageContainer container, ServletRequest request) { CmsObject cms = CmsFlexController.getCmsObject(request); return getLocalizedMessage(container, cms); } /** * Returns the bundle name for this OpenCms package. *

* * @return the bundle name for this OpenCms package */ public String getBundleName() { return BUNDLE_NAME; } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy