# com.bea.p13n.controls.login
UserLoginControl Interface

public interface UserLoginControl
extends `Control`

This control:

- is used by the portal GUI components to send authentication information to the portal site
- allows a site visitor to log in to the portal
- gives some indication as to whether the login is successful by providing access to the user's profile information, and throwing an exception otherwise.

It does not register the user

Related Topics

``ProfileWrapper``

All Superinterfaces
  `Control`, `Control`, `Serializable`

## Method Summary

`public `ProfileWrapper`` | `login`(`String` username, `String` password, `HttpServletRequest` request) Log this user into the Portal application
`public void` | `logout`(`HttpServletRequest` request) Log out current user

## Method Detail

### login(String, String, HttpServletRequest) Method

    public ProfileWrapper login(String username,
                                String password,
                                HttpServletRequest request)
         throws P13nControlException

Log this user into the Portal application

#### Parameters

username
  The user's login name

password
  The user's password

request
  Request object

#### Returns

a ProfileWrapper representing the user's stored information

#### Exceptions

``P13nControlException``
  if user cannot be logged in, or if there is a remote error on the UserManager EJB authenticating or retrieving user profile.

### logout(HttpServletRequest) Method

    public void logout(HttpServletRequest request)

Log out current user