Goldstift's blogspot - my 2 cent

SpringRoo: Howto translate Java exceptions to user-friendly error messages

2011-10-24T23:31:00.000+02:00

Introduction

This blog post belongs to a tutorial series on SpringRoo 1.2.0 which uses the sample application "photooapp" to provide practical examples.
Within this blog post I will try to explain how you can configure your SpringRoo application to translate well-known exceptions to user-friendly error messages.
By default SpringRoo's exception handling is very basic meaning the technical exception message is directly presented to the user. Our aim is to provide the user with human-readable error messages he (most probably) can understand and react upon.

Basics: Translations in Spring MVC

First of all we need to make ourselves familiar with the translation process in Spring MVC. To translate any given String to the currently set browser locale, Spring MVC uses so called "message codes". These codes are defined in property files which are located in "src/main/webapp/WEB-INF/i18n/application.properties". For each supported locale there will be a separate application.properties file, e.g. application_de.properties for german translations of the message codes. The "application.properties" file must always be used as the fallback reference.

Adding a sample Translation

So let's say, we wanted to translate a "org.hibernate.exception.ConstraintViolationException" which is thrown whenever the user tries to create a "duplicate entry".
Therefore we would add the following line to the application.properties file:

    exceptions.db.duplicateentry=The record could not be saved as there is already a record in the database having the same unique identifier\!

Customize exception JSP

Next we prepare the "uncaughtException.jspx" which is the default JSP for exception handling in Spring MVC. To keep it simple, we'll remove the lines with the "-" and add the ones with "+":
With the help of the little snipped '<spring:message code="${exception.message}" />' Spring searches for a property with the name of the Exception's message in the above named property file. Therefore we "only" need to find a way to set "exceptions.db.duplicateentry" as the Exception's message.

Spring MVC ExceptionResolver

The ExceptionResolver in Spring MVC is used to determine which JSP fits best whenever any Exception is thrown. In my opinion this is the perfect place to perform our little magic.To accomplish this and be able to handle any kind of Exception in the most flexible way I added the following three classes (links lead you to github):

The I18nMappingExceptionResolver is configured via a number of MessageMatchCriteria and wraps the original exception inside an AnalyzedApplicationException. The ladder will then have the translatable property as "message". The I18nMappingExceptionResolver has to be set as the default exception resolver which is done by changing the following in webmvc.xml:
The relevant change is the property "messageMapping" which contains a map of the a fore mentioned MessageMatchCriteria which are mapped to translatable properties. The "classNamePart" can hold a simple or fully qualified class name or just a part of it. The same applies to the "messagePart" attribute - as you can see in the sample above, the term "Duplicate entry" is part of the original exception message and if found will return a different property name than a normal ConstraintViolationException. I should mention that the classPart and the messagePart are searched in the complete stacktrace of the original exception.
Another thing to note is that the AnalyzedApplicationException makes it easy to access the originals root cause e.g. in the JSP as it's accessible via the attribute "rootCause". Therefore the variable "${exception.rootCause.message}" will resolve to the root cause's exception message.

Resume

All the changes have already been done to photooapp so you can review all the changes by taking a look at the following commit statement: https://github.com/aheusingfeld/photooapp/commit/eb9fb0d8b46c50c27a8fdb1e2c01a498fed4b136
Please leave a comment if you have any questions or good advice for improving the blog post series. Thanks in advance.

Further links

Photooapp sourcecode at Github: https://github.com/aheusingfeld/photooapp
SpringRoo Website: www.springsource.org/roo
SpringRoo Downloads at Github: https://github.com/SpringSource/spring-roo/archives/master
Spring Reference Documentation: Spring MVC - ExceptionResolver

iPhone: Wartezeit für Rufumleitung bei Abwesenheit setzen

2011-10-01T00:33:00.001+02:00

Frage: Wie kann man eigentlich am iPhone die Zeit oder die Anzahl der Klingelzeichen einstellen, die das Telefon wartet, bis ein nicht angenommener Anruf bspw. an die Mailbox weitergeleitet wird?

Antwort:
Diese Weiterleitung nennt man auch "Rufumleitung wenn keine Rufannahme"

Da dies nicht Telefon-spezifisch sondern eine Einstellung in den Systemen des Netzbetreibers ist, gibt es hierfür nicht in jedem Telefon einen Menüpunkt oder eine Einstellungsmöglichkeit. So auch nicht beim Apple iPhone.

Es gibt aber dennoch die Möglichkeit, diese Einstellung über einen sog. GSM-Code zu ändern. Eine Übersicht der meisten Codes gibt es unter http://www.gsmcodes-online.de/
Zur Rufumleitung: http://www.gsmcodes-online.de/Rufumleitungen/rufumleitungen.html

Diese Nummernfolge muss direkt in den Ziffernblock der "Telefon"-App eingetippt werden.

