Holger's Java API

## Uses of Interface
com.antelmann.db.User

Packages that use User
com.antelmann.db: This package contains generally useful classes for generic database management.
com.antelmann.db.remote: This package contains classes that add remote capacities to the database concept of the super package.
com.antelmann.genealogy: This package contains classes that provide classes to implement applications dealing with genealogy related issues.
com.antelmann.servlet: This package contains classes to help with the implementation of servlets.
com.antelmann.sql: This package contains classes to ease JDBC development and also provides useful SQL-based implementations for com.antelmann.db classes
com.antelmann.util.gui: This package contains utility classes for GUI related implementations.

Uses of User in com.antelmann.db

Classes in com.antelmann.db that implement User
`class` `SecureUserImpl` provides an implementation that uses a secure way of storing hashed passwords using appropriate algorithms along with some randomly generated salt.
`class` `UserImpl` This class represents a default User implementation that can serve as the basis for more specific implementations.

Methods in com.antelmann.db that return User
`User` `JPasswordChangeForm.commitFormAction(Component c)` calls `setPassword(String)` on the returned User object
`User[]` `UserLoginStore.getActiveUsers()` returns a generated array of currently active users (never null).
`User[]` `AbstractUserLoginStore.getActiveUsers()`
`User[]` `DefaultUserLoginStore.getAllUsers()` returns all users available in this store
`User` `AbstractUserLoginStore.getBackDoorUser()`
`User` `UserLoginStore.getCurrentUser()` returns the current user (that is also among the active users)
`User` `Database.getCurrentUser()` returns the user credentials of the one currently using this database
`User` `AbstractUserLoginStore.getCurrentUser()`
`User` `AbstractDatabase.getCurrentUser()`
`User` `JUserLoginPanel.getUser()` returns the user (if any) that was identified after the component was acted upon
`User` `DBUpdateEvent.getUser()` returns the user that was associated with the database of the source while this event was created
`User` `UserLoginStore.getUserForName(String name)` returns the User associated with the given name or null if no such user exists
`User` `DefaultUserLoginStore.getUserForName(String name)`
`User` `UserLoginStore.loginUser(String name, char[] password, String fromLocation)` returns the User that corresponds to the credentials provided; listeners are notified
`User` `AbstractUserLoginStore.loginUser(String name, char[] password, String fromLocation)`
`static User` `JUserLoginPanel.showDialog(String title, Component parent, UserLoginStore uls)` uses the default location
`static User` `JUserLoginPanel.showDialog(String title, Component parent, UserLoginStore uls, Image image, JUserLoginPanel.ImageLocation imageLocation)`
`static User` `JUserLoginPanel.showDialog(String title, Component parent, UserLoginStore uls, String location)`
`static User` `JUserLoginPanel.showDialog(String title, Component parent, UserLoginStore uls, String location, Image image, JUserLoginPanel.ImageLocation imageLocation)`
`static User` `JUserLoginPanel.showDialog(String title, Component parent, UserLoginStore uls, String location, Image image, JUserLoginPanel.ImageLocation imageLocation, String userString, String pwdString)` Upon successful login, the associated user is logged into the UserLoginStore.

Methods in com.antelmann.db that return types with arguments of type User
`ArrayList<User>` `AbstractUserLoginStore.listUsers(Filter<? super User> filter)`
`static ArrayList<User>` `AbstractUserLoginStore.listUsers(UserLoginStore uls, Filter<? super User> filter)` it may be more efficient to achieve this via an embedded DBClassStore if applicable

