com.dotmarketing.business.web
Interface UserWebAPI

All Superinterfaces:

UserAPI

All Known Implementing Classes:

UserWebAPIImpl

public interface UserWebAPI
extends UserAPI

Specialized UserAPI created to manage web requests.

Since:

1.6

Version:

1.6

Author:

David

Method Summary

com.liferay.portal.model.User	getLoggedInFrontendUser(javax.servlet.http.HttpServletRequest req)
com.liferay.portal.model.User	getLoggedInUser(javax.servlet.http.HttpServletRequest req)
boolean	isLoggedToBackend(javax.servlet.http.HttpServletRequest req) Returns true if the request is coming from a user logged in to the backend
boolean	isLoggedToFrontend(javax.servlet.http.HttpServletRequest req) Returns true if the request is coming from a user logged in to the frontend, false otherwise

Methods inherited from interface com.dotmarketing.business.UserAPI

createUser, delete, deleteAddress, encryptUserId, findAllUsers, findAllUsers, getAnonymousUser, getCountUsersByNameOrEmail, getCountUsersByNameOrEmailOrUserID, getDefaultUser, getSystemUser, getUsersAnRolesByName, getUsersByName, getUsersByNameOrEmail, getUsersByNameOrEmailOrUserID, isCMSAdmin, loadAddressById, loadByUserByEmail, loadUserAddresses, loadUserById, loadUserById, save, saveAddress, userExistsWithEmail

Method Detail

getLoggedInUser

com.liferay.portal.model.User getLoggedInUser(javax.servlet.http.HttpServletRequest req)
                                              throws DotRuntimeException,
                                                     com.liferay.portal.PortalException,
                                                     com.liferay.portal.SystemException

Parameters:

req -

Returns:

The logged in user (back-end or front-end), null if no user is logged in

Throws:

DotRuntimeException

com.liferay.portal.SystemException

com.liferay.portal.PortalException

getLoggedInFrontendUser

com.liferay.portal.model.User getLoggedInFrontendUser(javax.servlet.http.HttpServletRequest req)
                                                      throws DotRuntimeException,
                                                             com.liferay.portal.PortalException,
                                                             com.liferay.portal.SystemException

Parameters:

req -

Returns:

The logged in user (back-end or front-end), null if no user is logged in

Throws:

DotRuntimeException

com.liferay.portal.SystemException

com.liferay.portal.PortalException

isLoggedToBackend

boolean isLoggedToBackend(javax.servlet.http.HttpServletRequest req)
                          throws DotRuntimeException,
                                 com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException

Returns true if the request is coming from a user logged in to the backend

Parameters:

req -

Returns:

Throws:

DotRuntimeException

com.liferay.portal.SystemException

com.liferay.portal.PortalException

isLoggedToFrontend

boolean isLoggedToFrontend(javax.servlet.http.HttpServletRequest req)
                           throws DotRuntimeException,
                                  com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException

Returns true if the request is coming from a user logged in to the frontend, false otherwise

Parameters:

req -

Returns:

Throws:

DotRuntimeException

com.liferay.portal.SystemException

com.liferay.portal.PortalException