Added comments & updated code structure.
Change-Id: I2ff7adb2954b87e8345a6e0619b14614883c4200
diff --git a/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/OAuth2RevokeTokenSuperRequest.java b/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/OAuth2RevokeTokenSuperRequest.java
index 183d2a3..347a233 100644
--- a/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/OAuth2RevokeTokenSuperRequest.java
+++ b/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/OAuth2RevokeTokenSuperRequest.java
@@ -5,12 +5,20 @@
import javax.servlet.http.HttpServletRequest;
+import org.apache.oltu.oauth2.as.request.OAuthRequest;
import org.apache.oltu.oauth2.common.OAuth;
import org.apache.oltu.oauth2.common.exception.OAuthProblemException;
import org.apache.oltu.oauth2.common.exception.OAuthSystemException;
import org.apache.oltu.oauth2.common.utils.OAuthUtils;
import org.apache.oltu.oauth2.common.validators.OAuthValidator;
+/**
+ * A custom request based on {@link OAuthRequest}. It defines token
+ * revocation request that should have been sent from a super client.
+ *
+ * @author margaretha
+ *
+ */
public class OAuth2RevokeTokenSuperRequest {
protected HttpServletRequest request;
protected OAuthValidator<HttpServletRequest> validator;
@@ -49,13 +57,13 @@
public String getClientId () {
return request.getParameter(OAuth.OAUTH_CLIENT_ID);
}
-
+
public String getSuperClientId () {
return request.getParameter(RevokeTokenSuperValidator.SUPER_CLIENT_ID);
}
-
+
public String getSuperClientSecret () {
- return request.getParameter(RevokeTokenSuperValidator.
- SUPER_CLIENT_SECRET);
+ return request
+ .getParameter(RevokeTokenSuperValidator.SUPER_CLIENT_SECRET);
}
}
diff --git a/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/RevokeTokenSuperValidator.java b/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/RevokeTokenSuperValidator.java
index 650e8a5..454f0e5 100644
--- a/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/RevokeTokenSuperValidator.java
+++ b/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/RevokeTokenSuperValidator.java
@@ -12,6 +12,13 @@
import de.ids_mannheim.korap.oauth2.constant.OAuth2Error;
+/**
+ * Defines required request parameters for
+ * OAuth2RevokeTokenSuperRequest and validates the request method.
+ *
+ * @author margaretha
+ *
+ */
public class RevokeTokenSuperValidator
extends AbstractValidator<HttpServletRequest> {
@@ -42,12 +49,10 @@
if (enforceClientAuthentication) {
Set<String> missingParameters = new HashSet<String>();
- if (OAuthUtils
- .isEmpty(request.getParameter(SUPER_CLIENT_ID))) {
+ if (OAuthUtils.isEmpty(request.getParameter(SUPER_CLIENT_ID))) {
missingParameters.add(SUPER_CLIENT_ID);
}
- if (OAuthUtils
- .isEmpty(request.getParameter(SUPER_CLIENT_SECRET))) {
+ if (OAuthUtils.isEmpty(request.getParameter(SUPER_CLIENT_SECRET))) {
missingParameters.add(SUPER_CLIENT_SECRET);
}
diff --git a/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/service/OltuTokenService.java b/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/service/OltuTokenService.java
index a88355e..f7d6405 100644
--- a/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/service/OltuTokenService.java
+++ b/full/src/main/java/de/ids_mannheim/korap/oauth2/oltu/service/OltuTokenService.java
@@ -34,6 +34,11 @@
import de.ids_mannheim.korap.oauth2.oltu.OAuth2RevokeTokenSuperRequest;
import de.ids_mannheim.korap.oauth2.service.OAuth2TokenService;
+/** Implementation of token service using Apache Oltu.
+ *
+ * @author margaretha
+ *
+ */
@Service
public class OltuTokenService extends OAuth2TokenService {