Methods in com.antelmann.db with parameters of type User
`boolean` `UserFilter.accept(User user)`
`boolean` `PasswordPolicy.accept(User user, char[] password)`
`boolean` `DefaultUserLoginStore.addUser(User user)` adds a user to this store, so that it can be used for login.
`void` `UserFilter.checkAccess(User user)` convenience method that throws an exception if this filter doesn't accept the given user
`int` `UserImpl.compareTo(User user)` first compares the name, then the id (using a UniversalComparator in both cases)
`Date` `AbstractUserLoginStore.getLoginTime(User user)` returns the time when the given user has logged in; returns null if the user is not an active user.
`String` `PasswordPolicy.getPasswordRequirementsString(User user)` tells the user who entered an inappropriate password what the requirements are
`boolean` `AbstractUserLoginStore.isActiveUser(User user)`
`void` `LoginListener.loginPerformed(UserLoginStore uls, User user, String location)` called when a user logged into the store
`void` `LoginListener.Adapter.loginPerformed(UserLoginStore uls, User user, String location)`
`void` `LoggerLoginListener.loginPerformed(UserLoginStore uls, User user, String location)`
`void` `AbstractDatabase.loginPerformed(UserLoginStore uls, User user, String location)`
`void` `UserLoginStore.loginUser(User user, String fromLocation)` allows to login a user via API directly
`void` `AbstractUserLoginStore.loginUser(User user, String fromLocation)`
`void` `LoginListener.logoutPerformed(UserLoginStore uls, User user)` called when a user logged out
`void` `LoginListener.Adapter.logoutPerformed(UserLoginStore uls, User user)`
`void` `LoggerLoginListener.logoutPerformed(UserLoginStore uls, User user)`
`void` `AbstractDatabase.logoutPerformed(UserLoginStore uls, User user)`
`boolean` `UserLoginStore.logoutUser(User user)` logs the given user out of this store and notifies the listeners
`boolean` `AbstractUserLoginStore.logoutUser(User user)` listeners are only informed if the user was actually logged in prior to this call
`boolean` `DefaultUserLoginStore.removeUser(User user)`
`void` `AbstractUserLoginStore.setBackDoorUser(User backDoorUser)`
`void` `Database.setCurrentUser(User user)` sets the user credentials for accessing resources
`void` `AbstractDatabase.setCurrentUser(User user)`
`static boolean` `JPasswordChangeForm.showDialog(Component parent, User user)` displays a dialog and returns either CHANGED or UNCHANGED, indicating whether the password on the user was actually changed.
`static boolean` `JPasswordChangeForm.showDialog(Component parent, User user, PasswordPolicy passwordPolicy)` displays a dialog and returns true only if the password on the user was actually changed.

`static

`<T> Callable<T>`

`

`DBUtils.wrapWithUser(Callable<T> call, DBTransaction t, User user)`
allows to wrap the given call so that it runs in the context of the given user as the current user for the database

`static

`<E extends Exception> Task<E>`

`

`DBUtils.wrapWithUser(Task<E> task, DBTransaction t, User user)`
allows to wrap the given task so that it runs in the context of the given user as the current user for the database

Method parameters in com.antelmann.db with type arguments of type User
`ArrayList<User>` `AbstractUserLoginStore.listUsers(Filter<? super User> filter)`
`static ArrayList<User>` `AbstractUserLoginStore.listUsers(UserLoginStore uls, Filter<? super User> filter)` it may be more efficient to achieve this via an embedded DBClassStore if applicable

Constructors in com.antelmann.db with parameters of type User
`AbstractDatabase(S databaseService, User user)` sets the current user (may be null)
`AbstractDatabase(S databaseService, User user, DBAccessController controller, LogWriter logWriter)`
`AbstractDatabase(S databaseService, User user, DBAccessController controller, LogWriter logWriter, boolean automatedTransactions)`
`AbstractDatabase(S databaseService, User user, LogWriter logWriter)` the given logWriter - assumed to write into the databaseService if not null - will be added to the embedded Logger
`DefaultUserLoginStore(User... users)`
`JPasswordChangeForm(User user)`
`JPasswordChangeForm(User user, PasswordPolicy passwordPolicy)`
`SecureUserImpl(Object id, User user)`
`UserImpl(Object id, User user)`
`UserTransactionListener(User user)`

Constructor parameters in com.antelmann.db with type arguments of type User
`UserTransactionListener(ValueRetriever<User> retriever)`

Uses of User in com.antelmann.db.remote

Constructors in com.antelmann.db.remote with parameters of type User
`RemoteDBUpdateEvent.Option(InetAddress computer, User user)`

Uses of User in com.antelmann.genealogy

Classes in com.antelmann.genealogy that implement User
`class` `GUser`

Constructors in com.antelmann.genealogy with parameters of type User
`GUser(User user)`

Uses of User in com.antelmann.servlet

