Author: [email protected]
Date: Tue Jun 14 14:10:57 2011
New Revision: 1177
Log:
AMDATU-283 Added additional javadoc to public interface methods
Modified:
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/MimeTypeResolver.java
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/ResourceProvider.java
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/SecurityHandler.java
Modified:
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/MimeTypeResolver.java
==============================================================================
---
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/MimeTypeResolver.java
(original)
+++
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/MimeTypeResolver.java
Tue Jun 14 14:10:57 2011
@@ -21,5 +21,13 @@
*/
public interface MimeTypeResolver {
+ /**
+ * Maps a name to a MIME type.
+ *
+ * @param determine
+ * the MIME type for this name.
+ * @return MIME type (e.g. text/html) of the name or null to indicate
that
+ * the caller should determine the MIME type itself.
+ */
String getMimetype(String name);
}
Modified:
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/ResourceProvider.java
==============================================================================
---
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/ResourceProvider.java
(original)
+++
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/ResourceProvider.java
Tue Jun 14 14:10:57 2011
@@ -23,5 +23,13 @@
*/
public interface ResourceProvider {
+ /**
+ * Maps a resource name to a URL.
+ *
+ * @param the
+ * name of the requested resource
+ * @return URL that HttpContext can use to read the resource or null if
the
+ * resource does not exist.
+ */
URL getResource(String name);
}
Modified:
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/SecurityHandler.java
==============================================================================
---
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/SecurityHandler.java
(original)
+++
trunk/amdatu-web/httpcontext/src/main/java/org/amdatu/web/httpcontext/SecurityHandler.java
Tue Jun 14 14:10:57 2011
@@ -26,6 +26,20 @@
*/
public interface SecurityHandler {
- boolean handleSecurity(HttpServletRequest httpServletRequest,
HttpServletResponse httpServletResponse)
- throws IOException;
+ /**
+ * Handles security for the specified request. This method controls
whether
+ * the request is processed in the normal manner or an error is
returned.
+ *
+ * @param httpServletRequest
+ * the HTTP request
+ * @param httpServletResponse
+ * the HTTP response
+ * @return true if the request should be serviced, false if the request
+ * should not be serviced.
+ * @throws IOException
+ * may be thrown by this method. If this occurs, the
request is
+ * terminated and socket closed.
+ */
+ boolean handleSecurity(HttpServletRequest httpServletRequest,
+ HttpServletResponse httpServletResponse) throws
IOException;
}
_______________________________________________
Amdatu-commits mailing list
[email protected]
http://lists.amdatu.org/mailman/listinfo/amdatu-commits
