Annotations and Input Validation in Java - SHIP Validatorii.uib.no/~dagh/validatorflyer.pdf ·...

OverviewPremises

AnnotationsProperty-Tests

Dynamic TypingHandling null Values

Cross-TestsBoolean Composition of Tests

Error MessagesRelated Work

Annotations and Input Validation in JavaSHIP Validator

Dag Hovland. Based on joint work with Khalid A. Mughal andFederico Mancini.

July 17, 2009

Dag Hovland. Based on joint work with Khalid A. Mughal and Federico Mancini.Annotations and Input Validation in Java

OverviewPremises

Premises

Annotations

Property-TestsThe Validation Process

Dynamic Typing

Handling null Values

Cross-Tests

Boolean Composition of TestsComposed Property-TestsComposed Cross-Tests

Error Messages

Related Work

OverviewPremises

Information as Properties

I Java is Object-Oriented — everything is an object

I Information available in no-arg methods: properties

I Input is represented as properties of an object

OverviewPremises

I A framework that should be easy to add onto existing projects

I It should be easy to use and create tests

I Tests should be reusable and composable

I Composition of tests should be easy and powerful

I No code inside methods in the class representing input

I No references to code by string names

OverviewPremises

Annotations

I From Java 5.0

I Standardizing comments

I A kind of interface

I On classes, methods, fields, variables

OverviewPremises

The Validation Process

Scenario: International Money Transfer

BIC BICCODE

Account

Clearing-code AB1232342

Amount € 10000 . 10 c

Pay international bill

Insert title here file:///scratch/workspace/Validation/tex/form.html

1 of 1 02/06/09 21:34

OverviewPremises

Configuration by Proximity

@ValidateBICpublic String getBIC() { return BIC; }

@IntRange(min=0,max=10000)public Integer getAmountEuro() { return amountEuro; }

@IntRange(min=0,max=99)

public Integer getAmountCents() { return amountCents; }

OverviewPremises

Using the Framework

OverviewPremises

