| java.lang.Object
 org.opencms.jsp.CmsJspBean
org.opencms.jsp.CmsJspActionElement
org.opencms.jsp.CmsJspLoginBean
All known Subclasses: org.opencms.workplace.CmsLogin,
| CmsJspLoginBean | | public class CmsJspLoginBean extends CmsJspActionElement (Code) | | Provides convenient wrappers useful to create user login pages.
Initialize this bean at the beginning of your JSP like this:
<jsp:useBean id="cmslogin" class="org.opencms.jsp.CmsJspLoginBean">
<% cmslogin.init(pageContext, request, response); %>
</jsp:useBean>
author:
Alexander Kandzior
version:
$Revision: 1.24 $
since:
6.0.0 |
| CmsJspLoginBean | | public CmsJspLoginBean()(Code) | | Empty constructor, required for every JavaBean.
|
| getFormLink | | public String getFormLink()(Code) | | Returns the link to the form that contains the login element.
the link to the form that contains the login element |
| getLoginException | | public CmsException getLoginException()(Code) | | Returns the exception that was thrown after login,
or null if no Exception was thrown (i.e. login was successful
or not attempted).
the exception thrown after login |
| getUser | | public CmsUser getUser()(Code) | | Returns the currently logged in user.
the currently logged in user |
| getUserName | | public String getUserName()(Code) | | Returns the user name of the currently logged in user.
the user name of the currently logged in user |
| isLoggedIn | | public boolean isLoggedIn()(Code) | | Returns true if the current user is not the guest user,
i.e. if he already has logged in with some other user account.
true if the current user is already logged in |
| isLoginSuccess | | public boolean isLoginSuccess()(Code) | | Indicates if a login was successful or not.
true if the login was successful |
| login | | public void login(String userName, String password)(Code) | | Logs a system user in to OpenCms.
Parameters:
userName - the users name
Parameters:
password - the password |
| login | | public void login(String userName, String password, String projectName)(Code) | | Logs a system user into OpenCms.
Note that if a login project name is provided, this project must exist,
otherwise the login is regarded as a failure even if the user data was correct.
Parameters:
userName - the users name
Parameters:
password - the password
Parameters:
projectName - the project to switch to after login (if null project is not switched) |
| login | | public void login(String userName, String password, String projectName, String redirectUri) throws IOException(Code) | | Logs a system user in to OpenCms.
Note that if a login project name is provided, this project must exist,
otherwise the login is regarded as a failure even if the user data was correct.
Parameters:
userName - the users name
Parameters:
password - the password
Parameters:
projectName - the project to switch to after login (if null project is not switched)
Parameters:
redirectUri - the URI to redirect to after login (if null the current URI is used)
throws:
IOException - in case redirect after login was not successful |
| logout | | public void logout() throws IOException(Code) | | Logs a user out, i.e. destroys the current users session,
after that the current page will be redirected to itself one time to ensure that
the users session is truly destroyed.
throws:
IOException - if redirect after logout fails |
| Methods inherited from org.opencms.jsp.CmsJspActionElement | public void editable(boolean isEditable) throws JspException(Code)(Java Doc)
public void editable(boolean isEditable, String filename) throws JspException(Code)(Java Doc)
public void editable(String provider, String mode, String filename) throws JspException(Code)(Java Doc)
public void editableManualClose(boolean needsClose) throws JspException(Code)(Java Doc)
public boolean editableManualOpen() throws JspException(Code)(Java Doc)
public String getContent(String target)(Code)(Java Doc)
public String getContent(String target, String element, Locale locale)(Code)(Java Doc)
public CmsMessages getMessages(String bundleName, Locale locale)(Code)(Java Doc)
public CmsMessages getMessages(String bundleName, String language)(Code)(Java Doc)
public CmsMessages getMessages(String bundleName, String language, String defaultLanguage)(Code)(Java Doc)
public CmsMessages getMessages(String bundleName, String language, String country, String variant, String defaultLanguage)(Code)(Java Doc)
public CmsJspNavBuilder getNavigation()(Code)(Java Doc)
public String img(String target, CmsImageScaler scaler, Map attributes)(Code)(Java Doc)
public String img(String target, CmsImageScaler scaler, Map attributes, boolean partialTag)(Code)(Java Doc)
public void include(String target) throws JspException(Code)(Java Doc)
public void include(String target, String element) throws JspException(Code)(Java Doc)
public void include(String target, String element, boolean editable) throws JspException(Code)(Java Doc)
public void include(String target, String element, boolean editable, Map parameterMap) throws JspException(Code)(Java Doc)
public void include(String target, String element, Map parameterMap) throws JspException(Code)(Java Doc)
public void includeSilent(String target, String element)(Code)(Java Doc)
public void includeSilent(String target, String element, boolean editable)(Code)(Java Doc)
public void includeSilent(String target, String element, boolean editable, Map parameterMap)(Code)(Java Doc)
public void includeSilent(String target, String element, Map parameterMap)(Code)(Java Doc)
public String info(String property)(Code)(Java Doc)
public String label(String label)(Code)(Java Doc)
public String link(String target)(Code)(Java Doc)
public Map properties()(Code)(Java Doc)
public Map properties(String file)(Code)(Java Doc)
public String property(String name)(Code)(Java Doc)
public String property(String name, String file)(Code)(Java Doc)
public String property(String name, String file, String defaultValue)(Code)(Java Doc)
public String property(String name, String file, String defaultValue, boolean escapeHtml)(Code)(Java Doc)
public boolean template(String element)(Code)(Java Doc)
public boolean template(String elementlist, boolean checkall)(Code)(Java Doc)
public boolean template(String element, String elementlist, boolean checkall)(Code)(Java Doc)
public String toAbsolute(String target)(Code)(Java Doc)
public String user(String property)(Code)(Java Doc)
|
|
|