You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@struts.apache.org by lu...@apache.org on 2013/03/17 14:25:42 UTC
svn commit: r1457442 - in /struts/struts2/trunk/xwork-core/src:
main/java/com/opensymphony/xwork2/validator/
main/java/com/opensymphony/xwork2/validator/annotations/
test/java/com/opensymphony/xwork2/validator/
Author: lukaszlenart
Date: Sun Mar 17 13:25:41 2013
New Revision: 1457442
URL: http://svn.apache.org/r1457442
Log:
WW-4002 Improves CustomValidator annotation
Added:
struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/MyValidator.java
Modified:
struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilder.java
struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/annotations/CustomValidator.java
struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationAction.java
struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilderTest.java
struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationExpAction.java
Modified: struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilder.java
URL: http://svn.apache.org/viewvc/struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilder.java?rev=1457442&r1=1457441&r2=1457442&view=diff
==============================================================================
--- struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilder.java (original)
+++ struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilder.java Sun Mar 17 13:25:41 2013
@@ -423,6 +423,7 @@ public class AnnotationValidationConfigu
.shortCircuit(v.shortCircuit())
.defaultMessage(v.message())
.messageKey(v.key())
+ .messageParams(v.messageParams())
.build();
}
Modified: struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/annotations/CustomValidator.java
URL: http://svn.apache.org/viewvc/struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/annotations/CustomValidator.java?rev=1457442&r1=1457441&r2=1457442&view=diff
==============================================================================
--- struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/annotations/CustomValidator.java (original)
+++ struts/struts2/trunk/xwork-core/src/main/java/com/opensymphony/xwork2/validator/annotations/CustomValidator.java Sun Mar 17 13:25:41 2013
@@ -55,6 +55,12 @@ import java.lang.annotation.Target;
* <td class='confluenceTd'>i18n key from language specific properties file.</td>
* </tr>
* <tr>
+ * <td class='confluenceTd'>messageParams</td>
+ * <td class='confluenceTd'>no</td>
+ * <td class='confluenceTd'> </td>
+ * <td class='confluenceTd'>Additional params to be used to customize message - will be evaluated against the Value Stack</td>
+ * </tr>
+ * <tr>
* <td class='confluenceTd'>fieldName</td>
* <td class='confluenceTd'>no</td>
* <td class='confluenceTd'> </td>
@@ -69,8 +75,8 @@ import java.lang.annotation.Target;
* <tr>
* <td class='confluenceTd'>type</td>
* <td class='confluenceTd'>yes</td>
- * <td class='confluenceTd'>ValidatorType.FIELD</td>
- * <td class='confluenceTd'>Enum value from ValidatorType. Either FIELD or SIMPLE can be used here.</td>
+ * <td class='confluenceTd'>name of validator</td>
+ * <td class='confluenceTd'>Simple string which identifies that validator among other</td>
* </tr>
* </table>
* <!-- END SNIPPET: parameters -->
@@ -106,6 +112,11 @@ public @interface CustomValidator {
String key() default "";
+ /**
+ * Additional params to be used to customize message - will be evaluated against the Value Stack
+ */
+ String[] messageParams() default {};
+
public ValidationParameter[] parameters() default {};
boolean shortCircuit() default false;
Modified: struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationAction.java
URL: http://svn.apache.org/viewvc/struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationAction.java?rev=1457442&r1=1457441&r2=1457442&view=diff
==============================================================================
--- struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationAction.java (original)
+++ struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationAction.java Sun Mar 17 13:25:41 2013
@@ -3,7 +3,9 @@ package com.opensymphony.xwork2.validato
import com.opensymphony.xwork2.ActionSupport;
import com.opensymphony.xwork2.validator.annotations.ConditionalVisitorFieldValidator;
import com.opensymphony.xwork2.validator.annotations.ConversionErrorFieldValidator;
+import com.opensymphony.xwork2.validator.annotations.CustomValidator;
import com.opensymphony.xwork2.validator.annotations.RegexFieldValidator;
+import com.opensymphony.xwork2.validator.annotations.ValidationParameter;
/**
* Sets up all available validation annotations
@@ -18,6 +20,12 @@ public class AnnotationValidationAction
messageParams = {"one", "two", "three"})
@ConversionErrorFieldValidator(fieldName = "bar", key = "conversion.key", message = "Foo conversion error!",
shortCircuit = true, repopulateField = true, messageParams = {"one", "three"})
+ @CustomValidator(type = "myValidator", fieldName = "foo", key = "foo.invalid", message = "Foo is invalid!",
+ shortCircuit = true, messageParams = {"one", "two", "three"},
+ parameters = {
+ @ValidationParameter(name = "value", value = "1")
+ }
+ )
public String execute() {
return SUCCESS;
}
Modified: struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilderTest.java
URL: http://svn.apache.org/viewvc/struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilderTest.java?rev=1457442&r1=1457441&r2=1457442&view=diff
==============================================================================
--- struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilderTest.java (original)
+++ struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationConfigurationBuilderTest.java Sun Mar 17 13:25:41 2013
@@ -36,7 +36,7 @@ public class AnnotationValidationConfigu
List<Validator> validators = manager.getValidators(AnnotationValidationAction.class, null);
// then
- assertEquals(validators.size(), 3);
+ assertEquals(validators.size(), 4);
for (Validator validator : validators) {
validate(validator);
}
@@ -53,7 +53,7 @@ public class AnnotationValidationConfigu
ValueStack valueStack = container.getInstance(ValueStackFactory.class).createValueStack();
valueStack.push(new AnnotationValidationExpAction());
- assertEquals(validators.size(), 3);
+ assertEquals(validators.size(), 4);
for (Validator validator : validators) {
validator.setValueStack(valueStack);
validate(validator);
@@ -67,9 +67,20 @@ public class AnnotationValidationConfigu
validateConditionalFieldVisitorValidator((ConditionalVisitorFieldValidator) validator);
} else if (validator.getValidatorType().equals("conversion")) {
validateConversionFieldErrorVisitorValidator((ConversionErrorFieldValidator) validator);
+ } else if (validator.getValidatorType().equals("myValidator")) {
+ validateMyValidator((MyValidator) validator);
}
}
+ private void validateMyValidator(MyValidator validator) {
+ assertEquals("Foo is invalid!", validator.getDefaultMessage());
+ assertEquals("foo", validator.getFieldName());
+ assertEquals("foo.invalid", validator.getMessageKey());
+ assertTrue(Arrays.equals(new String[]{"one", "two", "three"}, validator.getMessageParameters()));
+ assertEquals(true, validator.isShortCircuit());
+ assertEquals(1, validator.getValue());
+ }
+
private void validateConversionFieldErrorVisitorValidator(ConversionErrorFieldValidator validator) {
assertEquals("bar", validator.getFieldName());
assertEquals("conversion.key", validator.getMessageKey());
@@ -134,6 +145,9 @@ public class AnnotationValidationConfigu
AnnotationActionValidatorManager manager = new AnnotationActionValidatorManager();
container.inject(manager);
+ ValidatorFactory vf = container.getInstance(ValidatorFactory.class);
+ vf.registerValidator("myValidator", MyValidator.class.getName());
+
return manager;
}
Modified: struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationExpAction.java
URL: http://svn.apache.org/viewvc/struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationExpAction.java?rev=1457442&r1=1457441&r2=1457442&view=diff
==============================================================================
--- struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationExpAction.java (original)
+++ struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/AnnotationValidationExpAction.java Sun Mar 17 13:25:41 2013
@@ -3,7 +3,9 @@ package com.opensymphony.xwork2.validato
import com.opensymphony.xwork2.ActionSupport;
import com.opensymphony.xwork2.validator.annotations.ConditionalVisitorFieldValidator;
import com.opensymphony.xwork2.validator.annotations.ConversionErrorFieldValidator;
+import com.opensymphony.xwork2.validator.annotations.CustomValidator;
import com.opensymphony.xwork2.validator.annotations.RegexFieldValidator;
+import com.opensymphony.xwork2.validator.annotations.ValidationParameter;
/**
* Sets up all available validation annotations with params as expressions
@@ -18,6 +20,12 @@ public class AnnotationValidationExpActi
messageParams = {"one", "two", "three"})
@ConversionErrorFieldValidator(fieldName = "bar", key = "conversion.key", message = "Foo conversion error!",
shortCircuit = true, repopulateField = true, messageParams = {"one", "three"})
+ @CustomValidator(type = "myValidator", fieldName = "foo", key = "foo.invalid", message = "Foo is invalid!",
+ shortCircuit = true, messageParams = {"one", "two", "three"},
+ parameters = {
+ @ValidationParameter(name = "value", value = "1")
+ }
+ )
public String execute() {
return SUCCESS;
}
Added: struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/MyValidator.java
URL: http://svn.apache.org/viewvc/struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/MyValidator.java?rev=1457442&view=auto
==============================================================================
--- struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/MyValidator.java (added)
+++ struts/struts2/trunk/xwork-core/src/test/java/com/opensymphony/xwork2/validator/MyValidator.java Sun Mar 17 13:25:41 2013
@@ -0,0 +1,96 @@
+package com.opensymphony.xwork2.validator;
+
+import com.opensymphony.xwork2.util.ValueStack;
+
+/**
+ * TODO lukaszlenart: write a JavaDoc
+ */
+public class MyValidator implements FieldValidator, ShortCircuitableValidator {
+
+ private String message;
+ private String fieldName;
+ private String key;
+ private String[] messageParameters;
+ private ValidatorContext validatorContext;
+ private String type;
+ private ValueStack stack;
+ private boolean shortcircuit;
+
+ private int value;
+
+ public int getValue() {
+ return value;
+ }
+
+ public void setValue(int value) {
+ this.value = value;
+ }
+
+ public void setFieldName(String fieldName) {
+ this.fieldName = fieldName;
+ }
+
+ public String getFieldName() {
+ return fieldName;
+ }
+
+ public void setDefaultMessage(String message) {
+ this.message = message;
+ }
+
+ public String getDefaultMessage() {
+ return message;
+ }
+
+ public String getMessage(Object object) {
+ return "Message";
+ }
+
+ public void setMessageKey(String key) {
+ this.key = key;
+ }
+
+ public String getMessageKey() {
+ return key;
+ }
+
+ public void setMessageParameters(String[] messageParameters) {
+ this.messageParameters = messageParameters;
+ }
+
+ public String[] getMessageParameters() {
+ return messageParameters;
+ }
+
+ public void setValidatorContext(ValidatorContext validatorContext) {
+ this.validatorContext = validatorContext;
+ }
+
+ public ValidatorContext getValidatorContext() {
+ return validatorContext;
+ }
+
+ public void validate(Object object) throws ValidationException {
+ // pass
+ }
+
+ public void setValidatorType(String type) {
+ this.type = type;
+ }
+
+ public String getValidatorType() {
+ return type;
+ }
+
+ public void setValueStack(ValueStack stack) {
+ this.stack = stack;
+ }
+
+ public void setShortCircuit(boolean shortcircuit) {
+ this.shortcircuit = shortcircuit;
+ }
+
+ public boolean isShortCircuit() {
+ return shortcircuit;
+ }
+}