Methods in com.antelmann.servlet that return User
`static User` `ServletUtils.authenticate(javax.servlet.http.HttpServletRequest req, Iterable<User> users, Filter<? super User> filter)` returns true only if any of the given users match the authorization scheme from the given request
`static User` `ServletUtils.authenticate(javax.servlet.ServletRequest req, UserLoginStore uls, Filter<? super User> filter)` implements authentication via BasicAuth
`User` `UserAuthenticationFilter.getUserFor(javax.servlet.ServletRequest request)`
`static User` `ServletUtils.getUserFromHeader(UserLoginStore uls, javax.servlet.ServletRequest request, String userKey, String pwdKey, boolean hashedPassword, Filter<? super User> filter)`
`static User` `ServletUtils.getUserFromParams(UserLoginStore uls, javax.servlet.ServletRequest request, String userKey, String pwdKey, boolean hashedPassword, Filter<? super User> filter)`

Methods in com.antelmann.servlet that return types with arguments of type User
`Filter<? super User>` `UserAuthenticationFilter.getUserFilter()`

Methods in com.antelmann.servlet with parameters of type User
`void` `UserAuthenticationFilter.applyUser(javax.servlet.ServletRequest request, User user)`

Method parameters in com.antelmann.servlet with type arguments of type User
`static User` `ServletUtils.authenticate(javax.servlet.http.HttpServletRequest req, Iterable<User> users, Filter<? super User> filter)` returns true only if any of the given users match the authorization scheme from the given request
`static User` `ServletUtils.authenticate(javax.servlet.http.HttpServletRequest req, Iterable<User> users, Filter<? super User> filter)` returns true only if any of the given users match the authorization scheme from the given request
`static User` `ServletUtils.authenticate(javax.servlet.ServletRequest req, UserLoginStore uls, Filter<? super User> filter)` implements authentication via BasicAuth
`static User` `ServletUtils.getUserFromHeader(UserLoginStore uls, javax.servlet.ServletRequest request, String userKey, String pwdKey, boolean hashedPassword, Filter<? super User> filter)`
`static User` `ServletUtils.getUserFromParams(UserLoginStore uls, javax.servlet.ServletRequest request, String userKey, String pwdKey, boolean hashedPassword, Filter<? super User> filter)`
`void` `UserAuthenticationFilter.setUserFilter(Filter<? super User> userFilter)`

Constructor parameters in com.antelmann.servlet with type arguments of type User
`UserAuthenticationFilter(UserLoginStore uls, Filter<? super User> userFilter)`

Uses of User in com.antelmann.sql

Methods in com.antelmann.sql that return User
`User[]` `UserImplStore.getActiveUsers()`
`User` `UserImplStore.getCurrentUser()`
`User` `UserImplStore.getUserForName(String name)`
`User` `UserImplStore.loginUser(String name, char[] password, String fromLocation)`

Methods in com.antelmann.sql with parameters of type User
`void` `UserImplStore.loginUser(User user, String fromLocation)`
`boolean` `UserImplStore.logoutUser(User user)`

Constructors in com.antelmann.sql with parameters of type User
`SQLDatabase(Connection con, User user, LogWriter logWriter)` the logWriter remains unchecked regarding access during a non-active transaction

Uses of User in com.antelmann.util.gui

Fields in com.antelmann.util.gui with type parameters of type User
`protected ValueRetriever<? extends User>` `MyAbstractAction.userRetriever`

Methods in com.antelmann.util.gui that return types with arguments of type User
`Filter<? super User>` `MyAbstractAction.getUserAccessFilter()`
`ValueRetriever<? extends User>` `MyAbstractAction.getUserRetriever()`

Methods in com.antelmann.util.gui with parameters of type User
`void` `MyAbstractAction.checkAccess(User user)` checks the current user from the retriever for being able to access all required rights in order to access this action; this method is called upon `MyAbstractAction.actionPerformed(ActionEvent)`.
`boolean` `MyAbstractAction.isAccessibleBy(User user)` utilizes `MyAbstractAction.checkAccess(User)` to answer the question (while temporarily disabling password requirements)

Method parameters in com.antelmann.util.gui with type arguments of type User
`void` `MyAbstractAction.setUserAccessFilter(Filter<? super User> userAccessFilter)` allows to specify a filter for users that is checked when `MyAbstractAction.checkAccess(User)` is called if set to a non-null value
`void` `MyAbstractAction.setUserRetriever(ValueRetriever<? extends User> userRetriever)`

Constructor parameters in com.antelmann.util.gui with type arguments of type User
`MyAbstractAction(String name, String description, Icon icon, Component parent, Logger logger, ValueRetriever<User> userRetriever, boolean requiresLicense)`

(c) Holger Antelmann since 2001- all rights reserved (contact: info@antelmann.com)
see www.antelmann.com/developer for further details and available downloads