Beispiel "Sprachanrufe nach 30 Sekunden auf die Mailbox umleiten":


**61*MAILBOXNUMMER*11*30#

Meine MAILBOXNUMMER im Telekom-Netz ist z.B. +49151 13 12345678 dementsprechend lautet die ganze Zeichenkette dann

**61*+491511312345678*11*30#

Wie die MailboxNummer bei anderen Providern ist, kann ich leider nicht sagen, man kann aber vorher durch die Eingabe von "*#61#" die aktuelle Einstellung abfragen.

SpringRoo: Entity-Klassen und JPA-Repositories mit SpringRoo erstellen

2011-09-25T00:29:00.002+02:00

Dies ist der zweite Artikel in meiner Tutorial-Reihe zu SpringRoo 1.2.0 in der die Beispiel-Anwendung "photooapp" entwickelt wird.

Vorbedingungen

In diesem Beitrag geht es um die initiale Erstellung der Roo-Anwendung. Hierfür müssen folgende Vorbedingungen erfüllt sein:

Java Development Kit (JDK) 6 oder höher ist installiert und im "PATH"
SpringRoo 1.2.0.M1 wurde heruntergeladen und installiert
Apache Maven wurde heruntergeladen und installiert
lokaler MySQL 5.1 Server wurde installiert und gestartet
Initiales Setup-Skript für MySQL-Datenbank und -Benutzer wurde ausgeführt

Lokalen Datenbankserver installieren (falls notwendig)

Wir gehen davon aus, dass die Anwendung später mit einer MySQL 5.1-Datenbank betrieben werden soll, die auf dem gleichen Server läuft wie die Anwendung.
Um eine ähnliche Umgebung für die Entwicklung zu verwenden, benötigen wir eine lokale MySQL-Installation. Für diejenigen ohne eine lokale Installation ist die wohl einfachste und schnellste Art dies zu erreichen wahrscheinlich das XAMPP-Paket von Apachefriends. Es kann über die URL http://www.apachefriends.org/de/xampp.html heruntergeladen werden.

Ist die Software installiert und der MySQL-Datenbankserver gestartet, können mit den folgenden beiden Befehlen die Datenbank und der zugehörige Benutzer erstellt werden. Diese Befehle sind auch im MySQL-Setup-Skript enthalten:

$ /Applications/XAMPP/xamppfiles/bin/mysql -u root -p

Enter password: 
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 8
Server version: 5.1.44 Source distribution

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> CREATE DATABASE photooapp DEFAULT CHARSET=utf8;

mysql> GRANT ALL ON photooapp.* TO photooapp@localhost IDENTIFIED BY 'pho!00App';

mysql> exit

Bye

$

Nun sollten alle notwendigen Vorbedingungen erfüllt sein und wir können in der SpringRoo shell weitermachen.

Datenmodell-Klassen in SpringRoo erstellen

Für die Demo-Anwendung "Photooapp" wurde folgendes (vorläufiges) Datenmodell erstellt, das wir nun in SpringRoo umsetzen wollen:

Hierzu öffnen wir die SpringRoo Shell:

ahe:(git)photooapp[master]/$ ~/dev/tools/spring-roo-1.2.0.M1/bin/roo.sh 
____  ____  ____  
/ __ \/ __ \/ __ \ 
/ /_/ / / / / / / / 
/ _, _/ /_/ / /_/ /  
/_/ |_|\____/\____/    1.2.0.M1 [rev 1fa252f]


Welcome to Spring Roo. For assistance press TAB or type "hint" then hit ENTER.
...
roo> script --file log.roo --lineNumbers true

Nun gibt es zwei Möglichkeiten:

a) Man tippt die folgenden Befehle auf der Roo-Shell ein:

project de.goldstift.photoo

jpa setup --provider HIBERNATE --database MYSQL --databaseName photooapp --userName photooapp --hostName 127.0.0.1 --password pho!00App

entity --class ~.domain.Tag --activeRecord false --testAutomatically
field string --fieldName name --notNull --sizeMin 2
field string --fieldName lowerCaseName --notNull --sizeMin 2

entity --class ~.domain.Person --activeRecord false --testAutomatically
field string --fieldName lastname --notNull --sizeMin 2
field string --fieldName firstname
field string --fieldName nickname --notNull

entity --class ~.domain.Event --activeRecord false --testAutomatically 
field string --fieldName name --notNull --sizeMin 2
field date --fieldName fromDate --type java.util.Date --dateTimeFormatPattern "yyyy-MM-dd HH:mm:ss"
field date --fieldName toDate --type java.util.Date --dateTimeFormatPattern "yyyy-MM-dd HH:mm:ss"

entity --class ~.domain.Folder --activeRecord false --testAutomatically 
field string --fieldName title
field date --fieldName createDate --type java.util.Date --dateTimeFormatPattern "yyyy-MM-dd HH:mm:ss"
field string --fieldName systemPath --notNull --sizeMin 1
field string --fieldName urlPath --notNull --sizeMin 1
field boolean --fieldName writable --primitive false

