- Renamed Directory#setAlphaComparator and setAlphaNumComparator

Jerome Louvel · Jerome Louvel · commit bb2d798b74d6 · 2012-06-04T11:47:45.000+02:00
methods into useAlphaComparator and useAlphaNumComparator with
         proper deprecation. Suggested by Tim Peierls.
 - Updated book examples
diff --git a/build/tmpl/text/changes.txt b/build/tmpl/text/changes.txt
@@ -6,6 +6,9 @@ Changes log
 - @version-full@ (@release-date@)
     - Bug fixed
     - API changes
+       - Renamed Directory#setAlphaComparator and setAlphaNumComparator
+         methods into useAlphaComparator and useAlphaNumComparator with
+         proper deprecation. Suggested by Tim Peierls.
     - Misc
        - Reverted Role equality test to default Java object equality as
          equality based on name could cause issues with MemoryRealm
@@ -28,7 +31,7 @@ Changes log
        - Fixed retrieval of SSL cipher suites and client certificates
          for the internal HTTP client.
        - Fixed security bug in the XML extension that allows XML external 
-         entity attacks. Reported by Nicolas Gr�goire, 
+         entity attacks. Reported by Nicolas Gr�goire, 
          Caleb James DeLisle and Fabio Mancinelli.
     - API changes
        - Renamed ReadableListener into ReadingListener
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub1/Mail.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub1/Mail.java
@@ -36,7 +36,7 @@
 /**
  * The mail representation bean.
  */
