From 9ed85b5c9cfa316a525a2f9c7dc5b1c8c6bcee31 Mon Sep 17 00:00:00 2001
From: Jakub Holy <jakub.holy@iterate.no>
Date: Fri, 5 Oct 2012 13:57:53 +0200
Subject: [PATCH] A3: Fixed docs wrt bakksjo's comments

---
 a3/README.md                                      |  3 +--
 .../cloudname/a3/jaxrs/JerseyRequestFilter.java   | 15 +++++++--------
 2 files changed, 8 insertions(+), 10 deletions(-)

diff --git a/a3/README.md b/a3/README.md
index 0de83df2..e9ebb1d4 100644
--- a/a3/README.md
+++ b/a3/README.md
@@ -11,8 +11,7 @@ name, password, role(s), custom properties and more.
 Standalone use
 --------------
 
-    org.cloudname.a3.A3Client a3Client = ...;
-    if (a3Client.authenticate("user", "psw").isOk) ...;
+See `/a3/src/test/java/org/cloudname/a3/A3ClientTest.java` for examples.
 
 Use with Jersey
 ---------------
diff --git a/a3/src/main/java/org/cloudname/a3/jaxrs/JerseyRequestFilter.java b/a3/src/main/java/org/cloudname/a3/jaxrs/JerseyRequestFilter.java
index 0cfd11a0..da518cc3 100644
--- a/a3/src/main/java/org/cloudname/a3/jaxrs/JerseyRequestFilter.java
+++ b/a3/src/main/java/org/cloudname/a3/jaxrs/JerseyRequestFilter.java
@@ -1,24 +1,23 @@
 package org.cloudname.a3.jaxrs;
 
+import com.sun.jersey.api.container.MappableContainerException;
+import com.sun.jersey.core.util.Base64;
+import com.sun.jersey.spi.container.ContainerRequest;
+import com.sun.jersey.spi.container.ContainerRequestFilter;
+
 import java.security.Principal;
 
 import javax.ws.rs.core.Context;
 import javax.ws.rs.core.SecurityContext;
 import javax.ws.rs.core.UriInfo;
-import javax.ws.rs.ext.Provider;
 
 import org.cloudname.a3.A3Client;
 import org.cloudname.a3.A3Principal;
 import org.cloudname.a3.AuthnResult;
 import org.cloudname.a3.domain.User;
 
-import com.sun.jersey.api.container.MappableContainerException;
-import com.sun.jersey.core.util.Base64;
-import com.sun.jersey.spi.container.ContainerRequest;
-import com.sun.jersey.spi.container.ContainerRequestFilter;
-
 /**
- * Check the authentication header and set user principal on the request's security contexts
+ * Checks the authentication header and sets user principal on the request's security contexts
  * according to it. It can be then accessed in REST resources via
  * <code>@Context SecurityContext sc</code> or used to limit access to them based on
  * the user's roles and <code>@RolesAllowed</code> in cooperation with
@@ -30,7 +29,7 @@
  *
  * <h4>Dependencies</h4>
  * The filter expects an {@link A3Client} instance to be provided by Jersey. For that to work
- * you need to have a {@link Provider} creating it available somewhere where Jersey can
+ * you need to have a @{@link javax.ws.rs.ext.Provider.Provider} creating it available somewhere where Jersey can
  * find it.
  *
  * <h4>Configuration</h4>