entity --class ~.domain.PhotoFile --activeRecord false --testAutomatically 
field reference --fieldName folder --type ~.domain.Folder --cardinality MANY_TO_ONE --fetch EAGER
field string --fieldName filename --notNull
field number --fieldName width --notNull --type java.lang.Short
field number --fieldName height --notNull --type java.lang.Short

entity --class ~.domain.Photo --activeRecord false --testAutomatically 
field string --fieldName title
field string --fieldName description
field string --fieldName thumbnail --notNull
field reference --fieldName thumbnailFile --type ~.domain.PhotoFile --cardinality MANY_TO_ONE --fetch EAGER
field reference --fieldName previewFile --type ~.domain.PhotoFile --cardinality MANY_TO_ONE --fetch EAGER
field reference --fieldName originalFile --type ~.domain.PhotoFile --cardinality MANY_TO_ONE --fetch EAGER
field date --fieldName importDate --type java.util.Date --dateTimeFormatPattern "MS"
field date --fieldName shotDate --type java.util.Date --dateTimeFormatPattern "MS"
field set --fieldName tags --type ~.domain.Tag --cardinality MANY_TO_MANY --fetch EAGER 
field set --fieldName persons --type ~.domain.Person --cardinality MANY_TO_MANY --fetch EAGER 
field set --fieldName events --type ~.domain.Event --cardinality MANY_TO_MANY --fetch EAGER 

repository jpa --interface ~.repository.TagRepository --entity ~.domain.Tag
repository jpa --interface ~.repository.EventRepository --entity ~.domain.Event
repository jpa --interface ~.repository.PersonRepository --entity ~.domain.Person
repository jpa --interface ~.repository.PhotoRepository --entity ~.domain.Photo
service --interface ~.service.TagService --entity ~.domain.Tag
service --interface ~.service.EventService --entity ~.domain.Event
service --interface ~.service.PersonService --entity ~.domain.Person
service --interface ~.service.PhotoService --entity ~.domain.Photo

json all
web mvc setup
web mvc all --package ~.web

oder

b) man importiert die Befehle als Roo-Skript (speichern als "log.roo") mit Hilfe des folgenden Befehls:

roo> script --file log.roo --lineNumbers true

Anschließend kann die Anwendung über die folgenden Maven Befehle gebaut und gestartet werden:

ahe:(git)photooapp[master]/$ mvn clean package

(...) 

ahe:(git)photooapp[master]/$ mvn jetty:run

Durch letzteren Befehl wird die Anwendung in einem Jetty ApplicationServer gestartet, wodurch sie unter http://localhost:8080/photooapp verfügbar sein sollte.

Die komplette Anwendung ist bei github verfügbar unter https://github.com/aheusingfeld/photooapp

Weiterführende Links

Photooapp Quellcode bei github: https://github.com/aheusingfeld/photooapp
SpringRoo Webseite: www.springsource.org/roo
SpringRoo Downloads bei Github: https://github.com/SpringSource/spring-roo/archives/master
Apache Maven downloads: http://maven.apache.org/download.html

Starting PhotooApp - A SpringRoo tutorial application

2011-09-23T00:35:00.000+02:00

Ich hatte bereits im Februar angekündigt, dass ich hier ein paar Artikel über SpringRoo schreiben würde, und nutze nun das Erscheinen des neuen Meilensteins um damit zu beginnen.

Die Idee

Vor ein paar Tagen ist endlich SpringRoo 1.2.0.M1 erschienen, welches der erste sog. Milestone der nächsten Version von SpringRoo ist. Das Besondere hieran ist die Unterstützung des Repository- oder auch DAO-Models, welches im Gegensatz zu dem sog. ActiveRecord-Model steht. Bisher verwendete SpringRoo zwingend das ActiveRecord-Model. Dank dieser Neuerung kann SpringRoo nun endlich in Kombination mit Spring Data JPA genutzt werden, was viele Vorteile und einige neue Möglichkeiten gerade im Bereich der Finder eröffnet.
Mein Ziel ist anhand einer Beispiel-Anwendung/ Demo-App die Möglichkeiten von SpringRoo zu demonstrieren und Workarounds für bekannte Unschönheiten aufzuzeigen.

Auf Grund persönlicher Präferenzen wird die Demo-App eine serverbasierte Fotoverwaltung, die sowohl von mobilen Endgeräten als auch von Desktop-PCs genutzt werden kann. Als Feature sollen die mobilen Endgeräte Fotos und Videos an die Anwendung übermitteln können, so dass diese direkt für andere Nutzer verfügbar sind.

Anforderungen

Hier die bisherigen Anforderungen:

