net.sf.jportlet.service.login
Interface LoginService

All Superinterfaces:

PortletService

All Known Implementing Classes:

LoginServiceImpl

public interface LoginService

extends PortletService

The LoginService manager the login/logout. This service depends on UserService

Author:

Herve Tchepannou

Field Summary

static java.lang.String	NAME
static java.lang.String	PASSWORD
static java.lang.String	USER_ID

Method Summary

boolean	login(net.sf.jportlet.portlet.PortletRequest request) Authenticate a user.
void	logout(net.sf.jportlet.portlet.PortletRequest request) Logs the current user out of the portal.

Methods inherited from interface net.sf.jportlet.service.PortletService

destroy, getServiceConfig, getServiceName, init

Field Detail

NAME

public static final java.lang.String NAME

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD

See Also:

Constant Field Values

Method Detail

login

public boolean login(net.sf.jportlet.portlet.PortletRequest request)
              throws PortletException

Authenticate a user. This methods expects from the request the following form parameters:

1. USER_ID: the ID of the user
2. PASSWORD: The user's password.

If the user is authenticated, this method will notify all the portlet by calling net.sf.jportlet.portlet.Portlet#login()

Parameters:

request -

Returns:

true if the user is logged in

Throws:

PortletServiceException - if any error occurs

PortletException

logout

public void logout(net.sf.jportlet.portlet.PortletRequest request)
            throws PortletException

Logs the current user out of the portal.

Parameters:

request -

Throws:

PortletException - if any error occurs