This is an automated email from the ASF dual-hosted git repository. markt pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/master by this push: new b0501de Add some Javadoc to silence some IDE warnings b0501de is described below commit b0501defa27d8b17a9d132089cc24f74041ce668 Author: Mark Thomas <ma...@apache.org> AuthorDate: Tue Jan 14 17:49:43 2020 +0000 Add some Javadoc to silence some IDE warnings --- .../apache/catalina/realm/GenericPrincipal.java | 51 ++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/java/org/apache/catalina/realm/GenericPrincipal.java b/java/org/apache/catalina/realm/GenericPrincipal.java index 560b123..3774f6a 100644 --- a/java/org/apache/catalina/realm/GenericPrincipal.java +++ b/java/org/apache/catalina/realm/GenericPrincipal.java @@ -60,6 +60,16 @@ public class GenericPrincipal implements TomcatPrincipal, Serializable { this(name, roles, null); } + /** + * Construct a new Principal, associated with the specified Realm, for the + * specified username, with the specified role names (as Strings). + * + * @param name The username of the user represented by this Principal + * @param password Unused + * @param roles List of roles (must be Strings) possessed by this user + * + * @deprecated This method will be removed in Tomcat 10.0.1 onwards + */ @Deprecated public GenericPrincipal(String name, String password, List<String> roles) { this(name, roles, null); @@ -79,6 +89,18 @@ public class GenericPrincipal implements TomcatPrincipal, Serializable { this(name, roles, userPrincipal, null); } + /** + * Construct a new Principal, associated with the specified Realm, for the + * specified username, with the specified role names (as Strings). + * + * @param name The username of the user represented by this Principal + * @param password Unused + * @param roles List of roles (must be Strings) possessed by this user + * @param userPrincipal - the principal to be returned from the request + * getUserPrincipal call if not null; if null, this will be returned + * + * @deprecated This method will be removed in Tomcat 10.0.1 onwards + */ @Deprecated public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal) { @@ -101,6 +123,20 @@ public class GenericPrincipal implements TomcatPrincipal, Serializable { this(name, roles, userPrincipal, loginContext, null); } + /** + * Construct a new Principal, associated with the specified Realm, for the + * specified username, with the specified role names (as Strings). + * + * @param name The username of the user represented by this Principal + * @param password Unused + * @param roles List of roles (must be Strings) possessed by this user + * @param userPrincipal - the principal to be returned from the request + * getUserPrincipal call if not null; if null, this will be returned + * @param loginContext - If provided, this will be used to log out the user + * at the appropriate time + * + * @deprecated This method will be removed in Tomcat 10.0.1 onwards + */ @Deprecated public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext) { @@ -138,6 +174,21 @@ public class GenericPrincipal implements TomcatPrincipal, Serializable { } + /** + * Construct a new Principal, associated with the specified Realm, for the + * specified username, with the specified role names (as Strings). + * + * @param name The username of the user represented by this Principal + * @param password Unused + * @param roles List of roles (must be Strings) possessed by this user + * @param userPrincipal - the principal to be returned from the request + * getUserPrincipal call if not null; if null, this will be returned + * @param loginContext - If provided, this will be used to log out the user + * at the appropriate time + * @param gssCredential - If provided, the user's delegated credentials + * + * @deprecated This method will be removed in Tomcat 10.0.1 onwards + */ @Deprecated public GenericPrincipal(String name, String password, List<String> roles, Principal userPrincipal, LoginContext loginContext, --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org