Die Anwendung muss Fotos aus einem Dateisystemordner importieren können
Die Anwendung muss während des Imports Minibilder/ Thumbnails der Originale erstellen, die eine maximale Kantenlänge von 250px haben
Die Anwendung muss während des Imports Vorschaubilder/ Previews der Originale erstellen, die eine maximale Kantenlänge von 1280px haben
Ein Foto hat folgende Eigenschaften

Titel
Beschreibung
Thumbnail-Datei (Fotodatei)
Vorschau-Datei (Fotodatei)
Original-Datei (Fotodatei)
Importdatum
Erstellungsdatum

Eine Fotodatei hat folgende Eigenschaften

Dateisystemordner
dateiname
Breite
Höhe

Die Anwendung soll die EXIF-Daten eines Fotos anzeigen können
Ein Foto muss keinem oder beliebig vielen Stichwörtern zugeordnet werden können
Ein Foto muss keiner oder beliebig vielen Personen zugeordnet werden können, die auf dem Photo zu sehen sind
Ein Foto muss keinem oder beliebig vielen Events zugeordnet werden können
Ein Event hat folgende Eigenschaften

Name
Von-Datum
Bis-Datum

Fotos müssen anhand von folgenden UND-verknüpften Filterkriterien gesucht werden können

Stichwörter (Suchfeld mit Vorschlagswerten)
Personen (Suchfeld mit Vorschlagswerten)
Events (Suchfeld mit Vorschlagswerten)
Name des Dateisystemordners
Titel des Fotos
Erstellungsdatum in gewähltem Zeitraum

Suchergebnislisten müssen eine eindeutige, wiederverwendbare URL haben
Die Anwendung sollte einen Präsentations-/ Slideshow-Modus für Suchergebnislisten unterstützen, welcher die Vorschaubilder der Listeneinträge für jeweils 3 Sekunden anzeigt

Planung

Diese Anforderungen werde ich in folgende Schritte (und Blog-Posts) aufteilen:

SpringRoo: Entity-Klassen und JPA-Repositories mit SpringRoo erstellen
SpringRoo: Howto translate Java exceptions to user-friendly error messages (English)
SpringRoo: Spring JS/ Dojo durch jQuery ersetzen
SpringRoo: Standard-Auswahllisten in Textfelder mit dynamischen Vorschlagswerten umbauen
SpringRoo: Excel-Download für alle Listen-Seiten mit minimalem Aufwand
SpringRoo: Dynamische Finder mit Hilfe der JPA Criteria API
SpringRoo: Standardwebseiten auf smartphone-kompatibles HTML5 aktualisieren

Weitere Ideen und Vorschläge können gerne als Kommentar gestellt werden.

Die Demo-App ist bei Github unter der Adresse https://github.com/aheusingfeld/photooapp verfügbar.

UPDATE 24.09.2011 23:00h:
- Anforderungen in Deutsch übersetzt
- Liste der geplanten Blogposts/ weiteren Schritte erstellt

Vielen Dank für Euer Feedback und Euer Interesse.

Praxistipps zu ftplicity

2011-06-05T13:22:00.001+02:00

Ich nutze seit geraumer Zeit "ftplicity" für das Backup meiner Server auf einen FTP-Backupserver. In diversen Artikeln u.a. bei heise.de ("Hinter Schloss und Siegel") wird genau beschrieben, wie man so ein Backup auch verschlüsselt für einen nicht vertrauenswürdigen Backupserver einrichtet.
Mein Backup wird durch die folgenden crontab-Einträge gesteuert:

# run the (incremental) backup each night at 05:11h
11 5 * * 1-6 /usr/local/bin/ftplicity backup &> /var/log/ftplicity_incremental.log
25 5 * * 1-6 /root/bin/checkBackupSize.sh | mail -s "ftplicity backup status" MY@MAIL.de
# do a full backup every sunday & delete old backups
45 3 * * 0 /usr/local/bin/ftplicity full &> /var/log/ftplicity_full.log
35 4 * * 0 /usr/local/bin/ftplicity purge --force &>> /var/log/ftplicity_full.log
25 5 * * 0 mail -s "ftplicity_full.log" MY@MAIL.de < /var/log/ftplicity_full.log

Über die Zeit habe ich aber gemerkt, dass eine Punkte nicht beschrieben sind.

Wie kann ich mir den belegten Backupspeicher ansehen?

Um den Hintergrund dieser Frage besser einschätzen zu können, muss man wissen, dass

die meisten Backupserver eine Quota für die Benutzer einrichten
zum Löschen einer Datei via FTP der gleiche Platz auf dem Server/ der Quota frei sein muss, wie die Datei bereits belegt

