Architektur des agimatec-validation Frameworks

Transkript

1 Development : Implementierung Validierungskonzept (Dokumentation) This page last changed on Apr 03, 2008 by roman.stumm. Architektur des agimatec-validation Frameworks Generierung der Metainformationen Integration serverseitig Integration clientseitig Architektur des agimatec-validation Frameworks Das Validierungsframework kann grundsätzlich auf jeder Schicht verwendet werden. Es verwendet commons-beanutils für Reflectionhandling, XStream zur Speicherung von XML und (optional) Freemarker (s. Kap. Integration clientseitig) Document generated by Confluence on Apr 03, :05 Page 1

2 Drei Subsysteme werden in der Abbildung dargestellt: 1. Modelle Document generated by Confluence on Apr 03, :05 Page 2

3 MetaBean und MetaProperty sind für alle JavaBeans (auch ohne dass diese durch XML-Metainformationen beschrieben werden) verfügbar. Sie integrieren die Infos aus den XML-Metainformationen, der java.beans.beaninfo und der Signature des JavaBeans (Typinformationen, Properties). 2. Verwaltung der MetaBeans Der MetaBeanManager lädt die XMLMetaBeans, erzeugt und cached geladene XMLMetaBeans. Mit Hilfe spezieller XMLMetaBeanLoader ist auch der Zugriff auf XMLMetaBeans über remote-schnittstellen hinweg möglich und eine beliebige Modularisierung der XML-Informationen. Der MetaBeanManager merged die Informationen in eine Instanz von MetaBean. 3. Klassen zur Validierung Die Klasse BeanValidator erlaubt die Validierung von Objektnetzen, Einzelobjekten und Einzelattributen nach den definierten Validations der Metainformationen. Ergebnisse werden an einen ValidationListener weitergeben, z.b. die Klasse ValidationResults, die diese kategorisiert und einfachen Zugriff auf die Ergebnisse eines Validierungslaufs bietet. Generierung der Metainformationen <beaninfos> <validator id="standard" java="com.agimatec.utility.validation.routines.nopvalidation"/> <validator id=" " java="com.agimatec.utility.validation.routines. validation"/> <bean id="businessobject" impl="com.agimatec.utility.validation.example.businessobject"> <property name="userid" mandatory="true"/> <property name="firstname" mandatory="true" maxlength="100"/> <property name="lastname" mandatory="true" maxlength="100"/> <property name="title" mandatory="false" maxlength="10"/> <property timelag="past" formattype="date" name="datebirth" mandatory="false"/> <property timelag="future" formattype="timestamp" name="validto" mandatory="false"/> <property name=" "> <feature key="widget"> <value class="string">entry</value> </feature> <feature key="table_column"> <value class="boolean">true</value> </feature> <validator refid=" "/> <validator refid="standard"/> </property> <relationship beanid="address" name="address" mandatory="false" displayname="useraddress"/> <relationship beanid="address" name="addresses" maxlength="3"/> </bean> <bean id="address" impl="com.agimatec.utility.validation.example.businessobjectaddress"> <property name="city"/> <property name="country" mandatory="true" maxlength="10"/> <relationship name="owner" beanid="businessobject" mandatory="true"/> </bean> </beaninfos> <!-- based on com.agimatec.nucleus.persistence.model.deliverymachine --> <bean id="xfiredeliverymachine" impl="com.agimatec.connecta.model.xfiredeliverymachine"> <property name="deliverymachineid" mandatory="true"/> <relationship name="address"/> <!-- based on machineconfiguration.machineconfigurationid --> <property name="machineconfigurationid" mandatory="true"/> <!-- based on identification --> <property name="deliverymachineidentification" mandatory="true" maxlength="40"/> <property name="serialnumber" maxlength="40"/> <property name="model" maxlength="40"/> <property name="type" maxlength="40"/> <property name="vendor" maxlength="40"/> <property name="locationtype" maxlength="40"/> <relationship name="tags"/> <property name="lifecyclestatus" mandatory="true"/> <property name="contacting" mandatory="true"/> </bean> Document generated by Confluence on Apr 03, :05 Page 3

