com.sun.faces.util.MessageUtils Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package com.sun.faces.util;
import java.text.MessageFormat;
import jakarta.faces.application.FacesMessage;
/**
*
* This class contains all message constants and utility methods for creating FacesMessage instances or
* localized Strings for said constants.
*
*/
public class MessageUtils {
// IMPORTANT - ensure that any new message constant is properly
// tested in test/com/sun/faces/util/TestUtil_messages (see comments
// in test class for details on the test).
public static final String APPLICATION_ASSOCIATE_CTOR_WRONG_CALLSTACK_ID = "com.sun.faces.APPLICATION_ASSOCIATE_CTOR_WRONG_CALLSTACK";
public static final String APPLICATION_ASSOCIATE_EXISTS_ID = "com.sun.faces.APPLICATION_ASSOCIATE_EXISTS";
public static final String ASSERTION_FAILED_ID = "com.sun.faces.ASSERTION_FAILED";
public static final String ATTRIBUTE_NOT_SUPORTED_ERROR_MESSAGE_ID = "com.sun.faces.ATTRIBUTE_NOT_SUPORTED";
public static final String CANT_CLOSE_INPUT_STREAM_ID = "com.sun.faces.CANT_CLOSE_INPUT_STREAM";
public static final String CANT_CONVERT_VALUE_ERROR_MESSAGE_ID = "com.sun.faces.CANT_CONVERT_VALUE";
public static final String CANT_CREATE_CLASS_ERROR_ID = "com.sun.faces.CANT_CREATE_CLASS_ERROR";
public static final String CANT_CREATE_LIFECYCLE_ERROR_MESSAGE_ID = "com.sun.faces.CANT_CREATE_LIFECYCLE_ERROR";
public static final String CANT_INSTANTIATE_CLASS_ERROR_MESSAGE_ID = "com.sun.faces.CANT_INSTANTIATE_CLASS";
public static final String CANT_INTROSPECT_CLASS_ERROR_MESSAGE_ID = "com.sun.faces.CANT_INTROSPECT_CLASS";
public static final String CANT_LOAD_CLASS_ERROR_MESSAGE_ID = "com.sun.faces.CANT_INSTANTIATE_CLASS";
public static final String CANT_PARSE_FILE_ERROR_MESSAGE_ID = "com.sun.faces.CANT_PARSE_FILE";
public static final String CANT_WRITE_ID_ATTRIBUTE_ERROR_MESSAGE_ID = "com.sun.faces.CANT_WRITE_ID_ATTRIBUTE";
public static final String CHILD_NOT_OF_EXPECTED_TYPE_ID = "com.sun.faces.CHILD_NOT_OF_EXPECTED_TYPE";
public static final String COMMAND_LINK_NO_FORM_MESSAGE_ID = "com.sun.faces.COMMAND_LINK_NO_FORM_MESSAGE";
public static final String COMPONENT_NOT_FOUND_ERROR_MESSAGE_ID = "com.sun.faces.COMPONENT_NOT_FOUND_ERROR";
public static final String COMPONENT_NOT_FOUND_IN_VIEW_WARNING_ID = "com.sun.faces.COMPONENT_NOT_FOUND_IN_VIEW_WARNING";
public static final String CONTENT_TYPE_ERROR_MESSAGE_ID = "com.sun.faces.CONTENT_TYPE_ERROR";
public static final String CONVERSION_ERROR_MESSAGE_ID = "com.sun.faces.TYPECONVERSION_ERROR";
public static final String CYCLIC_REFERENCE_ERROR_ID = "com.sun.faces.CYCLIC_REFERENCE_ERROR";
public static final String DUPLICATE_COMPONENT_ID_ERROR_ID = "com.sun.faces.DUPLICATE_COMPONENT_ID_ERROR";
public static final String EL_OUT_OF_BOUNDS_ERROR_ID = "com.sun.faces.OUT_OF_BOUNDS_ERROR";
public static final String EL_PROPERTY_TYPE_ERROR_ID = "com.sun.faces.PROPERTY_TYPE_ERROR";
public static final String EL_SIZE_OUT_OF_BOUNDS_ERROR_ID = "com.sun.faces.SIZE_OUT_OF_BOUNDS_ERROR";
public static final String EMPTY_PARAMETER_ID = "com.sun.faces.EMPTY_PARAMETER";
public static final String ENCODING_ERROR_MESSAGE_ID = "com.sun.faces.ENCODING_ERROR";
public static final String ERROR_GETTING_VALUEREF_VALUE_ERROR_MESSAGE_ID = "com.sun.faces.ERROR_GETTING_VALUEREF_VALUE";
public static final String ERROR_GETTING_VALUE_BINDING_ERROR_MESSAGE_ID = "com.sun.faces.ERROR_GETTING_VALUE_BINDING";
public static final String ERROR_OPENING_FILE_ERROR_MESSAGE_ID = "com.sun.faces.ERROR_OPENING_FILE";
public static final String ERROR_PROCESSING_CONFIG_ID = "com.sun.faces.ERROR_PROCESSING_CONFIG";
public static final String ERROR_REGISTERING_DTD_ERROR_MESSAGE_ID = "com.sun.faces.ERROR_REGISTERING_DTD";
public static final String ERROR_SETTING_BEAN_PROPERTY_ERROR_MESSAGE_ID = "com.sun.faces.ERROR_SETTING_BEAN_PROPERTY";
public static final String EVAL_ATTR_UNEXPECTED_TYPE = "com.sun.faces.EVAL_ATTR_UNEXPECTED_TYPE";
public static final String FACES_CONTEXT_CONSTRUCTION_ERROR_MESSAGE_ID = "com.sun.faces.FACES_CONTEXT_CONSTRUCTION_ERROR";
public static final String FACES_SERVLET_MAPPING_CANNOT_BE_DETERMINED_ID = "com.sun.faces.FACES_SERVLET_MAPPING_CANNOT_BE_DETERMINED";
public static final String FACES_SERVLET_MAPPING_INCORRECT_ID = "com.sun.faces.FACES_SERVLET_MAPPING_INCORRECT";
public static final String FACES_CONTEXT_NOT_FOUND_ID = "com.sun.faces.FACES_CONTEXT_NOT_FOUND";
public static final String FILE_NOT_FOUND_ERROR_MESSAGE_ID = "com.sun.faces.FILE_NOT_FOUND";
public static final String ILLEGAL_ATTEMPT_SETTING_APPLICATION_ARTIFACT_ID = "com.sun.faces.ILLEGAL_ATTEMPT_SETTING_APPLICATION_ARTIFACT";
public static final String ILLEGAL_CHARACTERS_ERROR_MESSAGE_ID = "com.sun.faces.ILLEGAL_CHARACTERS_ERROR";
public static final String ILLEGAL_IDENTIFIER_LVALUE_MODE_ID = "com.sun.faces.ILLEGAL_IDENTIFIER_LVALUE_MODE";
public static final String ILLEGAL_MODEL_REFERENCE_ID = "com.sun.faces.ILLEGAL_MODEL_REFERENCE";
public static final String ILLEGAL_VIEW_ID_ID = "com.sun.faces.ILLEGAL_VIEW_ID";
public static final String INVALID_EXPRESSION_ID = "com.sun.faces.INVALID_EXPRESSION";
public static final String INVALID_INIT_PARAM_ERROR_MESSAGE_ID = "com.sun.faces.INVALID_INIT_PARAM";
public static final String INVALID_MESSAGE_SEVERITY_IN_CONFIG_ID = "com.sun.faces.INVALID_MESSAGE_SEVERITY_IN_CONFIG";
public static final String INVALID_SCOPE_LIFESPAN_ERROR_MESSAGE_ID = "com.sun.faces.INVALID_SCOPE_LIFESPAN";
public static final String LIFECYCLE_ID_ALREADY_ADDED_ID = "com.sun.faces.LIFECYCLE_ID_ALREADY_ADDED";
public static final String LIFECYCLE_ID_NOT_FOUND_ERROR_MESSAGE_ID = "com.sun.faces.LIFECYCLE_ID_NOT_FOUND";
public static final String MANAGED_BEAN_CANNOT_SET_LIST_ARRAY_PROPERTY_ID = "com.sun.faces.MANAGED_BEAN_CANNOT_SET_LIST_ARRAY_PROPERTY";
public static final String MANAGED_BEAN_EXISTING_VALUE_NOT_LIST_ID = "com.sun.faces.MANAGED_BEAN_EXISTING_VALUE_NOT_LIST";
public static final String MANAGED_BEAN_TYPE_CONVERSION_ERROR_ID = "com.sun.faces.MANAGED_BEAN_TYPE_CONVERSION_ERROR";
public static final String MANAGED_BEAN_CLASS_NOT_FOUND_ERROR_ID = "com.sun.faces.MANAGED_BEAN_CLASS_NOT_FOUND_ERROR";
public static final String MANAGED_BEAN_CLASS_DEPENDENCY_NOT_FOUND_ERROR_ID = "com.sun.faces.MANAGED_BEAN_CLASS_DEPENDENCY_NOT_FOUND_ERROR";
public static final String MANAGED_BEAN_CLASS_IS_NOT_PUBLIC_ERROR_ID = "com.sun.faces.MANAGED_BEAN_CLASS_IS_NOT_PUBLIC_ERROR";
public static final String MANAGED_BEAN_CLASS_IS_ABSTRACT_ERROR_ID = "com.sun.faces.MANAGED_BEAN_CLASS_IS_ABSTRACT_ERROR";
public static final String MANAGED_BEAN_CLASS_NO_PUBLIC_NOARG_CTOR_ERROR_ID = "com.sun.faces.MANAGED_BEAN_CLASS_NO_PUBLIC_NOARG_CTOR_ERROR";
public static final String MANAGED_BEAN_INJECTION_ERROR_ID = "com.sun.faces.MANAGED_BEAN_INJECTION_ERROR";
public static final String MANAGED_BEAN_LIST_PROPERTY_CONFIG_ERROR_ID = "com.sun.faces.MANAGED_BEAN_LIST_PROPERTY_CONFIG_ERROR";
public static final String MANAGED_BEAN_AS_LIST_CONFIG_ERROR_ID = "com.sun.faces.MANAGED_BEAN_AS_LIST_CONFIG_ERROR";
public static final String MANAGED_BEAN_AS_MAP_CONFIG_ERROR_ID = "com.sun.faces.MANAGED_BEAN_AS_MAP_CONFIG_ERROR";
public static final String MANAGED_BEAN_MAP_PROPERTY_CONFIG_ERROR_ID = "com.sun.faces.MANAGED_BEAN_MAP_PROPERTY_CONFIG_ERROR";
public static final String MANAGED_BEAN_MAP_PROPERTY_INCORRECT_SETTER_ERROR_ID = "com.sun.faces.MANAGED_BEAN_MAP_PROPERTY_INCORRECT_SETTER_ERROR";
public static final String MANAGED_BEAN_MAP_PROPERTY_INCORRECT_GETTER_ERROR_ID = "com.sun.faces.MANAGED_BEAN_MAP_PROPERTY_INCORRECT_GETTER_ERROR";
public static final String MANAGED_BEAN_DEFINED_PROPERTY_CLASS_NOT_COMPATIBLE_ERROR_ID = "com.sun.faces.MANAGED_BEAN_DEFINED_PROPERTY_CLASS_NOT_COMPATIBLE_ERROR";
public static final String MANAGED_BEAN_INTROSPECTION_ERROR_ID = "com.sun.faces.MANAGED_BEAN_INTROSPECTION_ERROR";
public static final String MANAGED_BEAN_PROPERTY_DOES_NOT_EXIST_ERROR_ID = "com.sun.faces.MANAGED_BEAN_PROPERTY_DOES_NOT_EXIST_ERROR";
public static final String MANAGED_BEAN_PROPERTY_HAS_NO_SETTER_ID = "com.sun.faces.MANAGED_BEAN_PROPERTY_HAS_NO_SETTER_ERROR";
public static final String MANAGED_BEAN_PROPERTY_INCORRECT_ARGS_ERROR_ID = "com.sun.faces.MANAGED_BEAN_PROPERTY_INCORRECT_ARGS_ERROR";
public static final String MANAGED_BEAN_LIST_SETTER_DOES_NOT_ACCEPT_LIST_OR_ARRAY_ERROR_ID = "com.sun.faces.MANAGED_BEAN_LIST_SETTER_DOES_NOT_ACCEPT_LIST_OR_ARRAY_ERROR";
public static final String MANAGED_BEAN_LIST_GETTER_DOES_NOT_RETURN_LIST_OR_ARRAY_ERROR_ID = "com.sun.faces.MANAGED_BEAN_LIST_SETTER_DOES_NOT_RETURN_LIST_OR_ARRAY_ERROR";
public static final String MANAGED_BEAN_LIST_GETTER_ARRAY_NO_SETTER_ERROR_ID = "com.sun.faces.MANAGED_BEAN_LIST_GETTER_ARRAY_NO_SETTER_ERROR";
public static final String MANAGED_BEAN_UNABLE_TO_SET_PROPERTY_ERROR_ID = "com.sun.faces.MANAGED_BEAN_UNABLE_TO_SET_PROPERTY_ERROR";
public static final String MANAGED_BEAN_PROBLEMS_ERROR_ID = "com.sun.faces.MANAGED_BEAN_PROBLEMS_ERROR";
public static final String MANAGED_BEAN_PROBLEMS_STARTUP_ERROR_ID = "com.sun.faces.MANAGED_BEAN_PROBLEMS_STARTUP_ERROR";
public static final String MANAGED_BEAN_UNKNOWN_PROCESSING_ERROR_ID = "com.sun.faces.MANAGED_BEAN_UNKNOWN_PROCESSING_ERROR";
public static final String MANAGED_BEAN_PROPERTY_UNKNOWN_PROCESSING_ERROR_ID = "com.sun.faces.MANAGED_BEAN_PROPERTY_UNKNOWN_PROCESSING_ERROR";
public static final String MANAGED_BEAN_INVALID_SCOPE_ERROR_ID = "com.sun.faces.MANAGED_BEAN_INVALID_SCOPE";
public static final String MAXIMUM_EVENTS_REACHED_ERROR_MESSAGE_ID = "com.sun.faces.MAXIMUM_EVENTS_REACHED";
public static final String MISSING_CLASS_ERROR_MESSAGE_ID = "com.sun.faces.MISSING_CLASS_ERROR";
public static final String MISSING_RESOURCE_ERROR_MESSAGE_ID = "com.sun.faces.MISSING_RESOURCE_ERROR";
public static final String MODEL_UPDATE_ERROR_MESSAGE_ID = "com.sun.faces.MODELUPDATE_ERROR";
public static final String NAMED_OBJECT_NOT_FOUND_ERROR_MESSAGE_ID = "com.sun.faces.NAMED_OBJECT_NOT_FOUND_ERROR";
public static final String NOT_NESTED_IN_FACES_TAG_ERROR_MESSAGE_ID = "com.sun.faces.NOT_NESTED_IN_FACES_TAG_ERROR";
public static final String NOT_NESTED_IN_TYPE_TAG_ERROR_MESSAGE_ID = "com.sun.faces.NOT_NESTED_IN_TYPE_TAG_ERROR";
public static final String NOT_NESTED_IN_UICOMPONENT_TAG_ERROR_MESSAGE_ID = "com.sun.faces.NOT_NESTED_IN_UICOMPONENT_TAG_ERROR";
public static final String NO_DTD_FOUND_ERROR_ID = "com.sun.faces.NO_DTD_FOUND_ERROR";
public static final String NO_COMPONENT_ASSOCIATED_WITH_UICOMPONENT_TAG_MESSAGE_ID = "com.sun.faces.NO_COMPONENT_ASSOCIATED_WITH_UICOMPONENT_TAG";
public static final String NULL_BODY_CONTENT_ERROR_MESSAGE_ID = "com.sun.faces.NULL_BODY_CONTENT_ERROR";
public static final String NULL_COMPONENT_ERROR_MESSAGE_ID = "com.sun.faces.NULL_COMPONENT_ERROR";
public static final String NULL_CONFIGURATION_ERROR_MESSAGE_ID = "com.sun.faces.NULL_CONFIGURATION";
public static final String NULL_CONTEXT_ERROR_MESSAGE_ID = "com.sun.faces.NULL_CONTEXT_ERROR";
public static final String NULL_EVENT_ERROR_MESSAGE_ID = "com.sun.faces.NULL_EVENT_ERROR";
public static final String NULL_FORVALUE_ID = "com.sun.faces.NULL_FORVALUE";
public static final String NULL_HANDLER_ERROR_MESSAGE_ID = "com.sun.faces.NULL_HANDLER_ERROR";
public static final String NULL_LOCALE_ERROR_MESSAGE_ID = "com.sun.faces.NULL_LOCALE_ERROR";
public static final String NULL_MESSAGE_ERROR_MESSAGE_ID = "com.sun.faces.NULL_MESSAGE_ERROR";
public static final String NULL_PARAMETERS_ERROR_MESSAGE_ID = "com.sun.faces.NULL_PARAMETERS_ERROR";
public static final String NULL_REQUEST_VIEW_ERROR_MESSAGE_ID = "com.sun.faces.NULL_REQUEST_VIEW_ERROR";
public static final String NULL_RESPONSE_STREAM_ERROR_MESSAGE_ID = "com.sun.faces.NULL_RESPONSE_STREAM_ERROR";
public static final String NULL_RESPONSE_VIEW_ERROR_MESSAGE_ID = "com.sun.faces.NULL_RESPONSE_VIEW_ERROR";
public static final String NULL_RESPONSE_WRITER_ERROR_MESSAGE_ID = "com.sun.faces.NULL_RESPONSE_WRITER_ERROR";
public static final String NULL_VIEW_ID_ERROR_MESSAGE_ID = "com.sun.faces.NULL_VIEW_ID";
public static final String OBJECT_CREATION_ERROR_ID = "com.sun.faces.OBJECT_CREATION_ERROR";
public static final String OBJECT_IS_READONLY = "com.sun.faces.OBJECT_IS_READONLY";
public static final String PHASE_ID_OUT_OF_BOUNDS_ERROR_MESSAGE_ID = "com.sun.faces.PHASE_ID_OUT_OF_BOUNDS";
public static final String RENDERER_NOT_FOUND_ERROR_MESSAGE_ID = "com.sun.faces.RENDERER_NOT_FOUND";
public static final String REQUEST_VIEW_ALREADY_SET_ERROR_MESSAGE_ID = "com.sun.faces.REQUEST_VIEW_ALREADY_SET_ERROR";
public static final String RESTORE_VIEW_ERROR_MESSAGE_ID = "com.sun.faces.RESTORE_VIEW_ERROR";
public static final String SAVING_STATE_ERROR_MESSAGE_ID = "com.sun.faces.SAVING_STATE_ERROR";
public static final String SUPPORTS_COMPONENT_ERROR_MESSAGE_ID = "com.sun.faces.SUPPORTS_COMPONENT_ERROR";
public static final String VALIDATION_COMMAND_ERROR_ID = "com.sun.faces.VALIDATION_COMMAND_ERROR";
public static final String VALIDATION_EL_ERROR_ID = "com.sun.faces.VALIDATION_EL_ERROR";
public static final String VALIDATION_ID_ERROR_ID = "com.sun.faces.VALIDATION_ID_ERROR";
public static final String VALUE_NOT_SELECT_ITEM_ID = "com.sun.faces.OPTION_NOT_SELECT_ITEM";
public static final String CANNOT_CONVERT_ID = "com.sun.faces.CANNOT_CONVERT";
public static final String CANNOT_VALIDATE_ID = "com.sun.faces.CANNOT_VALIDATE";
public static final String VERIFIER_CLASS_NOT_FOUND_ID = "com.sun.faces.verifier.CLASS_NOT_FOUND";
public static final String VERIFIER_CLASS_MISSING_DEP_ID = "com.sun.faces.verifier.CLASS_MISSING_DEP";
public static final String VERIFIER_CTOR_NOT_PUBLIC_ID = "com.sun.faces.verifier.NON_PUBLIC_DEF_CTOR";
public static final String VERIFIER_NO_DEF_CTOR_ID = "com.sun.faces.verifier.NO_DEF_CTOR";
public static final String VERIFIER_WRONG_TYPE_ID = "com.sun.faces.verifier.WRONG_TYPE";
public static final String RENDERER_CANNOT_BE_REGISTERED_ID = "com.sun.faces.CONFIG_RENDERER_REGISTRATION_MISSING_RENDERKIT";
public static final String COMMAND_NOT_NESTED_WITHIN_FORM_ID = "com.sun.faces.COMMAND_NOT_NESTED_WITHIN_FORM";
public static final String NAVIGATION_NO_MATCHING_OUTCOME_ID = "com.sun.faces.NAVIGATION_NO_MATCHING_OUTCOME";
public static final String NAVIGATION_NO_MATCHING_OUTCOME_ACTION_ID = "com.sun.faces.NAVIGATION_NO_MATCHING_OUTCOME_ACTION";
public static final String NAVIGATION_INVALID_QUERY_STRING_ID = "com.sun.faces.NAVIGATION_INVALID_QUERY_STRING";
public static final String OUTCOME_TARGET_BUTTON_NO_MATCH = "com.sun.faces.OUTCOME_TARGET_BUTTON_NO_MATCH";
public static final String OUTCOME_TARGET_LINK_NO_MATCH = "com.sun.faces.OUTCOME_TARGET_LINK_NO_MATCH";
public static final String NO_RESOURCE_TARGET_AVAILABLE = "com.sun.faces.RESOURCE_TARGET_NOT_AVAILABLE";
public static final String INVALID_RESOURCE_FORMAT_COLON_ERROR = "com.sun.faces.RESOURCE_INVALID_FORMAT_COLON_ERROR";
public static final String INVALID_RESOURCE_FORMAT_NO_LIBRARY_NAME_ERROR = "com.sun.faces.RESOURCE_INVALID_FORMAT_NO_LIBRARY_NAME_ERROR";
public static final String INVALID_RESOURCE_FORMAT_ERROR = "com.sun.faces.RESOURCE_INVALID_FORMAT_ERROR";
public static final String ARGUMENTS_NOT_LEGAL_CC_ATTRS_EXPR = "com.sun.faces.ARGUMENTS_NOT_LEGAL_WITH_CC_ATTRS_EXPR";
public static final String PARTIAL_STATE_ERROR_RESTORING_ID = "com.sun.faces.partial.statesaving.ERROR_RESTORING_STATE_FOR_COMPONENT";
public static final String JS_RESOURCE_WRITING_ERROR_ID = "com.sun.faces.JS_RESOURCE_WRITING_ERROR";
public static final String MISSING_COMPONENT_ATTRIBUTE_VALUE = "com.sun.faces.MISSING_COMPONENT_ATTRIBUTE_VALUE";
public static final String MISSING_COMPONENT_FACET = "com.sun.faces.MISSING_COMPONENT_FACET";
public static final String MISSING_COMPONENT_METADATA = "com.sun.faces.MISSING_COMPONENT_METADATA";
public static final String MISSING_FORM_ERROR = "com.sun.faces.MISSING_FORM_ERROR";
public static final String MISSING_METADATA_ERROR = "com.sun.faces.MISSING_METADATA_ERROR";
// ------------------------------------------------------------ Constructors
private MessageUtils() {
}
// ---------------------------------------------------------- Public Methods
/**
*
* Creates a new FacesMessage instance using the specified #messageId.
*
*
* @param messageId the message ID
* @param params an array of substitution parameters
* @return a new FacesMessage based on the provided messageId
*/
public static FacesMessage getExceptionMessage(String messageId, Object... params) {
return MessageFactory.getMessage(messageId, params);
}
/**
*
* Returns the localized message for the specified #messageId.
*
*
* @param messageId the message ID
* @param params an array of substitution parameters
* @return the localized message for the specified messageId
*/
public static String getExceptionMessageString(String messageId, Object... params) {
String result = null;
FacesMessage message = MessageFactory.getMessage(messageId, params);
if (null != message) {
result = message.getSummary();
}
if (null == result) {
result = "null MessageFactory";
} else {
if (params != null) {
result = MessageFormat.format(result, params);
}
}
return result;
}
} // END MessageUtils