Vor diesem Hintergrund bedeutet dies, dass man eine 10MB große Datei nicht löschen kann, wenn in der Quota nur noch 9MB frei sind! Aus diesem Grund kann es passieren, dass man obsolete Backups nach erfolgreichem Fullbackup nicht mehr löschen kann, wenn nicht genauso viel Speicher in der Quota frei ist, wie gelöscht werden soll. Zur Anzeige des belegten Speichers auf dem entfernten FTP-Server verwende ich als Workaround folgendes Perl-Skript:

#!/bin/sh 
# Location: /root/bin/checkBackupSize.sh
# Prints the size of all files on the remote FTP server to STDOUT

ftp -n u30754.your-backup.de <<EOT  | perl -ne '$_=~/u30754   u30754   (\d+) /; $cnt=$cnt+$1; print $cnt."\n"' | tail -n 1 | perl -ne 'print "Current size of backup is " . $_/1024/1024 . " MB\n"'
user u30754 A0Lr7NEIvEeFxMDw
dir 
quit 
EOT

Wie funktioniert der Parameter "HOECHSTALTER"?

Dieser Parameter soll eigentlich das Alter der ältesten Datei markieren. Bei einem Aufruf von "ftplicity purge" wird dementsprechend versucht alle Dateien zu löschen, die älter als 7 Tage sind. Full-Backups können allerdings nur gelöscht werden, wenn es keine inkrementellen Backups mehr gibt, die von ihnen abhängen.

Stellt man in der "~/.ftplicity/conf" das "HOECHSTALTER=7D", ruft aber nur alle 14 Tage ein "ftplicity full" auf, so werden auf dem Backup-Server die Dateien der inkrementellen Backups der letzten 14 Tage nicht löschbar sein!

Dies sollte vor allem in Zusammenhang mit o.g. Tipp bzgl. "belegter Backupspeicher" beachtet werden.

How to Set Default Comment Security Level in Atlassian JIRA

2011-06-03T16:58:00.001+02:00

Atlassian JIRA in my humble opinion one of the greatest issue tracking systems around. Nevertheless there are still many missing features, one of them may be "setting the default comment security level".

There is a nice little confluence wiki page which describes some kind of dirty hack to solve or at least work around this problem. The URL to that page is: http://confluence.atlassian.com/display/JIRA/How+to+Set+Default+Comment+Security+Level

Unfortunately the workaround works only for JIRA 4.1 and lower as Atlassian completely rewrote there UI for version 4.2 onwards. Therefore the <select>-element for the "comment security level" is hidden and the user gets to see a HTML dropdown which is much more beautiful and nicer to work with. But it breaks the above mentioned hack as the HTML dropdown doesn't really care about the state of the <select>-element, as it holds the state inside of its own "model".
There is already a JIRA issue describing the problem: JRA-23365

I couldn't solve the problem completely as I have absolutely no knowledge about the inner workings of "AJS", Atlassians Javascript Library, but I somehow could extend the above mentioned workaround.

Here's the code I put into my "announcement banner" field:

<script language="JavaScript">
    <!--
    jQuery.noConflict();
    var defaultRoleName = 'role:10030'
    window.onload = function() {
        var commentLevelSelect = document.getElementById("commentLevel");
        if (commentLevelSelect) {
            for (var i = 1; i < commentLevelSelect.options.length; i++) {
                if (commentLevelSelect.options[i].value == defaultRoleName) {
                    commentLevelSelect.options[i].selected;
                    commentLevelSelect.value = defaultRoleName;
                    jQuery("a.drop span.icon").removeClass("icon-unlocked").addClass("icon-locked");

                    var htmlEscapedLabel = AJS.$("<div/>").text(commentLevelSelect.options[i].text).html();
                    jQuery("span.current-level").html(AJS.format(AJS.params.securityLevelViewableRestrictedTo, htmlEscapedLabel))

                    break;
                }
            }
        }
    }
    //-->
</script>
<style>
   .alertHeader{display:none;}
</style>

Any comments and suggestions on this are very much appreciated!

Update 2012-02-02: I updated the code and tested it with JIRA 4.3.4

Broken special chars in Spring Roo?

2011-02-13T12:15:00.000+01:00

This is the first post in an upcoming series of posts on Spring Roo (see footer for details an Roo).

Problem: Special chars and Umlauts are not correctly displayed in my Roo-Application

[german version]
There are often questions and support requests on the above named topic in Spring Roo-Forum. Mostly questioners write that german "Umlauts" like ä, ö, ü and ß or other special chars in cyrillic are not correctly display or saved to the database. With the following post I'd like to review the most common sources of the problem and come up with solutions.

Encoding of the HTML/ JSP page

Roo generated JSPs are always delivered with UTF-8 encoding. In case you write your additional JSPs by hand, you should assure these pages are also delivered to the browser in UTF-8 encoding so the form data will be correctly send on submit.
This can be achieved by specifying the following line of code at the beginning of each JSP:

<jsp:directive.page contenttype="text/html;charset=UTF-8"
   pageencoding="UTF-8"/>

