default message factory
This commit is contained in:
parent
4ed3924e6f
commit
da7e596b2a
|
|
@ -20,25 +20,26 @@ import org.springframework.core.style.StylerUtils;
|
||||||
import org.springframework.model.alert.Alert;
|
import org.springframework.model.alert.Alert;
|
||||||
import org.springframework.model.alert.Severity;
|
import org.springframework.model.alert.Severity;
|
||||||
import org.springframework.model.binder.BindingResult;
|
import org.springframework.model.binder.BindingResult;
|
||||||
|
import org.springframework.model.message.DefaultMessageFactory;
|
||||||
import org.springframework.model.message.MessageBuilder;
|
import org.springframework.model.message.MessageBuilder;
|
||||||
import org.springframework.model.message.ResolvableArgument;
|
import org.springframework.model.message.ResolvableArgument;
|
||||||
|
|
||||||
public class FieldNotEditableResult implements BindingResult {
|
public class FieldNotEditableResult implements BindingResult {
|
||||||
|
|
||||||
private String property;
|
private String fieldName;
|
||||||
|
|
||||||
private Object submittedValue;
|
private Object submittedValue;
|
||||||
|
|
||||||
private MessageSource messageSource;
|
private MessageSource messageSource;
|
||||||
|
|
||||||
public FieldNotEditableResult(String property, Object submittedValue, MessageSource messageSource) {
|
public FieldNotEditableResult(String fieldName, Object submittedValue, MessageSource messageSource) {
|
||||||
this.property = property;
|
this.fieldName = fieldName;
|
||||||
this.submittedValue = submittedValue;
|
this.submittedValue = submittedValue;
|
||||||
this.messageSource = messageSource;
|
this.messageSource = messageSource;
|
||||||
}
|
}
|
||||||
|
|
||||||
public String getFieldName() {
|
public String getFieldName() {
|
||||||
return property;
|
return fieldName;
|
||||||
}
|
}
|
||||||
|
|
||||||
public Object getSubmittedValue() {
|
public Object getSubmittedValue() {
|
||||||
|
|
@ -62,11 +63,13 @@ public class FieldNotEditableResult implements BindingResult {
|
||||||
public String getMessage() {
|
public String getMessage() {
|
||||||
MessageBuilder builder = new MessageBuilder(messageSource);
|
MessageBuilder builder = new MessageBuilder(messageSource);
|
||||||
builder.code("bindSuccess");
|
builder.code("bindSuccess");
|
||||||
builder.arg("label", new ResolvableArgument(property));
|
builder.arg("label", new ResolvableArgument(fieldName));
|
||||||
builder.arg("value", submittedValue);
|
builder.arg("value", submittedValue);
|
||||||
// TODO lazily create default message
|
builder.defaultMessage(new DefaultMessageFactory() {
|
||||||
builder.defaultMessage("Successfully bound user value " + StylerUtils.style(submittedValue)
|
public String createDefaultMessage() {
|
||||||
+ " to property '" + property + "'");
|
return "Failed to bind submitted value " + StylerUtils.style(submittedValue) + "; field '" + fieldName + "' is not editable";
|
||||||
|
}
|
||||||
|
});
|
||||||
return builder.build();
|
return builder.build();
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
||||||
|
|
@ -20,25 +20,26 @@ import org.springframework.core.style.StylerUtils;
|
||||||
import org.springframework.model.alert.Alert;
|
import org.springframework.model.alert.Alert;
|
||||||
import org.springframework.model.alert.Severity;
|
import org.springframework.model.alert.Severity;
|
||||||
import org.springframework.model.binder.BindingResult;
|
import org.springframework.model.binder.BindingResult;
|
||||||
|
import org.springframework.model.message.DefaultMessageFactory;
|
||||||
import org.springframework.model.message.MessageBuilder;
|
import org.springframework.model.message.MessageBuilder;
|
||||||
import org.springframework.model.message.ResolvableArgument;
|
import org.springframework.model.message.ResolvableArgument;
|
||||||
|
|
||||||
public class FieldNotFoundResult implements BindingResult {
|
public class FieldNotFoundResult implements BindingResult {
|
||||||
|
|
||||||
private String property;
|
private String fieldName;
|
||||||
|
|
||||||
private Object submittedValue;
|
private Object submittedValue;
|
||||||
|
|
||||||
private MessageSource messageSource;
|
private MessageSource messageSource;
|
||||||
|
|
||||||
public FieldNotFoundResult(String property, Object submittedValue, MessageSource messageSource) {
|
public FieldNotFoundResult(String fieldName, Object submittedValue, MessageSource messageSource) {
|
||||||
this.property = property;
|
this.fieldName = fieldName;
|
||||||
this.submittedValue = submittedValue;
|
this.submittedValue = submittedValue;
|
||||||
this.messageSource = messageSource;
|
this.messageSource = messageSource;
|
||||||
}
|
}
|
||||||
|
|
||||||
public String getFieldName() {
|
public String getFieldName() {
|
||||||
return property;
|
return fieldName;
|
||||||
}
|
}
|
||||||
|
|
||||||
public Object getSubmittedValue() {
|
public Object getSubmittedValue() {
|
||||||
|
|
@ -62,11 +63,13 @@ public class FieldNotFoundResult implements BindingResult {
|
||||||
public String getMessage() {
|
public String getMessage() {
|
||||||
MessageBuilder builder = new MessageBuilder(messageSource);
|
MessageBuilder builder = new MessageBuilder(messageSource);
|
||||||
builder.code("bindSuccess");
|
builder.code("bindSuccess");
|
||||||
builder.arg("label", new ResolvableArgument(property));
|
builder.arg("label", new ResolvableArgument(fieldName));
|
||||||
builder.arg("value", submittedValue);
|
builder.arg("value", submittedValue);
|
||||||
// TODO lazily create default message
|
builder.defaultMessage(new DefaultMessageFactory() {
|
||||||
builder.defaultMessage("Successfully bound user value " + StylerUtils.style(submittedValue)
|
public String createDefaultMessage() {
|
||||||
+ " to property '" + property + "'");
|
return "Failed to bind submitted value " + StylerUtils.style(submittedValue) + "; no field '" + fieldName + "' found";
|
||||||
|
}
|
||||||
|
});
|
||||||
return builder.build();
|
return builder.build();
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
package org.springframework.model.message;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A factory for a default message to return if no message could be resolved.
|
||||||
|
* Allows the message String to be created lazily, only when it is needed.
|
||||||
|
* @author Keith Donald
|
||||||
|
* @since 3.0
|
||||||
|
* @see MessageBuilder
|
||||||
|
*/
|
||||||
|
public interface DefaultMessageFactory {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create the default message.
|
||||||
|
*/
|
||||||
|
String createDefaultMessage();
|
||||||
|
}
|
||||||
|
|
@ -39,15 +39,15 @@ final class DefaultMessageResolver implements MessageResolver, MessageSourceReso
|
||||||
|
|
||||||
private Map<String, Object> args;
|
private Map<String, Object> args;
|
||||||
|
|
||||||
private String defaultMessage;
|
private DefaultMessageFactory defaultMessageFactory;
|
||||||
|
|
||||||
private ExpressionParser expressionParser;
|
private ExpressionParser expressionParser;
|
||||||
|
|
||||||
public DefaultMessageResolver(String[] codes, Map<String, Object> args, String defaultText,
|
public DefaultMessageResolver(String[] codes, Map<String, Object> args,
|
||||||
ExpressionParser expressionParser) {
|
DefaultMessageFactory defaultMessageFactory, ExpressionParser expressionParser) {
|
||||||
this.codes = codes;
|
this.codes = codes;
|
||||||
this.args = args;
|
this.args = args;
|
||||||
this.defaultMessage = defaultText;
|
this.defaultMessageFactory = defaultMessageFactory;
|
||||||
this.expressionParser = expressionParser;
|
this.expressionParser = expressionParser;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -55,10 +55,11 @@ final class DefaultMessageResolver implements MessageResolver, MessageSourceReso
|
||||||
|
|
||||||
public String resolveMessage(MessageSource messageSource, Locale locale) {
|
public String resolveMessage(MessageSource messageSource, Locale locale) {
|
||||||
if (messageSource == null) {
|
if (messageSource == null) {
|
||||||
if (defaultMessage != null) {
|
if (defaultMessageFactory != null) {
|
||||||
return defaultMessage;
|
return defaultMessageFactory.createDefaultMessage();
|
||||||
} else {
|
} else {
|
||||||
throw new MessageResolutionException("Unable to resolve message; MessagSource argument is null and no defaultMessage is configured");
|
throw new MessageResolutionException(
|
||||||
|
"Unable to resolve message; MessagSource argument is null and no defaultMessage is configured");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
String messageString;
|
String messageString;
|
||||||
|
|
@ -95,11 +96,12 @@ final class DefaultMessageResolver implements MessageResolver, MessageSourceReso
|
||||||
}
|
}
|
||||||
|
|
||||||
public String getDefaultMessage() {
|
public String getDefaultMessage() {
|
||||||
return defaultMessage;
|
return defaultMessageFactory.createDefaultMessage();
|
||||||
}
|
}
|
||||||
|
|
||||||
public String toString() {
|
public String toString() {
|
||||||
return new ToStringCreator(this).append("codes", codes).append("defaultText", defaultMessage).toString();
|
return new ToStringCreator(this).append("codes", codes).append("args", args).append("defaultMessageFactory",
|
||||||
|
defaultMessageFactory).toString();
|
||||||
}
|
}
|
||||||
|
|
||||||
@SuppressWarnings("unchecked")
|
@SuppressWarnings("unchecked")
|
||||||
|
|
|
||||||
|
|
@ -102,6 +102,18 @@ public class MessageBuilder {
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the default message.
|
||||||
|
* If there are no codes to try, this will be used as the message.
|
||||||
|
* If there are codes to try but none of those resolve to a message, this will be used as the message.
|
||||||
|
* @param message the default text
|
||||||
|
* @return this, for fluent API usage
|
||||||
|
*/
|
||||||
|
public MessageBuilder defaultMessage(DefaultMessageFactory defaultMessageFactory) {
|
||||||
|
builder.defaultMessage(defaultMessageFactory);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set the message locale.
|
* Set the message locale.
|
||||||
* If not set, the default locale the Locale of the current request obtained from {@link LocaleContextHolder#getLocale()}.
|
* If not set, the default locale the Locale of the current request obtained from {@link LocaleContextHolder#getLocale()}.
|
||||||
|
|
|
||||||
|
|
@ -56,7 +56,7 @@ public class MessageResolverBuilder {
|
||||||
|
|
||||||
private Map<String, Object> args = new LinkedHashMap<String, Object>();
|
private Map<String, Object> args = new LinkedHashMap<String, Object>();
|
||||||
|
|
||||||
private String defaultMessage;
|
private DefaultMessageFactory defaultMessageFactory;
|
||||||
|
|
||||||
private ExpressionParser expressionParser = new SpelExpressionParser();
|
private ExpressionParser expressionParser = new SpelExpressionParser();
|
||||||
|
|
||||||
|
|
@ -97,10 +97,22 @@ public class MessageResolverBuilder {
|
||||||
* @return this, for fluent API usage
|
* @return this, for fluent API usage
|
||||||
*/
|
*/
|
||||||
public MessageResolverBuilder defaultMessage(String message) {
|
public MessageResolverBuilder defaultMessage(String message) {
|
||||||
defaultMessage = message;
|
return defaultMessage(new StaticDefaultMessageFactory(message));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the default message.
|
||||||
|
* If the MessageResolver has no codes to try, this will be used as the message.
|
||||||
|
* If the MessageResolver has codes to try but none of those resolve to a message, this will be used as the message.
|
||||||
|
* @param message the default text
|
||||||
|
* @return this, for fluent API usage
|
||||||
|
*/
|
||||||
|
public MessageResolverBuilder defaultMessage(DefaultMessageFactory defaultMessageFactory) {
|
||||||
|
this.defaultMessageFactory = defaultMessageFactory;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Builds the resolver for the message.
|
* Builds the resolver for the message.
|
||||||
* Call after recording all builder instructions.
|
* Call after recording all builder instructions.
|
||||||
|
|
@ -108,12 +120,12 @@ public class MessageResolverBuilder {
|
||||||
* @throws IllegalStateException if no codes have been added and there is no default message
|
* @throws IllegalStateException if no codes have been added and there is no default message
|
||||||
*/
|
*/
|
||||||
public MessageResolver build() {
|
public MessageResolver build() {
|
||||||
if (codes == null && defaultMessage == null) {
|
if (codes == null && defaultMessageFactory == null) {
|
||||||
throw new IllegalStateException(
|
throw new IllegalStateException(
|
||||||
"A message code or the message text is required to build this message resolver");
|
"A message code or the message text is required to build this message resolver");
|
||||||
}
|
}
|
||||||
String[] codesArray = (String[]) codes.toArray(new String[codes.size()]);
|
String[] codesArray = (String[]) codes.toArray(new String[codes.size()]);
|
||||||
return new DefaultMessageResolver(codesArray, args, defaultMessage, expressionParser);
|
return new DefaultMessageResolver(codesArray, args, defaultMessageFactory, expressionParser);
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2004-2009 the original author or authors.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
package org.springframework.model.message;
|
||||||
|
|
||||||
|
class StaticDefaultMessageFactory implements DefaultMessageFactory {
|
||||||
|
|
||||||
|
private String defaultMessage;
|
||||||
|
|
||||||
|
public StaticDefaultMessageFactory(String defaultMessage) {
|
||||||
|
this.defaultMessage = defaultMessage;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String createDefaultMessage() {
|
||||||
|
return defaultMessage;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -34,6 +34,7 @@ import org.springframework.core.convert.TypeDescriptor;
|
||||||
import org.springframework.core.style.StylerUtils;
|
import org.springframework.core.style.StylerUtils;
|
||||||
import org.springframework.model.alert.Alert;
|
import org.springframework.model.alert.Alert;
|
||||||
import org.springframework.model.alert.Severity;
|
import org.springframework.model.alert.Severity;
|
||||||
|
import org.springframework.model.message.DefaultMessageFactory;
|
||||||
import org.springframework.model.message.MessageBuilder;
|
import org.springframework.model.message.MessageBuilder;
|
||||||
import org.springframework.model.message.ResolvableArgument;
|
import org.springframework.model.message.ResolvableArgument;
|
||||||
import org.springframework.model.ui.BindingStatus;
|
import org.springframework.model.ui.BindingStatus;
|
||||||
|
|
@ -210,16 +211,24 @@ public class DefaultFieldModel implements FieldModel {
|
||||||
builder.arg("label", context.getLabel());
|
builder.arg("label", context.getLabel());
|
||||||
builder.arg("value", submittedValue);
|
builder.arg("value", submittedValue);
|
||||||
builder.arg("errorOffset", e.getErrorOffset());
|
builder.arg("errorOffset", e.getErrorOffset());
|
||||||
builder.defaultMessage("Failed to bind '" + context.getLabel() + "'; the submitted value "
|
builder.defaultMessage(new DefaultMessageFactory() {
|
||||||
+ StylerUtils.style(submittedValue) + " has an invalid format and could no be parsed");
|
public String createDefaultMessage() {
|
||||||
|
return "Failed to bind '" + context.getLabel() + "'; the submitted value "
|
||||||
|
+ StylerUtils.style(submittedValue)
|
||||||
|
+ " has an invalid format and could no be parsed";
|
||||||
|
}
|
||||||
|
});
|
||||||
} else {
|
} else {
|
||||||
ConversionFailedException e = (ConversionFailedException) invalidSubmittedValueCause;
|
final ConversionFailedException e = (ConversionFailedException) invalidSubmittedValueCause;
|
||||||
builder.arg("label", new ResolvableArgument(context.getLabel()));
|
builder.arg("label", new ResolvableArgument(context.getLabel()));
|
||||||
builder.arg("value", submittedValue);
|
builder.arg("value", submittedValue);
|
||||||
builder.defaultMessage("Failed to bind '" + context.getLabel() + "'; the submitted value "
|
builder.defaultMessage(new DefaultMessageFactory() {
|
||||||
+ StylerUtils.style(submittedValue) + " has could not be converted to "
|
public String createDefaultMessage() {
|
||||||
+ e.getTargetType().getName());
|
return "Failed to bind '" + context.getLabel() + "'; the submitted value "
|
||||||
|
+ StylerUtils.style(submittedValue) + " has could not be converted to "
|
||||||
|
+ e.getTargetType().getName();
|
||||||
|
}
|
||||||
|
});
|
||||||
}
|
}
|
||||||
return builder.build();
|
return builder.build();
|
||||||
}
|
}
|
||||||
|
|
@ -235,7 +244,6 @@ public class DefaultFieldModel implements FieldModel {
|
||||||
}
|
}
|
||||||
|
|
||||||
public String getMessage() {
|
public String getMessage() {
|
||||||
buffer.getFlushException().printStackTrace();
|
|
||||||
return "Internal error occurred; message = [" + buffer.getFlushException().getMessage() + "]";
|
return "Internal error occurred; message = [" + buffer.getFlushException().getMessage() + "]";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -250,6 +258,16 @@ public class DefaultFieldModel implements FieldModel {
|
||||||
}
|
}
|
||||||
|
|
||||||
public String getMessage() {
|
public String getMessage() {
|
||||||
|
MessageBuilder builder = new MessageBuilder(context.getMessageSource());
|
||||||
|
builder.code("bindSuccess");
|
||||||
|
builder.arg("label", context.getLabel());
|
||||||
|
builder.arg("value", submittedValue);
|
||||||
|
builder.defaultMessage(new DefaultMessageFactory() {
|
||||||
|
public String createDefaultMessage() {
|
||||||
|
return "Successfully bound submitted value " + StylerUtils.style(submittedValue)
|
||||||
|
+ " to field '" + context.getLabel() + "'";
|
||||||
|
}
|
||||||
|
});
|
||||||
return "Binding successful";
|
return "Binding successful";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue