提交 6e26dce4 authored 作者: Noel Grandin's avatar Noel Grandin

javadoc cleanup

上级 9f4ea2c5
...@@ -11,7 +11,6 @@ import java.sql.SQLException; ...@@ -11,7 +11,6 @@ import java.sql.SQLException;
import java.sql.SQLWarning; import java.sql.SQLWarning;
import java.sql.Statement; import java.sql.Statement;
import java.util.ArrayList; import java.util.ArrayList;
import org.h2.api.ErrorCode; import org.h2.api.ErrorCode;
import org.h2.command.CommandInterface; import org.h2.command.CommandInterface;
import org.h2.engine.SessionInterface; import org.h2.engine.SessionInterface;
...@@ -944,8 +943,8 @@ public class JdbcStatement extends TraceObject implements Statement, JdbcStateme ...@@ -944,8 +943,8 @@ public class JdbcStatement extends TraceObject implements Statement, JdbcStateme
* *
* @param sql the SQL statement * @param sql the SQL statement
* @param autoGeneratedKeys * @param autoGeneratedKeys
* {@link Statement.RETURN_GENERATED_KEYS} if generated keys should * {@link Statement#RETURN_GENERATED_KEYS} if generated keys should
* be available for retrieval, {@link Statement.NO_GENERATED_KEYS} if * be available for retrieval, {@link Statement#NO_GENERATED_KEYS} if
* generated keys should not be available * generated keys should not be available
* @return the update count (number of row affected by an insert, * @return the update count (number of row affected by an insert,
* update or delete, or 0 if no rows or the statement was a * update or delete, or 0 if no rows or the statement was a
...@@ -971,8 +970,8 @@ public class JdbcStatement extends TraceObject implements Statement, JdbcStateme ...@@ -971,8 +970,8 @@ public class JdbcStatement extends TraceObject implements Statement, JdbcStateme
* *
* @param sql the SQL statement * @param sql the SQL statement
* @param autoGeneratedKeys * @param autoGeneratedKeys
* {@link Statement.RETURN_GENERATED_KEYS} if generated keys should * {@link Statement#RETURN_GENERATED_KEYS} if generated keys should
* be available for retrieval, {@link Statement.NO_GENERATED_KEYS} if * be available for retrieval, {@link Statement#NO_GENERATED_KEYS} if
* generated keys should not be available * generated keys should not be available
* @return the update count (number of row affected by an insert, * @return the update count (number of row affected by an insert,
* update or delete, or 0 if no rows or the statement was a * update or delete, or 0 if no rows or the statement was a
...@@ -1097,8 +1096,8 @@ public class JdbcStatement extends TraceObject implements Statement, JdbcStateme ...@@ -1097,8 +1096,8 @@ public class JdbcStatement extends TraceObject implements Statement, JdbcStateme
* *
* @param sql the SQL statement * @param sql the SQL statement
* @param autoGeneratedKeys * @param autoGeneratedKeys
* {@link Statement.RETURN_GENERATED_KEYS} if generated keys should * {@link Statement#RETURN_GENERATED_KEYS} if generated keys should
* be available for retrieval, {@link Statement.NO_GENERATED_KEYS} if * be available for retrieval, {@link Statement#NO_GENERATED_KEYS} if
* generated keys should not be available * generated keys should not be available
* @return the update count (number of row affected by an insert, * @return the update count (number of row affected by an insert,
* update or delete, or 0 if no rows or the statement was a * update or delete, or 0 if no rows or the statement was a
......
...@@ -59,8 +59,6 @@ public class AuthenticationInfo { ...@@ -59,8 +59,6 @@ public class AuthenticationInfo {
/** /**
* get nested identity * get nested identity
*
* @return
*/ */
public Object getNestedIdentity() { public Object getNestedIdentity() {
return nestedIdentity; return nestedIdentity;
......
...@@ -16,11 +16,8 @@ public interface Authenticator { ...@@ -16,11 +16,8 @@ public interface Authenticator {
/** /**
* Perform user authentication. * Perform user authentication.
* *
* @param authenticationInfo
* @param database
* @return valid database user or null if user doesn't exists in the * @return valid database user or null if user doesn't exists in the
* database * database
* @throws AuthenticationException
*/ */
User authenticate(AuthenticationInfo authenticationInfo, Database database) throws AuthenticationException; User authenticate(AuthenticationInfo authenticationInfo, Database database) throws AuthenticationException;
...@@ -28,9 +25,7 @@ public interface Authenticator { ...@@ -28,9 +25,7 @@ public interface Authenticator {
* Initialize the authenticator. This method is invoked by databases when * Initialize the authenticator. This method is invoked by databases when
* the authenticator is set when the authenticator is set. * the authenticator is set when the authenticator is set.
* *
* @param database * @param database target database
* target database
* @throws AuthConfigException
*/ */
void init(Database database) throws AuthConfigException; void init(Database database) throws AuthConfigException;
} }
...@@ -13,7 +13,6 @@ import java.util.HashSet; ...@@ -13,7 +13,6 @@ import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import org.h2.api.CredentialsValidator; import org.h2.api.CredentialsValidator;
import org.h2.api.UserToRolesMapper; import org.h2.api.UserToRolesMapper;
import org.h2.engine.Database; import org.h2.engine.Database;
...@@ -93,8 +92,6 @@ public class DefaultAuthenticator implements Authenticator { ...@@ -93,8 +92,6 @@ public class DefaultAuthenticator implements Authenticator {
/** /**
* If set save users externals defined during the authentication. * If set save users externals defined during the authentication.
*
* @return
*/ */
public boolean isPersistUsers() { public boolean isPersistUsers() {
return persistUsers; return persistUsers;
...@@ -106,8 +103,6 @@ public class DefaultAuthenticator implements Authenticator { ...@@ -106,8 +103,6 @@ public class DefaultAuthenticator implements Authenticator {
/** /**
* If set create external users in the database if not present. * If set create external users in the database if not present.
*
* @return
*/ */
public boolean isAllowUserRegistration() { public boolean isAllowUserRegistration() {
return allowUserRegistration; return allowUserRegistration;
...@@ -120,8 +115,6 @@ public class DefaultAuthenticator implements Authenticator { ...@@ -120,8 +115,6 @@ public class DefaultAuthenticator implements Authenticator {
/** /**
* When set create roles not found in the database. If not set roles not * When set create roles not found in the database. If not set roles not
* found in the database are silently skipped * found in the database are silently skipped
*
* @return
*/ */
public boolean isCreateMissingRoles() { public boolean isCreateMissingRoles() {
return createMissingRoles; return createMissingRoles;
...@@ -170,9 +163,7 @@ public class DefaultAuthenticator implements Authenticator { ...@@ -170,9 +163,7 @@ public class DefaultAuthenticator implements Authenticator {
* <li>Use the default configuration hard coded</li> * <li>Use the default configuration hard coded</li>
* </ol> * </ol>
* *
* @param database * @param database where authenticator is initialized
* where authenticator is initialized
* @throws AuthConfigException
*/ */
@Override @Override
public void init(Database database) throws AuthConfigException { public void init(Database database) throws AuthConfigException {
...@@ -230,9 +221,7 @@ public class DefaultAuthenticator implements Authenticator { ...@@ -230,9 +221,7 @@ public class DefaultAuthenticator implements Authenticator {
/** /**
* Configure the authenticator from a configuration file * Configure the authenticator from a configuration file
* *
* @param configUrl * @param configUrl URL of configuration file
* URL of configuration file
* @throws Exception
*/ */
public void configureFromUrl(URL configUrl) throws Exception { public void configureFromUrl(URL configUrl) throws Exception {
H2AuthConfig config = H2AuthConfigXml.parseFrom(configUrl); H2AuthConfig config = H2AuthConfigXml.parseFrom(configUrl);
......
...@@ -7,10 +7,8 @@ package org.h2.security.auth; ...@@ -7,10 +7,8 @@ package org.h2.security.auth;
import java.io.InputStream; import java.io.InputStream;
import java.net.URL; import java.net.URL;
import javax.xml.parsers.SAXParser; import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory; import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.Attributes; import org.xml.sax.Attributes;
import org.xml.sax.SAXException; import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler; import org.xml.sax.helpers.DefaultHandler;
...@@ -91,9 +89,6 @@ public class H2AuthConfigXml extends DefaultHandler{ ...@@ -91,9 +89,6 @@ public class H2AuthConfigXml extends DefaultHandler{
/** /**
* Parse the xml * Parse the xml
* @param url
* @return
* @throws Exception
*/ */
public static H2AuthConfig parseFrom(URL url) throws Exception{ public static H2AuthConfig parseFrom(URL url) throws Exception{
try (InputStream inputStream= url.openStream()) { try (InputStream inputStream= url.openStream()) {
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论