4 Das erste Beispiel <bean id="businessobject"> ist manuell kodiert und zeigt viele Features der XMLMetainformation: Validierungsattribute maxlength, mandatory, formattype etc. Verwendung von custom-validators (hier ) und Redefinition des standard-validators (hier: NOP) Beziehungen zwischen Beans: <relationship> Definition von Features mittels Tag <feature> beliebiger Art und beliebigen Typs. Das zweite Beispiel ist eine generierte Metainformation <bean id="xfiredeliverymachine">. Der Maven-Build erzeugt diese aufgrund der javax-persistence-annotations und der DTO-Annotations (siehe Annotation driven code generation) der EJB-Klassen. Dadurch stehen Informationen über Pflichtfelder (mandatory) Feldlängen (maxlength) Unique-Felder (uniquekey-feature der MetaProperty) und Primary-Key-Felder (mainkey-features des MetaBeans) zur Verfügung, die den Einschränkungen der Datenbank entsprechen. Die Generierung erfolgt durch ein Freemarker-Template. Als Generierungstool wird Annomark verwendet, der über Gram im Projekt agimatec/nucleus/core/persistence gestartet wird. DIE GENERIERTE DATEI SOLL NICHT GEÄNDERT WERDEN: der Maven-Build kopiert diese in die resources von connecta-xfire-utility. Werden weitere Validierungen etc. benötigt, so werden diese in einer separaten XML-Datei (beaninfos-custom.xml) abgelegt. Der MetaBeanFinder bringt die beiden Informationen anhand gleicher Bean-Ids zusammen. Dieses Verfahren wird im Client um weitere XML-Dateien zu den gleichen Beans erweitert. Integration serverseitig Die Integration findet serverseitig z.b. in der Webservice-Schicht statt. Die agimatec-klasse TransactionalInvoker wird von XFire verwendet, um jeden SOAP-Aufruf in eine EJB-Datenbanktransaktion einzubetten und die Connecta Exceptionszu behandeln. In TransactionalInvoker wird ferner das Validierungsframework eingebunden, um die eingehenden Objekte, wo gewünscht, zu validieren. Vorteil: Deklarative Lösung, die Validierung in allen APIs von Connecta ermöglicht, ohne dass die Businesslogik geändert werden muss Nicht-deklarative Validierungen können in der Businessschicht hinzukommen. Kommunikation über einen threadlocal Validierungskontext (ThreadValidationContext) Mit Hilfe an einer Servicemethode im Webservice-Interface wird die Validierung grundsätzlich enabled und automatisch ein ThreadValidationContext erzeugt. Mit Hilfe kann an den Parametern der Webservice-Interface-Methoden festgelegt werden, welcher Parameter validiert werden soll. Document generated by Confluence on Apr 03, :05 Page 4

