diff --git a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/ResetPasswordServlet.java b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/ResetPasswordServlet.java index 736874c0abb78b06b9d1491f0c14495ce28358eb..2df6cae42703acb5ed5404183fbd2c4242bbdbc3 100644 --- a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/ResetPasswordServlet.java +++ b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/ResetPasswordServlet.java @@ -130,6 +130,7 @@ public class ResetPasswordServlet extends HttpServlet * using input parameters read from it. Users who do augment * subject calls are constructed by taking the principals out of the ServletConfig * input parameter. + * </p> * * <p> * The ResetPasswordServlet configuration in the web deployment descriptor file @@ -137,13 +138,14 @@ public class ResetPasswordServlet extends HttpServlet * <ul> * <li><code>ca.nrc.cadc.ac.server.web.ResetPasswordServlet.PrivilegedX500Principals</code> * is a list of trusted administrators DNs. It is a multi-line list with - * line breaks between the trusted DNs and each DN eclosed in double quotes. + * line breaks between the trusted DNs and each DN eclosed in double quotes.</li> * <li><code>ca.nrc.cadc.ac.server.web.ResetPasswordServlet.PrivilegedHttpPrincipals</code> * is a list of space separated userids (HTTP identities) corresponding - * to the previous DNs. + * to the previous DNs.</li> * </ul> * The two lists of principal names must be of the same * length and correspond to each other in order. + * </p> * * @param config The servlet configuration object. * @param response The HTTP Response. diff --git a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/UserRequestServlet.java b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/UserRequestServlet.java index 62f087fd97374c977086c9196a8696fe86270f70..4772667db8198756aeffbf567b1d7adc4edd0b8b 100644 --- a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/UserRequestServlet.java +++ b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/UserRequestServlet.java @@ -118,6 +118,7 @@ public class UserRequestServlet extends HttpServlet * using input parameters read from it. Users who do augment * subject calls are constructed by taking the principals out of the ServletConfig * input parameter. + * </p> * * <p> * The UserRequestServlet in the web deployment descriptor file @@ -125,13 +126,14 @@ public class UserRequestServlet extends HttpServlet * <ul> * <li><code>ca.nrc.cadc.ac.server.web.UserRequestServlet.PrivilegedX500Principals</code> * is a list of trusted administrators DNs. It is a multi-line list with - * line breaks between the trusted DNs and each DN eclosed in double quotes. + * line breaks between the trusted DNs and each DN eclosed in double quotes.</li> * <li><code>ca.nrc.cadc.ac.server.web.UserRequestServlet.PrivilegedHttpPrincipals</code> * is a list of space separated userids (HTTP identities) corresponding - * to the previous DNs. + * to the previous DNs.</li> * </ul> * The two lists of principal names must be of the same * length and correspond to each other in order. + * </p> * * @param config The servlet configuration object. * @param response The HTTP Response. diff --git a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/UserServlet.java b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/UserServlet.java index d3b2a0bc1e6f416665066015bc3cd7868d87022e..72d1bdbcc9cf0c36c75e9463f3f5ccddf491d9ab 100644 --- a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/UserServlet.java +++ b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/web/UserServlet.java @@ -109,7 +109,37 @@ public class UserServlet extends HttpServlet protected List<Subject> privilegedSubjects; private UserPersistence userPersistence; - + + /** + * Servlet initialization method. + * + * <p> + * Receives the servlet configuration object and initializes UserPersistence + * using input parameters read from it. Users who do augment + * subject calls are constructed by taking the principals out of the ServletConfig + * input parameter. + * </p> + * + * <p> + * The UserServlet configuration in the web deployment descriptor file + * <code>web.xml</code> must have two input parameters: + * <ul> + * <li><code>ca.nrc.cadc.ac.server.web.UserServlet.PrivilegedX500Principals</code> + * is a list of trusted administrators DNs. It is a multi-line list with + * line breaks between the trusted DNs and each DN eclosed in double quotes.</li> + * <li><code>ca.nrc.cadc.ac.server.web.UserServlet.PrivilegedHttpPrincipals</code> + * is a list of space separated userids (HTTP identities) corresponding + * to the previous DNs.</li> + * </ul> + * The two lists of principal names must be of the same + * length and correspond to each other in order. + * </p> + * + * @param config The servlet configuration object. + * @param response The HTTP Response. + * + * @throws javax.servlet.ServletException For general Servlet exceptions. + */ @Override public void init(ServletConfig config) throws ServletException {