## Uses of Interface
org.apache.turbine.om.security.User

- Packages that use User
  Package | Description
  --- | ---
  org.apache.turbine.services.pull.tools | Pull Tools to be used in a template based view.
  org.apache.turbine.services.rundata | Rundata Service provides a factory for the request cycle data objects.
  org.apache.turbine.services.security | The security service can be used to authenticate users based on database information.
  org.apache.turbine.services.security.passive | Dummy Service to be used if no security is required.
  org.apache.turbine.services.session | The session service allows you to access session information of the servlet container.
  org.apache.turbine.util | Various utilities used in Turbine and for Turbine based applications.

- - ### Uses of User in org.apache.turbine.services.pull.tools

    Methods in org.apache.turbine.services.pull.tools with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | UITool.`setSkin(User user)` Set the skin name when the tool is configured to be loaded on a per-session basis.
    `static void` | UITool.`setSkin(User user, String skin)` Set the skin name in the user's temp hashmap for the current session.

  - ### Uses of User in org.apache.turbine.services.rundata

    Methods in org.apache.turbine.services.rundata with type parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `<T extends User> T` | DefaultTurbineRunData.`getUser()` Gets the user.
    `<T extends User> T` | DefaultTurbineRunData.`getUserFromSession()` Attempts to get the user from the session.
    `static <T extends User> T` | DefaultTurbineRunData.`getUserFromSession(javax.servlet.http.HttpSession session)` Attempts to get the User object from the session.

    Methods in org.apache.turbine.services.rundata with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `void` | DefaultTurbineRunData.`setUser(User user)` Sets the user.

  - ### Uses of User in org.apache.turbine.services.security

    Methods in org.apache.turbine.services.security with type parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `<U extends User> U` | UserManager.`getAnonymousUser()` Constructs an User object to represent an anonymous user of the application.
    `<U extends User> U` | SecurityService.`getAnonymousUser()` Constructs an User object to represent an anonymous user of the application.
    `<U extends User> U` | DefaultUserManager.`getAnonymousUser()` Constructs an User object to represent an anonymous user of the application.
    `<U extends User> U` | DefaultSecurityService.`getAnonymousUser()` Constructs an User object to represent an anonymous user of the application.
    `<U extends User> U` | SecurityService.`getAuthenticatedUser(String username, String password)` Authenticates an user, and constructs an User object to represent him/her.
    `<U extends User> U` | DefaultSecurityService.`getAuthenticatedUser(String username, String password)` Authenticates an user, and constructs an User object to represent him/her.
    `<U extends User> U` | SecurityService.`getUser(String username)` Constructs an User object to represent a registered user of the application.
    `<U extends User> U` | DefaultSecurityService.`getUser(String username)` Constructs an User object to represent a registered user of the application.
    `<U extends User> U` | UserManager.`getUserInstance()` Construct a blank User object.
    `<U extends User> U` | SecurityService.`getUserInstance()` Construct a blank User object.
    `<U extends User> U` | DefaultUserManager.`getUserInstance()` Construct a blank User object.
    `<U extends User> U` | DefaultSecurityService.`getUserInstance()` Construct a blank User object.
    `<U extends User> U` | UserManager.`getUserInstance(String userName)` Construct a blank User object.
    `<U extends User> U` | SecurityService.`getUserInstance(String userName)` Construct a blank User object.
    `<U extends User> U` | DefaultUserManager.`getUserInstance(String userName)` Construct a blank User object.
    `<U extends User> U` | DefaultSecurityService.`getUserInstance(String userName)` Construct a blank User object.
    `<U extends User> U` | DefaultUserManager.`getUserWrapper(org.apache.fulcrum.security.model.turbine.entity.TurbineUser user)` Exception could be ignored, as it is tested before in `DefaultUserManager.init(Configuration)`.
    `<U extends User> U` | UserManager.`retrieve(String username)` Retrieve a user from persistent storage using username as the key.
    `<U extends User> U` | DefaultUserManager.`retrieve(String username)` Retrieve a user from persistent storage using username as the key.
    `<U extends User> U` | UserManager.`retrieve(String username, String password)` Retrieve a user from persistent storage using username as the key, and authenticate the user.
    `<U extends User> U` | DefaultUserManager.`retrieve(String username, String password)` Retrieve a user from persistent storage using username as the key, and authenticate the user.
    `protected <U extends User> U` | DefaultUserManager.`wrap(org.apache.fulcrum.security.model.turbine.entity.TurbineUser user)` Wrap a Fulcrum user object into a Turbine user object

    Methods in org.apache.turbine.services.security that return types with arguments of type User
    Modifier and Type | Method and Description
    --- | ---
    `List<? extends User>` | UserManager.`retrieveList(Object criteria)` Retrieve a list of users that meet the specified criteria.
    `List<? extends User>` | DefaultUserManager.`retrieveList(Object criteria)` Retrieve a set of users that meet the specified criteria.

    Methods in org.apache.turbine.services.security with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | UserManager.`accountExists(User user)` Check whether a specified user's account exists.
    `boolean` | SecurityService.`accountExists(User user)` Check whether a specified user's account exists.
    `boolean` | DefaultUserManager.`accountExists(User user)` Check whether a specified user's account exists.
    `boolean` | DefaultSecurityService.`accountExists(User user)` Check whether a specified user's account exists.
    `void` | SecurityService.`addUser(User user, String password)` Creates new user account with specified attributes.
    `void` | DefaultSecurityService.`addUser(User user, String password)` Creates new user account with specified attributes.
    `void` | UserManager.`authenticate(User user, String password)` Authenticate an User with the specified password.
    `void` | DefaultUserManager.`authenticate(User user, String password)` Authenticate an User with the specified password.
    `void` | UserManager.`changePassword(User user, String oldPassword, String newPassword)` Change the password for an User.
    `void` | SecurityService.`changePassword(User user, String oldPassword, String newPassword)` Change the password for an User.
    `void` | DefaultUserManager.`changePassword(User user, String oldPassword, String newPassword)` Change the password for an User.
    `void` | DefaultSecurityService.`changePassword(User user, String oldPassword, String newPassword)` Change the password for an User.
    `void` | UserManager.`createAccount(User user, String initialPassword)` Creates new user account with specified attributes.
    `void` | DefaultUserManager.`createAccount(User user, String initialPassword)` Creates new user account with specified attributes.
    `void` | UserManager.`forcePassword(User user, String password)` Forcibly sets new password for an User.
    `void` | SecurityService.`forcePassword(User user, String password)` Forcibly sets new password for an User.
    `void` | DefaultUserManager.`forcePassword(User user, String password)` Forcibly sets new password for an User.
    `void` | DefaultSecurityService.`forcePassword(User user, String password)` Forcibly sets new password for an User.
    `<A extends org.apache.fulcrum.security.acl.AccessControlList> A` | UserManager.`getACL(User user)` Return a Class object representing the system's chosen implementation of of ACL interface for the given user
    `<A extends org.apache.fulcrum.security.acl.AccessControlList> A` | SecurityService.`getACL(User user)` Constructs an AccessControlList for a specific user.
    `<A extends org.apache.fulcrum.security.acl.AccessControlList> A` | DefaultUserManager.`getACL(User user)` Return a Class object representing the system's chosen implementation of of ACL interface.
    `<A extends org.apache.fulcrum.security.acl.AccessControlList> A` | DefaultSecurityService.`getACL(User user)` Constructs an AccessControlList for a specific user.
    `void` | SecurityService.`grant(User user, org.apache.fulcrum.security.entity.Group group, org.apache.fulcrum.security.entity.Role role)` Grant an User a Role in a Group.
    `void` | DefaultSecurityService.`grant(User user, org.apache.fulcrum.security.entity.Group group, org.apache.fulcrum.security.entity.Role role)` Grant an User a Role in a Group.
    `boolean` | UserManager.`isAnonymousUser(User u)` Checks whether a passed user object matches the anonymous user pattern according to the configured user manager
    `boolean` | SecurityService.`isAnonymousUser(User u)` Checks whether a passed user object matches the anonymous user pattern according to the configured user manager
    `boolean` | DefaultUserManager.`isAnonymousUser(User u)` Checks whether a passed user object matches the anonymous user pattern according to the configured user manager
    `boolean` | DefaultSecurityService.`isAnonymousUser(User user)` Checks whether a passed user object matches the anonymous user pattern according to the configured user manager
    `void` | UserManager.`removeAccount(User user)` Removes an user account from the system.
    `void` | DefaultUserManager.`removeAccount(User user)` Removes an user account from the system.
    `void` | SecurityService.`removeUser(User user)` Removes an user account from the system.
    `void` | DefaultSecurityService.`removeUser(User user)` Removes an user account from the system.
    `void` | SecurityService.`replaceRole(User user, org.apache.fulcrum.security.entity.Role role, org.apache.fulcrum.security.entity.Role newRole)` Replaces transactionally the first given role with the second role for the given user.
    `void` | DefaultSecurityService.`replaceRole(User user, org.apache.fulcrum.security.entity.Role role, org.apache.fulcrum.security.entity.Role newRole)` Replaces transactionally the first role with second role for the given user.
    `void` | SecurityService.`revoke(User user, org.apache.fulcrum.security.entity.Group group, org.apache.fulcrum.security.entity.Role role)` Revoke a Role in a Group from an User.
    `void` | DefaultSecurityService.`revoke(User user, org.apache.fulcrum.security.entity.Group group, org.apache.fulcrum.security.entity.Role role)` Revoke a Role in a Group from an User.
    `void` | SecurityService.`revokeAll(User user)` Revokes all roles from an User.
    `void` | DefaultSecurityService.`revokeAll(User user)` Revokes all roles from an User.
    `void` | UserManager.`saveOnSessionUnbind(User user)` Saves User data when the session is unbound.
    `void` | SecurityService.`saveOnSessionUnbind(User user)` Saves User data when the session is unbound.
    `void` | DefaultUserManager.`saveOnSessionUnbind(User user)` Saves User data when the session is unbound.
    `void` | DefaultSecurityService.`saveOnSessionUnbind(User user)` Saves User data when the session is unbound.
    `void` | SecurityService.`saveUser(User user)` Saves User's data in the permanent storage.
    `void` | DefaultSecurityService.`saveUser(User user)` Saves User's data in the permanent storage.
    `void` | UserManager.`store(User user)` Save an User object to persistent storage.
    `void` | DefaultUserManager.`store(User user)` Save an User object to persistent storage.

  - ### Uses of User in org.apache.turbine.services.security.passive

    Methods in org.apache.turbine.services.security.passive with type parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `<T extends User> T` | PassiveUserManager.`getAnonymousUser()` Constructs an User object to represent an anonymous user of the application.
    `<T extends User> T` | PassiveUserManager.`getUserInstance()` Construct a blank User object.
    `<T extends User> T` | PassiveUserManager.`getUserInstance(String userName)` Construct a blank User object.
    `<U extends User> U` | PassiveUserManager.`retrieve(String username)` Retrieve a user from persistent storage using username as the key.
    `<U extends User> U` | PassiveUserManager.`retrieve(String username, String password)` Retrieve a user from persistent storage using username as the key, and authenticate the user.

    Methods in org.apache.turbine.services.security.passive that return types with arguments of type User
    Modifier and Type | Method and Description
    --- | ---
    `List<? extends User>` | PassiveUserManager.`retrieveList(Object criteria)` Retrieve a set of users that meet the specified criteria.

    Methods in org.apache.turbine.services.security.passive with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | PassiveUserManager.`accountExists(User user)` Check whether a specified user's account exists.
    `void` | PassiveUserManager.`authenticate(User user, String password)` Authenticate an User with the specified password.
    `void` | PassiveUserManager.`changePassword(User user, String oldPassword, String newPassword)` Change the password for an User.
    `void` | PassiveUserManager.`createAccount(User user, String initialPassword)` Creates new user account with specified attributes.
    `void` | PassiveUserManager.`forcePassword(User user, String password)` Forcibly sets new password for an User.
    `<T extends org.apache.fulcrum.security.acl.AccessControlList> T` | PassiveUserManager.`getACL(User user)` Return a Class object representing the system's chosen implementation of of ACL interface.
    `boolean` | PassiveUserManager.`isAnonymousUser(User u)` Checks whether a passed user object matches the anonymous user pattern according to the configured user manager
    `void` | PassiveUserManager.`removeAccount(User user)` Removes an user account from the system.
    `void` | PassiveUserManager.`saveOnSessionUnbind(User user)` Saves User data when the session is unbound.
    `void` | PassiveUserManager.`store(User user)` Save an User object to persistent storage.

  - ### Uses of User in org.apache.turbine.services.session

    Methods in org.apache.turbine.services.session that return User
    Modifier and Type | Method and Description
    --- | ---
    `User` | TurbineSessionService.`getUserFromSession(javax.servlet.http.HttpSession session)` Gets the User object of the the specified HttpSession.
    `User` | SessionTool.`getUserFromSession(javax.servlet.http.HttpSession session)` Gets the User object of the the specified HttpSession.
    `User` | SessionService.`getUserFromSession(javax.servlet.http.HttpSession session)` Gets the User object of the the specified HttpSession.

    Methods in org.apache.turbine.services.session that return types with arguments of type User
    Modifier and Type | Method and Description
    --- | ---
    `Collection<User>` | TurbineSessionService.`getActiveUsers()` Gets a collection of all user objects representing the users currently logged in.
    `Collection<User>` | SessionTool.`getActiveUsers()` Gets a collection of all user objects representing the users currently logged in.
    `Collection<User>` | SessionService.`getActiveUsers()` Gets a collection of all user objects representing the users currently logged in.

    Methods in org.apache.turbine.services.session with parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `Collection<javax.servlet.http.HttpSession>` | TurbineSessionService.`getSessionsForUser(User user)` Get a collection of all session on which the given user is logged in.
    `Collection<javax.servlet.http.HttpSession>` | SessionTool.`getSessionsForUser(User user)` Get a collection of all session on which the given user is logged in.
    `Collection<javax.servlet.http.HttpSession>` | SessionService.`getSessionsForUser(User user)` Get a collection of all session on which the given user is logged in.
    `boolean` | TurbineSessionService.`isUserLoggedIn(User user)` Determines if a given user is currently logged in.
    `boolean` | SessionTool.`isUserLoggedIn(User user)` Determines if a given user is currently logged in.
    `boolean` | SessionService.`isUserLoggedIn(User user)` Determines if a given user is currently logged in.

  - ### Uses of User in org.apache.turbine.util

    Methods in org.apache.turbine.util with type parameters of type User
    Modifier and Type | Method and Description
    --- | ---
    `<T extends User> T` | RunData.`getUser()` Gets the user.
    `<T extends User> T` | RunData.`getUserFromSession()` Attempts to get the user from the session.
    `<T extends User> void` | RunData.`setUser(T user)` Sets the user.

Copyright © 2000–2018 The Apache Software Foundation. All rights reserved.