5 Integration clientseitig Die meisten Standardvalidierungen (mandatory, maxlength, minlength, maxvalue, minvalue, ggf. regexp) können clientseitig per JavaScript durchgeführt werden. Daher gibt es Möglichkeiten, die Informationen von MetaBean auch im JavaScript / JSON - Format für Ajax-Clients zugänglich zu machen. Klasse: JSONGenerator Mit einem Freemarker-Template (metabean-json.ftl) wird aus MetaBeans ein JSON-Script erzeugt. Der JSON Code wird dem Client von einem Servlet : MetaBeanServlet (unter agimatec-suite/ostium/utilities/util-servlet) auf Anfrage erzeugt. Beispiel für JSON-Code der MetaDaten: agimatec.namespace("agimatec.metadata"); (function(){ var metabean0 = { "id" : "com.agimatec.utility.validation.example.businessobject", "beanclass" : "com.agimatec.utility.validation.example.businessobject", "name" : "BusinessObject", "features" :{ "WIDGET" : "entry", "DOMAIN" : "TestObjects", "mainkey" : "userid" Document generated by Confluence on Apr 03, :05 Page 5

6 "properties" :{ "address":{ "name" : "address", "type" : "com.agimatec.utility.validation.example.businessobjectaddress", "features" : { "mandatory" : false, "refbeanid" : "com.agimatec.utility.validation.example.address" "addresses":{ "name" : "addresses", "type" : "java.util.list", "features" : { "maxlen" : 3, "refbeanid" : "com.agimatec.utility.validation.example.address" "choice":{ "name" : "choice", "type" : "com.agimatec.utility.validation.example.businessenum", "features" : {"enum" : {"VALUE1": "VALUE1", "VALUE2": "VALUE2", "VALUE3": "VALUE3"} "datebirth":{ "name" : "datebirth", "type" : "java.util.date", "features" : { "timelag" : "PAST", "mandatory" : false, "formattype" : "Date" " ":{ "name" : " ", "features" : { "WIDGET" : "entry", "ajax-formatter" : {"locale" : "DE","style" : "info" "TABLE_COLUMN" : true, "jsfunctions" : ["noop"] "firstname":{ "name" : "firstname", "features" : { "maxlen" : 100, "mandatory" : true "lastname":{ "name" : "lastname", "features" : { "maxlen" : 100, "mandatory" : true "numericvalue":{ "name" : "numericvalue", "type" : "int", "features" : { "minvalue" : -100, "maxvalue" : 100 "title":{ "name" : "title", "features" : { "maxlen" : 10, "mandatory" : false "userid":{ "name" : "userid", "type" : "long", "features" : { "mandatory" : true "validto":{ "name" : "validto", "type" : "java.sql.timestamp", "features" : { "timelag" : "FUTURE", "mandatory" : false, "formattype" : "Timestamp" } } }; var metabean1 = { "id" : "com.agimatec.utility.validation.example.businessobjectaddress", "beanclass" : "com.agimatec.utility.validation.example.businessobjectaddress", "name" : "BusinessObjectAddress", "features" :{ "properties" :{ Document generated by Confluence on Apr 03, :05 Page 6

7 }; } "city":{ "name" : "city", "features" : { "country":{ "name" : "country", "features" : { "owner":{ "name" : "owner", "type" : "com.agimatec.utility.validation.example.businessobject", "features" : { } agimatec.metadata.metabeans = { "com.agimatec.utility.validation.example.businessobject" : metabean0, "com.agimatec.utility.validation.example.businessobjectaddress" : metabean1 }; })(); Folgende Features hat der JSONGenerator: Alle Klassen, die per XML beschrieben sind, werden zurückgeliefert. Alle Bean- und Property-Features vom Typ string, boolean, number, null, list<string> und map<string> werden aus ausgegeben. Die Typinformationen aus der Javaklasse werden ausgegeben. Für Enum-Attribute werden alle Werte (als String-Map) automatisch in JSON ausgegeben Bei Relationships werden die Referenzen der JSON-Objekte einzelner Beans zueinander gesetzt. MetaBeanServlet: Die XML-MetaBeanInfos des Servers können im Client durch weitere XML-MetaBeanInfos um zusätzliche Beans erweitert werden. durch Informationen im Client "gepatched"; z.b. um Features und Constraints ergänzt werden. Dabei "gewinnt" stets die Information in der zuletzt geladenen XML-Datei. Das MetaBeanServlet enthält (in der Methode init()) eine Liste aller Dateien mit MetaBeanInfos und lädt diese entweder aus dem lokalen Classpath des Servlet oder über einen Webservice vom nucleus-server. Einmal geladene Metabeans sowie der generierte JSON-Code werden im Servlet bzw in der statischen Instanz von MetaBeanManager gecacht. Document generated by Confluence on Apr 03, :05 Page 7