To show you an example where to exactly put this, the "default.jspx", which serves a frame for all other JSP pages via Apache Tiles, contains the following lines to preserve UTF-8 encoding in the resulting HTML:

<html xmlns:jsp="http://java.sun.com/JSP/Page" xmlns:c="http://java.sun.com/jsp/jstl/core" xmlns:tiles="http://tiles.apache.org/tags-tiles" xmlns:spring="http://www.springframework.org/tags" xmlns:util="urn:jsptagdir:/WEB-INF/tags/util" >  
 
 <jsp:output doctype-root-element="HTML" doctype-system="about:legacy-compat" />
 
 <jsp:directive.page contentType="text/html;charset=UTF-8" />  
  
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<!-- ... -->

To check whether your page is delivered in UTF-8 encoding, open it in your browser and have a look at menu "View > Character Encoding".

CharacterEncodingFilter in web.xml file

This is the most common point of failure. We're talking about the order in which the <filter-mapping>-Tags occur in your "src/main/webapp/WEB-INF/web.xml". These tags define in which order the filters are executed on each HTTP-Request.
Roo generates the correct order since Version 1.1.1! Previous versions are still buggy.

The correct order looks like the following:

<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>Spring OpenEntityManagerInViewFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>HttpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>springSecurityFilterChain</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

In case you want to change the order it is important to understand at least a minimum of the inner workings of these filters:

CharacterEncodingFilter - Sets the encoding on the HTTP-Request in case the Browser didn't send the encoding of the HMTL-page/ form
OpenEntityManagerInViewFilter - only for Hibernate, sets the EntityManager to a ThreadLocal (see discussion on Pros and Cons)
HttpMethodFilter - Necessary to really perform e.g. HTTP PUT or HTTP DELETE requests!
springSecurityFilterChain - has to be run AFTER HttpMethodFilter in case you check HTTP-Method in Spring Security
... other filters

To avoid problems with the encoding of your special chars, "CharacterEncodingFilter" has to be run before any other filter has worked on the request data!
For this reason the general advice is: the <filter-mapping> for CharacterEncodingFilter has to be at the first position in your "web.xml" (See ROO-1698 for an explanation - the charset CANNOT be set to the request after the InputStream has been read)!

Database connection

The last point is to assure that your application communicates with the database via unicode with a default encoding of UTF-8.

As Roo generates the correct connection string for MySQL since "the early days" there haven't been many bugs with this lately.
The connection string can be configured in "src/main/resources/META-INF/spring/database.properties" and looks like the following for MySQL:
database.url=jdbc:mysql://[YOUR_DB_SERVER]:3306/[YOUR_DB_NAME]?autoReconnect=true&useUnicode=true&characterEncoding=UTF-8

Conclusion

Since version 1.1.1 Spring Roo provides a (by now) bug free support for special chars and umlauts, which as been tested with various languages worldwide.

If you have any questions on Spring Roo or the topic named above you can find competent assistance in the Roo-Forum.

References/ Links used in the text

ROO-JIRA issues

Threads in ROO-Forum

Other

Spring Roo is a Code-Generation-Tool for Software development in Java. It is a lightweight developer tool that makes it fast and easy to deliver instant results. Best of all, you code 100% in Java and get to reuse all your existing Java knowledge, skills and experience.

There are already many Add-Ons available to customize Roo to your special needs. In case you don't find an Add-On that fits your needs, you can easily create your own Add-On in just a few steps.

Umlaute und Sonderzeichen in Spring Roo?

2011-02-10T22:32:00.013+01:00

Dies ist der erste in einer Reihe von Blog-Posts über Spring Roo (Erläuterung siehe unten).
[english version]

Problem: Sonderzeichen und Umlaute werden in meiner Roo-Anwendung nicht korrekt angezeigt

Im Spring Roo-Forum gibt es öfter Anfragen, die o.g. Problem beschreiben, dass deutsche Umlaute wie ä, ö, ü und ß nicht korrekt gespeichert oder "kaputt" übertragen werden. Im Folgenden möchte ich kurz die häufigsten Fehlerquellen und Lösungen aufzeigen.

Zeichensatz der HTML-/ JSP-Seite

Durch Roo generierte JSPs werden immer im Zeichensatz UTF-8 ausgeliefert. Schreibt man eigene JSPs bspw. mit Formularen, sollte diese HTML bzw. JSP-Seite als Zeichensatz ebenfalls UTF-8 verwenden. Dies erreicht man in dem am Anfang der JSP die folgende Zeile eingefügt wird:

<jsp:directive.page contenttype="text/html;charset=UTF-8"
   pageencoding="UTF-8"/>

Am Anfang der "default.jspx", die über Apache Tiles als "Rahmen" für alle anderen JSP-Seiten gilt, sind z.B. folgende Angaben zum Encoding/ Zeichensatz enthalten:

