| java.lang.Object
 org.opencms.workplace.CmsWorkplace
org.opencms.workplace.CmsLoginHelper
| CmsLoginHelper | | public class CmsLoginHelper extends CmsWorkplace (Code) | | Handles front-end login of users to the OpenCms workplace into the given site and project.
author:
Michael Moossen
version:
$Revision: 1.2 $
since:
7.0.3 |
| getLoginException | | public CmsException getLoginException()(Code) | | Returns the loginException.
the loginException |
| getStacktrace | | public String getStacktrace()(Code) | | Returns the formatted stack trace.
the formatted stack trace |
| login | | public boolean login(String userName, String password, String projectName, String siteRoot, String resourceName)(Code) | | Logs the user into the given project and site.
Check the
CmsLoginHelper.getLoginException() for the error message.
Parameters:
userName - the user name
Parameters:
password - the password
Parameters:
projectName - the optional project name, if null the default project is used
Parameters:
siteRoot - the site of the resource, if null the default site is used
Parameters:
resourceName - the resource to display true if the login has been successful |
| Methods inherited from org.opencms.workplace.CmsWorkplace | protected void addMessages(CmsMessages messages)(Code)(Java Doc)
protected void addMessages(String bundleName)(Code)(Java Doc)
protected Map allParamValues()(Code)(Java Doc)
public String allParamsAsHidden()(Code)(Java Doc)
public String allParamsAsRequest()(Code)(Java Doc)
public String bodyEnd()(Code)(Java Doc)
public String bodyStart(String className)(Code)(Java Doc)
public String bodyStart(String className, String parameters)(Code)(Java Doc)
public static String buildSelect(String parameters, List options, List values, int selected, boolean useLineFeed)(Code)(Java Doc)
public String buildSelect(String parameters, List options, List values, int selected)(Code)(Java Doc)
public String button(String href, String target, String image, String label, int type)(Code)(Java Doc)
public String button(String href, String target, String image, String label, int type, String imagePath)(Code)(Java Doc)
public String buttonBar(int segment)(Code)(Java Doc)
public String buttonBar(int segment, String attributes)(Code)(Java Doc)
public String buttonBarHorizontalLine()(Code)(Java Doc)
public String buttonBarLabel(String label)(Code)(Java Doc)
public String buttonBarLabel(String label, String className)(Code)(Java Doc)
public String buttonBarLine(int leftPixel, int rightPixel, String className)(Code)(Java Doc)
public String buttonBarLineSpacer(int pixel)(Code)(Java Doc)
public String buttonBarSeparator(int leftPixel, int rightPixel)(Code)(Java Doc)
public String buttonBarSpacer(int width)(Code)(Java Doc)
public String buttonBarStartTab(int leftPixel, int rightPixel)(Code)(Java Doc)
public void checkLock(String resource) throws CmsException(Code)(Java Doc)
public void checkLock(String resource, CmsLockType type) throws CmsException(Code)(Java Doc)
protected void checkRole() throws CmsRoleViolationException(Code)(Java Doc)
protected String decodeParamValue(String paramName, String paramValue)(Code)(Java Doc)
public void fillParamValues(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
public void fillParamValues(HttpServletRequest request)(Code)(Java Doc)
public String getBroadcastMessageString()(Code)(Java Doc)
public CmsObject getCms()(Code)(Java Doc)
public String getEncoding()(Code)(Java Doc)
public String getExplorerFileListFullUri()(Code)(Java Doc)
public String getFrameSource(String frameName, String uri)(Code)(Java Doc)
public CmsJspActionElement getJsp()(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public CmsMacroResolver getMacroResolver()(Code)(Java Doc)
public CmsMessages getMessages()(Code)(Java Doc)
public List getMultiPartFileItems()(Code)(Java Doc)
protected Map getParameterMap()(Code)(Java Doc)
public static String getResourceUri(String resourceName)(Code)(Java Doc)
public String getResourceUri()(Code)(Java Doc)
public HttpSession getSession()(Code)(Java Doc)
public CmsWorkplaceSettings getSettings()(Code)(Java Doc)
public static String getSkinUri()(Code)(Java Doc)
public static String getStyleUri(CmsJspActionElement jsp)(Code)(Java Doc)
public static String getStyleUri(CmsJspActionElement jsp, String filename)(Code)(Java Doc)
public String getStyleUri(String filename)(Code)(Java Doc)
public static String getTemporaryFileName(String resourceName)(Code)(Java Doc)
public String htmlEnd()(Code)(Java Doc)
public String htmlStart(String title)(Code)(Java Doc)
protected void initMessages()(Code)(Java Doc)
public boolean initSettings(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
protected void initTimeWarp(CmsUserSettings settings, HttpSession session)(Code)(Java Doc)
public static CmsWorkplaceSettings initUserSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update)(Code)(Java Doc)
protected void initWorkplaceMembers(CmsJspActionElement jsp)(Code)(Java Doc)
abstract protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings, HttpServletRequest request)(Code)(Java Doc)
public static synchronized CmsWorkplaceSettings initWorkplaceSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update)(Code)(Java Doc)
public boolean isForwarded()(Code)(Java Doc)
public boolean isHelpEnabled()(Code)(Java Doc)
public boolean isSubElement()(Code)(Java Doc)
public static boolean isTemporaryFile(CmsResource resource)(Code)(Java Doc)
public static boolean isTemporaryFileName(String resourceName)(Code)(Java Doc)
public String key(String keyName)(Code)(Java Doc)
public String key(String keyName, Object[] params)(Code)(Java Doc)
public String keyDefault(String keyName, String defaultValue)(Code)(Java Doc)
public String nullToEmpty(String value)(Code)(Java Doc)
public String pageBody(int segment, String className, String parameters)(Code)(Java Doc)
public String pageHtml(int segment, String title)(Code)(Java Doc)
public String pageHtmlStyle(int segment, String title, String stylesheet)(Code)(Java Doc)
protected Map paramValues()(Code)(Java Doc)
public String paramsAsHidden()(Code)(Java Doc)
public String paramsAsHidden(Collection excludes)(Code)(Java Doc)
public Map paramsAsParameterMap()(Code)(Java Doc)
public String paramsAsRequest()(Code)(Java Doc)
public String resolveMacros(String input)(Code)(Java Doc)
public void sendCmsRedirect(String location) throws IOException(Code)(Java Doc)
public void sendForward(String location, Map params) throws IOException, ServletException(Code)(Java Doc)
public void setForwarded(boolean forwarded)(Code)(Java Doc)
public String shortKey(String keyName)(Code)(Java Doc)
static void storeSettings(HttpSession session, CmsWorkplaceSettings settings)(Code)(Java Doc)
protected void switchToCurrentProject() throws CmsException(Code)(Java Doc)
protected CmsUUID switchToTempProject() throws CmsException(Code)(Java Doc)
|
|
|