HADOOP-11870. [JDK8] AuthenticationFilter, CertificateUtil, SignerSecretProviders, KeyAuthorizationKeyProvider Javadoc issues (rkanter)

(cherry picked from commit 9fec02c069)
This commit is contained in:
Robert Kanter 2015-04-27 13:25:11 -07:00
parent de85ff58dc
commit f00815ac8a
7 changed files with 23 additions and 6 deletions

View File

@ -589,6 +589,13 @@ public class AuthenticationFilter implements Filter {
/** /**
* Delegates call to the servlet filter chain. Sub-classes my override this * Delegates call to the servlet filter chain. Sub-classes my override this
* method to perform pre and post tasks. * method to perform pre and post tasks.
*
* @param filterChain the filter chain object.
* @param request the request object.
* @param response the response object.
*
* @throws IOException thrown if an IO error occurred.
* @throws ServletException thrown if a processing error occurred.
*/ */
protected void doFilter(FilterChain filterChain, HttpServletRequest request, protected void doFilter(FilterChain filterChain, HttpServletRequest request,
HttpServletResponse response) throws IOException, ServletException { HttpServletResponse response) throws IOException, ServletException {
@ -598,9 +605,15 @@ public class AuthenticationFilter implements Filter {
/** /**
* Creates the Hadoop authentication HTTP cookie. * Creates the Hadoop authentication HTTP cookie.
* *
* @param resp the response object.
* @param token authentication token for the cookie. * @param token authentication token for the cookie.
* @param domain the cookie domain.
* @param path the cokie path.
* @param expires UNIX timestamp that indicates the expire date of the * @param expires UNIX timestamp that indicates the expire date of the
* cookie. It has no effect if its value < 0. * cookie. It has no effect if its value < 0.
* @param isSecure is the cookie secure?
* @param token the token.
* @param expires the cookie expiration time.
* *
* XXX the following code duplicate some logic in Jetty / Servlet API, * XXX the following code duplicate some logic in Jetty / Servlet API,
* because of the fact that Hadoop is stuck at servlet 2.5 and jetty 6 * because of the fact that Hadoop is stuck at servlet 2.5 and jetty 6

View File

@ -36,7 +36,8 @@ public class CertificateUtil {
* *
* @param pem * @param pem
* - the pem encoding from config without the header and footer * - the pem encoding from config without the header and footer
* @return RSAPublicKey * @return RSAPublicKey the RSA public key
* @throws ServletException thrown if a processing error occurred
*/ */
public static RSAPublicKey parseRSAPublicKey(String pem) throws ServletException { public static RSAPublicKey parseRSAPublicKey(String pem) throws ServletException {
String fullPem = PEM_HEADER + pem + PEM_FOOTER; String fullPem = PEM_HEADER + pem + PEM_FOOTER;

View File

@ -61,7 +61,7 @@ public abstract class RolloverSignerSecretProvider
* @param config configuration properties * @param config configuration properties
* @param servletContext servlet context * @param servletContext servlet context
* @param tokenValidity The amount of time a token is valid for * @param tokenValidity The amount of time a token is valid for
* @throws Exception * @throws Exception thrown if an error occurred
*/ */
@Override @Override
public void init(Properties config, ServletContext servletContext, public void init(Properties config, ServletContext servletContext,

View File

@ -34,7 +34,7 @@ public abstract class SignerSecretProvider {
* @param config configuration properties * @param config configuration properties
* @param servletContext servlet context * @param servletContext servlet context
* @param tokenValidity The amount of time a token is valid for * @param tokenValidity The amount of time a token is valid for
* @throws Exception * @throws Exception thrown if an error occurred
*/ */
public abstract void init(Properties config, ServletContext servletContext, public abstract void init(Properties config, ServletContext servletContext,
long tokenValidity) throws Exception; long tokenValidity) throws Exception;

View File

@ -377,7 +377,7 @@ public class ZKSignerSecretProvider extends RolloverSignerSecretProvider {
* This method creates the Curator client and connects to ZooKeeper. * This method creates the Curator client and connects to ZooKeeper.
* @param config configuration properties * @param config configuration properties
* @return A Curator client * @return A Curator client
* @throws Exception * @throws Exception thrown if an error occurred
*/ */
protected CuratorFramework createCuratorClient(Properties config) protected CuratorFramework createCuratorClient(Properties config)
throws Exception { throws Exception {

View File

@ -118,6 +118,9 @@ Release 2.8.0 - UNRELEASED
HADOOP-11876. Refactor code to make it more readable, minor HADOOP-11876. Refactor code to make it more readable, minor
maybePrintStats bug (Zoran Dimitrijevic via raviprak) maybePrintStats bug (Zoran Dimitrijevic via raviprak)
HADOOP-11870. [JDK8] AuthenticationFilter, CertificateUtil,
SignerSecretProviders, KeyAuthorizationKeyProvider Javadoc issues (rkanter)
Release 2.7.1 - UNRELEASED Release 2.7.1 - UNRELEASED
INCOMPATIBLE CHANGES INCOMPATIBLE CHANGES

View File

@ -93,8 +93,8 @@ public class KeyAuthorizationKeyProvider extends KeyProviderCryptoExtension {
* The constructor takes a {@link KeyProviderCryptoExtension} and an * The constructor takes a {@link KeyProviderCryptoExtension} and an
* implementation of <code>KeyACLs</code>. All calls are delegated to the * implementation of <code>KeyACLs</code>. All calls are delegated to the
* provider keyProvider after authorization check (if required) * provider keyProvider after authorization check (if required)
* @param keyProvider * @param keyProvider the key provider
* @param acls * @param acls the Key ACLs
*/ */
public KeyAuthorizationKeyProvider(KeyProviderCryptoExtension keyProvider, public KeyAuthorizationKeyProvider(KeyProviderCryptoExtension keyProvider,
KeyACLs acls) { KeyACLs acls) {