<html xmlns:jsp="http://java.sun.com/JSP/Page" xmlns:c="http://java.sun.com/jsp/jstl/core" xmlns:tiles="http://tiles.apache.org/tags-tiles" xmlns:spring="http://www.springframework.org/tags" xmlns:util="urn:jsptagdir:/WEB-INF/tags/util" >  
 
 <jsp:output doctype-root-element="HTML" doctype-system="about:legacy-compat" />
 
 <jsp:directive.page contentType="text/html;charset=UTF-8" />  
  
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

<!-- ... -->

Ist sichergestellt, dass die Seiten im Zeichensatz "UTF-8" ausgeliefert werden (dies kann im Browser meist im Menüpunkt "Ansicht > Zeichensatz" kontrolliert werden), die Sonderzeichen werden aber trotzdem falsch übertragen, ist dies nicht die Fehlerursache.

CharacterEncodingFilter in der web.xml

Dieser Punkt ist der häufigste Fehler. Es geht hierbei um die Reihenfolge der <filter-mapping>-Tags in der Datei "web.xml". Diese Tags geben an, in welcher Reihenfolge die einzelnen Filter bei einem HTTP-Request durchlaufen werden.
Roo generiert leider erst seit Version 1.1.1 per Default die korrekte Reihenfolge, wie folgt aussieht:

<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>Spring OpenEntityManagerInViewFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>HttpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>springSecurityFilterChain</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

Will man die Reihenfolge der Filter ändern, ist es wichtig, deren Bedeutung zu verstehen:

CharacterEncodingFilter - Setzt den Zeichensatz des Requests, falls der Browser ihn nicht mitsendet
OpenEntityManagerInViewFilter - nur in Verbindung mit Hibernate, setzt EntityManager in ThreadLocal (siehe Diskussion über Vor- und Nachteile)
HttpMethodFilter - Notwendig um bspw. PUT oder DELETE abbilden zu können
springSecurityFilterChain - muss nach HttpMethodFilter kommen, wenn auf HTTP-Method eingeschränkt wird
... ggf. weitere Filter

Damit Fehler in der Behandlung von Texten mit Sonderzeichen ausgeschlossen werden, sollte der "CharacterEncodingFilter" durchlaufen worden sein, bevor die Requestdaten in irgendeiner Form weiterverarbeitet werden.
Aus diesem Grund lautet die Empfehlung: das <filter-mapping> für den CharacterEncodingFilter muss in der "web.xml" an erster Stelle stehen (Erklärung siehe ROO-1698)!

Datenbankverbindung

Zu guter Letzt sollte sichergestellt werden, dass auch die Kommunikation mit der Datenbank über Unicode bzw. mit dem Standardzeichensatz UTF-8 geführt wird.

Kommt als Datenbank bspw. MySQL zum Einsatz, generiert Roo automatisch die Unicode-Unterstützung über folgende Konfiguration in der Datei "src/main/resources/META-INF/spring/database.properties":
database.url=jdbc:mysql://[YOUR_DB_SERVER]:3306/[YOUR_DB_NAME]?autoReconnect=true&useUnicode=true&characterEncoding=UTF-8

Fazit

Seit Version 1.1.1 verfügt Spring Roo über eine (bisher) fehlerfreie Unterstützung für Sonderzeichen, die bereits in diversen Sprachen getestet wurde.
Bei Fragen und Problemen findet man im Roo-Forum auf jeden Fall kompetente Hilfe.

Im Text verwendete, weiterführende Links

ROO-JIRA issues

Threads im ROO-Forum

Sonstige

Spring Roo ist ein Code-Generierungs-Werkzeug für die Softwareentwicklung, welches Entwickler in die Lage versetzt schnell und unkompliziert vorzeigbare Ergebnisse bspw. in Form von benutzbaren Prototypen zu liefern. Im Gegensatz zu anderen Werkzeugen, Frameworks und Tools entwickelt man mit Spring Roo zu 100% in Java.

Für die Anpassung oder Erweiterung von Roo bspw. durch eigene Add-Ons kann auf vorhandenes Java-Wissen und -Erfahrung aufgebaut werden. Unterstützt durch die geringen Einstiegshürden und die hohe Modularisierung, kann so jedes Projekt leicht an die ganz speziellen, individuellen Bedürfnisse angepasst und einmal geschriebene Komponenten oder Add-Ons wiederverwendet werden.

Update 12.02.2011 23:50h:

Frage eingearbeitet: "Setzt Roo diese Einstellungen automatisch oder muss man diese selbst anpassen?" - siehe Fazit
verschiedene Verbesserungsvorschläge eingearbeitet und Tippfehler korrigiert

Probleme beim Login ins Elster ePortal mit Mac OS X

2011-01-19T18:35:00.006+01:00

Ich hatte bis vor Kurzem einige Probleme, mich im Elster ePortal anzumelden. Im Folgenden will ich kurz den Fehler und die für mich funktionierende Lösung zeigen.

