From f8dc86f1b362c2906ea302eb56928b59156cd484 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 27 Jul 2011 09:40:57 -0400
Subject: [PATCH] Renamed README for GutHub.
---
src/com/gitblit/AccessRestrictionFilter.java | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++-------
1 files changed, 53 insertions(+), 7 deletions(-)
diff --git a/src/com/gitblit/AccessRestrictionFilter.java b/src/com/gitblit/AccessRestrictionFilter.java
index 625eaa9..6ec70db 100644
--- a/src/com/gitblit/AccessRestrictionFilter.java
+++ b/src/com/gitblit/AccessRestrictionFilter.java
@@ -42,8 +42,18 @@
import com.gitblit.utils.StringUtils;
/**
+ * The AccessRestrictionFilter is a servlet filter that preprocesses requests
+ * that match its url pattern definition in the web.xml file.
+ *
+ * The filter extracts the name of the repository from the url and determines if
+ * the requested action for the repository requires a Basic authentication
+ * prompt. If authentication is required and no credentials are stored in the
+ * "Authorization" header, then a basic authentication challenge is issued.
*
* http://en.wikipedia.org/wiki/Basic_access_authentication
+ *
+ * @author James Moger
+ *
*/
public abstract class AccessRestrictionFilter implements Filter {
@@ -59,15 +69,48 @@
logger = LoggerFactory.getLogger(getClass());
}
+ /**
+ * Extract the repository name from the url.
+ *
+ * @param url
+ * @return repository name
+ */
protected abstract String extractRepositoryName(String url);
- protected abstract String getUrlRequestType(String url);
+ /**
+ * Analyze the url and returns the action of the request.
+ *
+ * @param url
+ * @return action of the request
+ */
+ protected abstract String getUrlRequestAction(String url);
+ /**
+ * Determine if the repository requires authentication.
+ *
+ * @param repository
+ * @return true if authentication required
+ */
protected abstract boolean requiresAuthentication(RepositoryModel repository);
- protected abstract boolean canAccess(RepositoryModel repository, UserModel user,
- String restrictedUrl);
+ /**
+ * Determine if the user can access the repository and perform the specified
+ * action.
+ *
+ * @param repository
+ * @param user
+ * @param action
+ * @return true if user may execute the action on the repository
+ */
+ protected abstract boolean canAccess(RepositoryModel repository, UserModel user, String action);
+ /**
+ * doFilter does the actual work of preprocessing the request to ensure that
+ * the user may proceed.
+ *
+ * @see javax.servlet.Filter#doFilter(javax.servlet.ServletRequest,
+ * javax.servlet.ServletResponse, javax.servlet.FilterChain)
+ */
@Override
public void doFilter(final ServletRequest request, final ServletResponse response,
final FilterChain chain) throws IOException, ServletException {
@@ -98,7 +141,7 @@
// Determine if the request URL is restricted
String fullSuffix = fullUrl.substring(repository.length());
- String urlRequestType = getUrlRequestType(fullSuffix);
+ String urlRequestType = getUrlRequestAction(fullSuffix);
// Load the repository model
RepositoryModel model = GitBlit.self().getRepositoryModel(repository);
@@ -118,9 +161,6 @@
String base64Credentials = authorization.substring(BASIC.length()).trim();
String credentials = new String(Base64.decode(base64Credentials),
Charset.forName("UTF-8"));
- if (GitBlit.isDebugMode()) {
- logger.info(MessageFormat.format("AUTH: {0} ({1})", authorization, credentials));
- }
// credentials = username:password
final String[] values = credentials.split(":");
@@ -200,10 +240,16 @@
}
}
+ /**
+ * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
+ */
@Override
public void init(final FilterConfig config) throws ServletException {
}
+ /**
+ * @see javax.servlet.Filter#destroy()
+ */
@Override
public void destroy() {
}
--
Gitblit v1.9.1