-public class MailRepresentation {
+public class Mail {
 
     private String status;
 
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub1/MailClient.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub1/MailClient.java
@@ -44,9 +44,11 @@ public class MailClient {
     public static void main(String[] args) throws Exception {
         ClientResource mailClient = new ClientResource(
                 "http://localhost:8111/accounts/123/mails/abc");
+
         Form form = new Form();
-        form.add("subject", "Message to J�r�me");
+        form.add("subject", "Message to Jérôme");
         form.add("content", "Doh!\n\nAllo?");
+        System.out.println(form.getWebRepresentation());
         mailClient.put(form).write(System.out);
     }
 
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub1/MailServerApplication.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub1/MailServerApplication.java
@@ -34,8 +34,8 @@
 package org.restlet.example.book.restlet.ch07.sec1.sub1;
 
 import org.restlet.Application;
+import org.restlet.Component;
 import org.restlet.Restlet;
-import org.restlet.Server;
 import org.restlet.data.Protocol;
 import org.restlet.routing.Router;
 
@@ -52,8 +52,10 @@ public class MailServerApplication extends Application {
      * @throws Exception
      */
     public static void main(String[] args) throws Exception {
-        Server mailServer = new Server(Protocol.HTTP, 8111);
-        mailServer.setNext(new MailServerApplication());
+        Component mailServer = new Component();
+        mailServer.getClients().add(Protocol.CLAP);
+        mailServer.getServers().add(Protocol.HTTP, 8111);
+        mailServer.getDefaultHost().attach(new MailServerApplication());
         mailServer.start();
     }
 
@@ -63,8 +65,7 @@ public static void main(String[] args) throws Exception {
     @Override
     public Restlet createInboundRoot() {
         Router router = new Router(getContext());
-        router.attach(
-                "http://localhost:8111/accounts/{accountId}/mails/{mailId}",
+        router.attach("/accounts/{accountId}/mails/{mailId}",
                 MailServerResource.class);
         return router;
     }
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub1/MailServerResource.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub1/MailServerResource.java
@@ -40,8 +40,9 @@
 import org.restlet.data.Reference;
 import org.restlet.ext.freemarker.TemplateRepresentation;
 import org.restlet.representation.Representation;
-import org.restlet.representation.StringRepresentation;
 import org.restlet.resource.ClientResource;
+import org.restlet.resource.Get;
+import org.restlet.resource.Put;
 import org.restlet.resource.ResourceException;
 import org.restlet.resource.ServerResource;
 
@@ -51,10 +52,10 @@
  */
 public class MailServerResource extends ServerResource {
 
-    @Override
-    protected Representation get() throws ResourceException {
-        // Create the mail representation bean
-        MailRepresentation mail = new MailRepresentation();
+    @Get
+    public Representation toHtml() throws ResourceException {
+        // Create the mail bean
+        Mail mail = new Mail();
         mail.setStatus("received");
         mail.setSubject("Message to self");
         mail.setContent("Doh!");
@@ -70,20 +71,12 @@ protected Representation get() throws ResourceException {
         return new TemplateRepresentation(mailFtl, mail, MediaType.TEXT_HTML);
     }
 
-    @Override
-    protected Representation put(Representation input) {
-        try {
-            String inputText = input.getText();
-            System.out.println(inputText);
-            Form form = new Form(inputText);
-
-            for (Parameter entry : form) {
-                System.out.println(entry.getName() + "=" + entry.getValue());
-            }
-        } catch (Exception e) {
-            e.printStackTrace();
+    @Put
+    public String store(Form form) {
+        for (Parameter entry : form) {
+            System.out.println(entry.getName() + "=" + entry.getValue());
         }
 
-        return new StringRepresentation("Mail updated!");
+        return "Mail updated!";
     }
 }
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/CookieAuthenticator.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/CookieAuthenticator.java
@@ -51,6 +51,11 @@
 import org.restlet.security.ChallengeAuthenticator;
 import org.restlet.security.Verifier;
 
+/**
+ * Naive implementation of a cookie authenticator.
+ * 
+ * @author Jerome Louvel
+ */
 public class CookieAuthenticator extends ChallengeAuthenticator {
 
     public CookieAuthenticator(Context context, boolean optional, String realm) {
@@ -66,6 +71,25 @@ public CookieAuthenticator(Context context, String realm) {
         super(context, ChallengeScheme.HTTP_COOKIE, realm);
     }
 
+    @Override
+    protected void afterHandle(Request request, Response response) {
+        super.afterHandle(request, response);
+        Cookie cookie = request.getCookies().getFirst("Credentials");
+
+        if (request.getClientInfo().isAuthenticated() && (cookie == null)) {
+            String identifier = request.getChallengeResponse().getIdentifier();
+            String secret = new String(request.getChallengeResponse()
+                    .getSecret());
+            CookieSetting cookieSetting = new CookieSetting("Credentials",
+                    identifier + "=" + secret);
+            cookieSetting.setAccessRestricted(true);
+            cookieSetting.setPath("/");
+            cookieSetting.setComment("Unsecured cookie based authentication");
+            cookieSetting.setMaxAge(30);
+            response.getCookieSettings().add(cookieSetting);
+        }
+    }
+
     @Override
     protected int beforeHandle(Request request, Response response) {
         Cookie cookie = request.getCookies().getFirst("Credentials");
@@ -110,23 +134,4 @@ public void challenge(Response response, boolean stale) {
         response.setStatus(Status.CLIENT_ERROR_UNAUTHORIZED);
     }
 
-    @Override
-    protected void afterHandle(Request request, Response response) {
-        super.afterHandle(request, response);
-        Cookie cookie = request.getCookies().getFirst("Credentials");
-
-        if (request.getClientInfo().isAuthenticated() && (cookie == null)) {
-            String identifier = request.getChallengeResponse().getIdentifier();
-            String secret = new String(request.getChallengeResponse()
-                    .getSecret());
-            CookieSetting cookieSetting = new CookieSetting("Credentials",
-                    identifier + "=" + secret);
-            cookieSetting.setAccessRestricted(true);
-            cookieSetting.setPath("/");
-            cookieSetting.setComment("Unsecured cookie based authentication");
-            cookieSetting.setMaxAge(30);
-            response.getCookieSettings().add(cookieSetting);
-        }
-    }
-
 }
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/Mail.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/Mail.java
@@ -36,7 +36,7 @@
 /**
  * The mail representation bean.
  */
-public class MailRepresentation {
+public class Mail {
 
     private String status;
 
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/MailClient.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/MailClient.java
@@ -46,11 +46,12 @@ public static void main(String[] args) throws Exception {
         ClientResource mailClient = new ClientResource(
                 "http://localhost:8111/accounts/123/mails/abc");
         mailClient.getRequest().getCookies()
-                .add(new Cookie("Credentials", "scott=tiger"));
+                .add(new Cookie("Credentials", "chunkylover53=pwd"));
 
         Form form = new Form();
-        form.add("subject", "Message to J�r�me");
+        form.add("subject", "Message to Jérôme");
         form.add("content", "Doh!\n\nAllo?");
+        System.out.println(form.getWebRepresentation());
         mailClient.put(form).write(System.out);
     }
 
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/MailServerApplication.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/MailServerApplication.java
@@ -69,7 +69,7 @@ public Restlet createInboundRoot() {
                 MailServerResource.class);
 
         MapVerifier verifier = new MapVerifier();
-        verifier.getLocalSecrets().put("scott", "tiger".toCharArray());
+        verifier.getLocalSecrets().put("chunkylover53", "pwd".toCharArray());
 
         CookieAuthenticator authenticator = new CookieAuthenticator(
                 getContext(), "Cookie Test");
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/MailServerResource.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub2/MailServerResource.java
@@ -40,8 +40,9 @@
 import org.restlet.data.Reference;
 import org.restlet.ext.freemarker.TemplateRepresentation;
 import org.restlet.representation.Representation;
-import org.restlet.representation.StringRepresentation;
 import org.restlet.resource.ClientResource;
+import org.restlet.resource.Get;
+import org.restlet.resource.Put;
 import org.restlet.resource.ResourceException;
 import org.restlet.resource.ServerResource;
 
@@ -51,10 +52,10 @@
  */
 public class MailServerResource extends ServerResource {
 
-    @Override
-    protected Representation get() throws ResourceException {
+    @Get
+    public Representation toHtml() throws ResourceException {
         // Create the mail bean
-        MailRepresentation mail = new MailRepresentation();
+        Mail mail = new Mail();
         mail.setStatus("received");
         mail.setSubject("Message to self");
         mail.setContent("Doh!");
@@ -67,24 +68,15 @@ protected Representation get() throws ResourceException {
                         + "/Mail.ftl").get();
 
         // Wraps the bean with a FreeMarker representation
-        return new TemplateRepresentation(mailFtl,
-                mail, MediaType.TEXT_HTML);
+        return new TemplateRepresentation(mailFtl, mail, MediaType.TEXT_HTML);
     }
 
-    @Override
-    protected Representation put(Representation input) {
-        try {
-            String inputText = input.getText();
-            System.out.println(inputText);
-            Form form = new Form(inputText);
-
-            for (Parameter entry : form) {
-                System.out.println(entry.getName() + "=" + entry.getValue());
-            }
-        } catch (Exception e) {
-            e.printStackTrace();
+    @Put
+    public String store(Form form) {
+        for (Parameter entry : form) {
+            System.out.println(entry.getName() + "=" + entry.getValue());
         }
 
-        return new StringRepresentation("Mail updated!");
+        return "Mail updated!";
     }
 }
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub5/Mail.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub5/Mail.java
@@ -36,7 +36,7 @@
 /**
  * The mail representation bean.
  */
-public class MailRepresentation {
+public class Mail {
 
     private String status;
 
diff --git a/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub5/MailServerResource.java b/modules/org.restlet.example/src/org/restlet/example/book/restlet/ch07/sec1/sub5/MailServerResource.java
@@ -58,7 +58,7 @@ public class MailServerResource extends ServerResource {
     @Override
     protected Representation get() throws ResourceException {
         // Create the mail bean
-        MailRepresentation mail = new MailRepresentation();
+        Mail mail = new Mail();
         mail.setStatus("received");
         mail.setSubject("Message to self");
         mail.setContent("Doh!");
diff --git a/modules/org.restlet/src/org/restlet/resource/Directory.java b/modules/org.restlet/src/org/restlet/resource/Directory.java
@@ -291,9 +291,11 @@ public boolean isNegotiatingContent() {
      * Sets the reference comparator based on classic alphabetical order.
      * 
      * @see #setComparator(Comparator)
+     * @deprecated Call {@link #useAlphaComparator()} instead
      */
+    @Deprecated
     public void setAlphaComparator() {
-        setComparator(new AlphabeticalComparator());
+        useAlphaComparator();
     }
 
     /**
@@ -305,8 +307,33 @@ public void setAlphaComparator() {
      * @see <a href="http://www.davekoelle.com/alphanum.html">The original
      *      Alphanum Algorithm from David Koelle</a>
      * @see #setComparator(Comparator)
+     * @deprecated Call {@link #useAlphaComparator()} instead
      */
+    @Deprecated
     public void setAlphaNumComparator() {
+        useAlphaNumComparator();
+    }
+
+    /**
+     * Sets the reference comparator based on classic alphabetical order.
+     * 
+     * @see #setComparator(Comparator)
+     */
+    public void useAlphaComparator() {
+        setComparator(new AlphabeticalComparator());
+    }
+
+    /**
+     * Sets the reference comparator based on the more friendly "Alphanum
+     * Algorithm" created by David Koelle. The internal implementation used is
+     * based on an optimized public domain implementation provided by Rob
+     * Heittman from the Solertium Corporation.
+     * 
+     * @see <a href="http://www.davekoelle.com/alphanum.html">The original
+     *      Alphanum Algorithm from David Koelle</a>
+     * @see #setComparator(Comparator)
+     */
+    public void useAlphaNumComparator() {
         setComparator(new AlphabeticalComparator());
     }
 
