001 /******************************************************************************* 002 * Portions created by Sebastian Thomschke are copyright (c) 2005-2011 Sebastian 003 * Thomschke. 004 * 005 * All Rights Reserved. This program and the accompanying materials 006 * are made available under the terms of the Eclipse Public License v1.0 007 * which accompanies this distribution, and is available at 008 * http://www.eclipse.org/legal/epl-v10.html 009 * 010 * Contributors: 011 * Sebastian Thomschke - initial implementation. 012 *******************************************************************************/ 013 package net.sf.oval.constraint; 014 015 import java.lang.annotation.Documented; 016 import java.lang.annotation.ElementType; 017 import java.lang.annotation.Retention; 018 import java.lang.annotation.RetentionPolicy; 019 import java.lang.annotation.Target; 020 021 import net.sf.oval.ConstraintTarget; 022 import net.sf.oval.ConstraintViolation; 023 import net.sf.oval.configuration.annotation.Constraint; 024 import net.sf.oval.configuration.annotation.Constraints; 025 import net.sf.oval.constraint.AssertURLCheck.URIScheme; 026 027 /** 028 * Check if the value is a valid URL. 029 * 030 * <br><br> 031 * <b>Note:</b> This constraint is also satisfied when the value to validate is null, therefore you might also need to specified @NotNull 032 * 033 * @author Sebastian Thomschke 034 */ 035 @Documented 036 @Retention(RetentionPolicy.RUNTIME) 037 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD}) 038 @Constraint(checkWith = AssertURLCheck.class) 039 public @interface AssertURL 040 { 041 @Documented 042 @Retention(RetentionPolicy.RUNTIME) 043 @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD}) 044 @Constraints 045 public @interface List 046 { 047 /** 048 * The AssertURL constraints. 049 */ 050 AssertURL[] value(); 051 052 /** 053 * Formula returning <code>true</code> if this constraint shall be evaluated and 054 * <code>false</code> if it shall be ignored for the current validation. 055 * <p> 056 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used. 057 * E.g. <code>groovy:_this.amount > 10</code> 058 * <p> 059 * Available context variables are:<br> 060 * <b>_this</b> -> the validated bean<br> 061 * <b>_value</b> -> the value to validate (e.g. the field value, parameter value, method return value, 062 * or the validated bean for object level constraints) 063 */ 064 String when() default ""; 065 } 066 067 /** 068 * <p>In case the constraint is declared for an array, collection or map this controls how the constraint is applied to it and it's child objects. 069 * 070 * <p><b>Default:</b> ConstraintTarget.VALUES 071 * 072 * <p><b>Note:</b> This setting is ignored for object types other than array, map and collection. 073 */ 074 ConstraintTarget[] appliesTo() default ConstraintTarget.VALUES; 075 076 /** 077 * Specifies if a connection to the URL should be attempted to verify its validity. 078 */ 079 boolean connect() default false; 080 081 /** 082 * error code passed to the ConstraintViolation object 083 */ 084 String errorCode() default "net.sf.oval.constraint.AssertURL"; 085 086 /** 087 * message to be used for the ContraintsViolatedException 088 * 089 * @see ConstraintViolation 090 */ 091 String message() default "net.sf.oval.constraint.AssertURL.violated"; 092 093 /** 094 * Specifies the allowed URL schemes. 095 */ 096 URIScheme[] permittedURISchemes() default {URIScheme.HTTP, URIScheme.HTTPS, URIScheme.FTP}; 097 098 /** 099 * The associated constraint profiles. 100 */ 101 String[] profiles() default {}; 102 103 /** 104 * severity passed to the ConstraintViolation object 105 */ 106 int severity() default 0; 107 108 /** 109 * An expression to specify where in the object graph relative from this object the expression 110 * should be applied. 111 * <p> 112 * Examples: 113 * <li>"owner" would apply this constraint to the current object's property <code>owner</code> 114 * <li>"owner.id" would apply this constraint to the current object's <code>owner</code>'s property <code>id</code> 115 * <li>"jxpath:owner/id" would use the JXPath implementation to traverse the object graph to locate the object where this constraint should be applied. 116 */ 117 String target() default ""; 118 119 /** 120 * Formula returning <code>true</code> if this constraint shall be evaluated and 121 * <code>false</code> if it shall be ignored for the current validation. 122 * <p> 123 * <b>Important:</b> The formula must be prefixed with the name of the scripting language that is used. 124 * E.g. <code>groovy:_this.amount > 10</code> 125 * <p> 126 * Available context variables are:<br> 127 * <b>_this</b> -> the validated bean<br> 128 * <b>_value</b> -> the value to validate (e.g. the field value, parameter value, method return value, 129 * or the validated bean for object level constraints) 130 */ 131 String when() default ""; 132 }