FEHLERBESCHREIBUNG

Wenn man auf der Startseite im linken Bereich den Punkt "Login > Software-Zertifikat" wählt und dann auf "Login" klickt, wird das Java Applet geladen und der grüne, sich drehende Kreis angezeigt. Es erscheint kein Popup, die Java-Konsole oder ähnliches!
Wirft man während dieser Wartezeit einen Blick in die sog. Fehlerkonsole des Browsers, so findet man die folgende Fehlermeldung:

Failed to load resource: https://www.elsteronline.de/eportal/

de.elster.portal.applet.ElsterAppletAnalyze.class the server

responded with a status of 404 (Not Found)

Ich vermutete zunächst, dass hier ein Problem mit der Codebase des Applets vorliegt. Die Kollegen verwenden interessanter Weise das veraltete <object>-Tag, anstatt das wesentlich angenehmere JavaScript (deployJava.js)* von Oracle/ Sun zu verwenden.

* Es gibt eine überarbeitete Version des JavaScript von Atlassian, die auch unter Opera läuft!

SYSTEMUMGEBUNG
Betriebssystem: Mac OS X 10.6.5
Java: 1.6.0_22
Browser: Safari 5.0.3 (6533.19.4)
Browser2: Firefox 4.0b7

RANDBEMERKUNG
Nach einer gewissen Zeit kommt anscheinend ein Timeout woraufhin eine neue Seite geöffnet und folgende Fehlermeldungen angezeigt werden.

Konfigurations-Assistent
Die Überprüfung der Konfiguration Ihres Computers wurde soeben durchgeführt.
Fehlende Voraussetzung

Java Sicherheitseinstellungen

Ihr System erfüllt nicht die grundlegenden Voraussetzungen zur Nutzung des ElsterOnline-Portals. Voraussetzung für die Nutzung von ElsterOnline ist die Einstellung AllPermissions in den Java-Sicherheitseinstellungen für signierte Applets.

Kein kompatibles Java-Plugin installiert

Ihr System erfüllt nicht die grundlegenden Voraussetzungen zur Nutzung des ElsterOnline-Portals. Wir empfehlen Ihnen, falls ElsterOnline dies für Ihr Betriebssystem unterstützt (siehe Anforderungen), das aktuelle Java Runtime Environment (JRE) zu installieren. Zum Download der neuesten Version der Java-Software rufen Sie bitte die Java-Homepage (http://www.java.com/de/) auf. Diese Seiten enthalten detaillierte Anweisungen zum Download und zur Installation der Java-Software (JRE).

Warnhinweis Nicht erkanntes Betriebssystem

Ihr Betriebssystem wurde nicht erkannt und wird möglicherweise von ElsterOnline nicht unterstützt. Eine Liste der von ElsterOnline unterstützten Betriebssysteme finden Sie unter Anforderungen. Die problemlose Nutzung von ElsterOnline kann mit Ihrem Betriebssystem möglich sein, selbst wenn es nicht in der Anforderungsliste aufgeführt ist. Dies wird jedoch nicht garantiert. Falls ein Problem auftritt, kann Sie die Hotline nur dann bei der Behebung unterstützen, falls Ihr Betriebssystem in der Anforderungsliste enthalten ist.

Randbemerkung:
Auf dem System war die aktuellste Java Version (siehe Versionsangabe oben) installiert und in den Anforderungen für Elster ist Mac OS X 10.6.5 mit JRE6+Safari5 als unterstützte Umgebung freigegeben.

Lösung: Neuinstallation

- Java for Mac OS X 10.6 Update 3 herunterladen (http://support.apple.com/kb/DL972)
- alle Anwendungen, die Java verwenden (z.B. auch Safari und Firefox) beenden
- das Java-Update installieren
- Safari neustarten und auf https://www.elsteronline.de/eportal/ leiten

...letztlich doch hier

2009-04-22T23:09:00.003+02:00

...eigentlich wollte ich mein Blog unbedingt auf meinem eigenen Server haben und hätte mir vor ein paar Wochen jemand gesagt, dass ich mal einem Dienst von Google freiwillig einige meiner Daten anvertrauen würde, hätte ich denjenigen wahrscheinlich für verrückt erklärt.

Naja, letztlich war der Reiz "blogger.com" mal auszuprobieren und die mangelnde Zeit mal eben ein eigenes Blog zu schreiben ausschlaggebend dafür, dass ich hiermit nun doch mein Blog bei Blogger.com eröffne.

Welcome everybody but please don't stare even though all walls are out of glass these days... "...and you'll find out why 1984 won't be like 1984" (http://www.youtube.com/watch?v=OYecfV3ubP8) - klar, aber vielleicht 25 Jahre später!?

In diesem Sinne, vergesst nicht, das Internet vergisst nichts!

Gruß
Alex