@Validationpublic @interface IntRange {int min();int max();public static class Testerimplements IPropertyTester<IntRange, Integer> {public boolean runTest(IntRange r, Integer v) {return(v >= r.min() && v <= r.max());

OverviewPremises

Interface for Property-Tests

public interface IPropertyTester <A extends Annotation,I>{public boolean runTest(A an, I o)throws ValidationException;

OverviewPremises

Input Validation as Dynamic Typing

I validate(o) similar to down-casting in Java

I Why cannot Java’s type hierarchy be used?

I String and Integer are final

OverviewPremises

@Required and @NotRequired

I But how should tests handle null values?

I They should, by default, lead to a crash

I However, null is also used to signal special cases

I @Required specifies that a property should not be null —almost standard

I @NotRequired causes no other tests to be run, if the value isnull

OverviewPremises

Cross-Tests over Multiple Properties

I Property-Tests test a single property

I Cross-Tests test several properties at once

OverviewPremises

Scenario: International Money Transfer

BIC BICCODE

Account

Clearing-code AB1232342

Amount € 10000 . 10 c

Pay international bill

Insert title here file:///scratch/workspace/Validation/tex/form.html

1 of 1 02/06/09 21:34

OverviewPremises

Using Cross-Tests

@ExactlyOneNull

@NotRequired

public String getIBAN() { return IBAN; }

@ExactlyOneNull

@AllOrNoneNull

@NotRequired

public String getAccount() { return account; }

@AllOrNoneNull

@NotRequired

public String getClearingcode() { return clearingcode; }

OverviewPremises

Declaring a Cross-Test

@CrossValidationpublic @interface AllOrNoneNull {public static class Testerimplements ICrossTester<AllOrNoneNull,String>{public boolean runTest(AllOrNoneNull c,

ArrayList<String> v)throws ValidationException {...

OverviewPremises

public interface ICrossTester <A extends Annotation, V> {public boolean runTest(A a, ArrayList<V> v)throws ValidationException;

OverviewPremises

Composed Property-TestsComposed Cross-Tests

Basic and Composed Tests

I Basic Tests contain an inner class implementing a test

I Composed Tests are annotated with property-annotations

OverviewPremises

Property-Tests

@ValidateBICpublic String getBIC() { return BIC; }

OverviewPremises

Example of Composed Property-Test

@Validation@BoolTest(BoolType.AND)@PatMatch("\\w8|\\w11")@AdditionalTest

@interface ValidateBIC{}

OverviewPremises

Boolean Composition of Tests

I Annotation @BoolTest

I public enum BoolType{OR, AND, ALLFALSE}

OverviewPremises

Types of Tests

Basic Tests Composed Tests

Property-Tests @IntRange @ValidateBICCross-Tests @AllOrNoneNull @AmountCheck

OverviewPremises

Composed Cross-Tests

@IntRange(min=0,max=10000)@AmountCheckpublic Integer getAmountEuro() { return amountEuro; }

@IntRange(min=0,max=99)@AmountCheck

public Integer getAmountCents() { return amountCents; }

OverviewPremises

Declaring Composed Cross-Tests

// MaxAmount declaration@CrossValidation@BoolTest(BoolType.OR)@OneLessThan(1)@AllLessThan(10000)public @interface MaxAmount {}

//AmountCheck declaration@CrossValidation@BoolTest(BoolType.AND)@SumMin(1)@MaxAmountpublic @interface AmountCheck {}

OverviewPremises

@AmountCheck

OverviewPremises

Custom Error Message

@Validation@BoolTest(BoolType.AND)@PatMatch("\\w8|\\w11")@AdditionalTest@ValErr(message="Invalid BIC")

public @interface ValidateBIC{}

OverviewPremises

The value "BICCODE" returned by method "getBIC" has notpassed the following property-test:+Test: @ValidateBIC()(Error Message: Invalid BIC) because:|-+Test: @PatMatch(value=\w8|\w11)

================================================The following cross-tests have failed:+Test: @AmountCheck() because:|-+Test: @MaxAmount() because:|-+Test: @OneLessThan(value=1)|-+Test: @AllLessThan(value=10000)

+Test: @AllOrNoneNull()+Test: @ExactlyOneNull() because:|-+Test: @ExactlyNNull(value=1)

================================================

OverviewPremises

I Heimdall

I Struts 2

I Java Specification Request (JSR) 303: Bean Validation

I Hibernate

I Hookom and Holmgren

http://shipvalidator.sourceforge.net

Annotations and Input Validation in Java - SHIP Validatorii.uib.no/~dagh/validatorflyer.pdf ·...

Documents

OCEANIC PRODUCT VALIDATION INCLUDING PHYCOERYTHRIN ... · OCEANIC PRODUCT VALIDATION INCLUDING PHYCOERYTHRIN: 4IRBORNE @SHIP (Frank Hoge NASA/GSFC/WFF) ir . t . . Major OCEANIC PIGMENTS

CFD Validation of a Container Ship in Calm Water and Head Seas · CFD Validation of a Container Ship in Calm Water and Head Seas Inno Gatin 1, Vuko Vuk cevi c and Hrvoje Jasak 1University

Trend Validation of CFD Prediction Results for Ship Design

Improvement and Validation of an Analytical Code for Ship

Validation of a Container Ship Model for Parametric Rollingeprints.qut.edu.au/78291/1/Published_paper_Perez.pdf · Validation of a Container Ship Model for ... Centre for Ships and

Validation of Ship Air Wake Simulations and Investigation ... · PDF filetools that will be useful in determining ship air wake impact on rotary wing aircraft. Currently, ship launch

Trend Validation of CFD Prediction Results for Ship … Validation of CFD Prediction Results ... CFD Prediction Results for Ship Design ... influences in the regression analysis of

Validation of Container Ship Squat Modeling Using Full ... · “Validation of Container Ship Squat Modeling Using Full-Scale Trials at the Port of Fremantle.” Journal of Waterway,

Annotations for Software Defect Detection€¦ · JSR 303 Bean Validation API Author: Benjamin Schmid Keywords: JS-303, Bean Validation, Java, J2EE 6, JPA2 Created Date: 3/30/2012

Java Annotations Tutorial - IT Collegeenos.itcollege.ee/~jpoial/java/naited/Java-Annotations-Tutorial.pdf · Java Annotations Tutorial 6 / 27 Chapter 6 Where can be used Annotations

ShipIR Model Validation Using NATO SIMVEX Experiment Results · SHIPIR MODEL VALIDATION USING NATO SIMVEX EXPERIMENT RESULTS INTRODUCTION ShipIR is an infrared (IR) ship signature

AN EXTENDED VALIDATION OF FREE CFD APPLICATION TO SHIP

Intro annotations

Development, Validation, and Application of the Dynaface R ... · Development, Validation, and Application of the Dynaface R Helicopter/Ship Dynamic Interface Simulation Software

Algorithm Validation Toolkit (AVT) - d · PDF fileAlgorithm Validation Toolkit (AVT) David Clunie RadPharm, Inc. RSNA 2008 ... caGRID data services Images, Patient info Annotations,

Validation of Ship Air Wake Simulations and Investigation

User Manual - baum-software.ch · 12.1 Insert annotations Press "Edit annotations" to begin inserting / editing / deleting annotations. Press "Done" to finish editing the annotations

Annotations · Table of Contents 1. Annotations

CONTENTS INCLUDE: Spring Annotations · CONTENTS INCLUDE: n Core Spring Annotations n Spring MVC Annotations n AspectJ Annotations n JSR-250 Annotations n Testing Annotations

Tool Support for Annotations - Java · JSR 305: Annotations for Software Defect Detection New tool-oriented annotations for JDK “This JSR will work to develop standard annotations