Package org.opencms.ui.login

Class CmsLoginUI

java.lang.Object
com.vaadin.server.AbstractClientConnector
com.vaadin.ui.AbstractComponent
com.vaadin.ui.AbstractSingleComponentContainer
com.vaadin.ui.UI
org.opencms.ui.A_CmsUI
org.opencms.ui.login.CmsLoginUI
All Implemented Interfaces:
com.vaadin.event.Action.Container, com.vaadin.event.Action.Notifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, com.vaadin.event.UIEvents.PollNotifier, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.LegacyComponent, com.vaadin.ui.SingleComponentContainer, Serializable, Iterable<com.vaadin.ui.Component>, EventListener
public class CmsLoginUI extends A_CmsUI
The UI class for the Vaadin-based login dialog.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CmsLoginUI.Parameters
    Parameters which are initialized during the initial page load of the login dialog.

    Nested classes/interfaces inherited from class com.vaadin.ui.UI

    com.vaadin.ui.UI.WindowOrderUpdateEvent, com.vaadin.ui.UI.WindowOrderUpdateListener

    Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

    com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

    Nested classes/interfaces inherited from interface com.vaadin.ui.Component

    com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

    Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

    com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

    Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

    com.vaadin.server.Sizeable.Unit

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    INIT_DATA_SESSION_ATTR
    Attribute used to store initialization data when the UI is first loaded.

    Fields inherited from class org.opencms.ui.A_CmsUI

    LAST_OFFLINE_PROJECT

    Fields inherited from class com.vaadin.ui.UI

    actionManager

    Fields inherited from class com.vaadin.ui.AbstractComponent

    DESIGN_ATTR_PLAIN_TEXT

    Fields inherited from interface com.vaadin.server.Sizeable

    SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsLoginUI()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearError()
     
    static String
    displayVaadinLoginDialog(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Returns the initial HTML for the Vaadin based login dialog.
    static String
    generateLoginHtmlFragment(CmsObject cms, com.vaadin.server.VaadinRequest request)
    Returns the bootstrap html fragment required to display the login dialog.
    String
    getOrgUnit()
    Gets the selected org unit.
    String
    getPassword()
    Gets the password.
    String
    getPcType()
    Gets the selected PC type.
    String
    getUser()
    Gets the user name.
    protected void
    init(com.vaadin.server.VaadinRequest request)
     
    void
    openLoginTarget(String loginTarget, boolean isPublicPC)
    Opens the login target for a logged in user.
    static void
    setAdminCmsObject(CmsObject cms)
    Sets the admin CMS object.
    void
    setSelectableOrgUnits(List<CmsOrganizationalUnit> ous)
    Sets the org units which should be selectable by the user.
    void
    showAlreadyLoggedIn()
    Show notification that the user is already loogged in.
    void
    showForgotPasswordView(String authToken)
    Shows the 'forgot password view'.
    void
    showLoginError(String messageHtml)
    Shows the given login error message.
    void
    showLoginView(String preselectedOu)
    Initializes the login view.
    void
    showPasswordResetDialog(String orgUnit)
    Shows the password reset dialog.

    Methods inherited from class org.opencms.ui.A_CmsUI

    changeProject, changeSite, closeWindows, get, getAttribute, getCmsObject, getDisplayType, getHttpSession, getLastOfflineProject, getParameters, getWorkplaceSettings, openPageOrWarn, openPageOrWarn, reload, setAttribute, setContentToDialog, setContentToDialog, setError

    Methods inherited from class com.vaadin.ui.UI

    access, accessSynchronously, addAction, addActionHandler, addClickListener, addPollListener, addWindow, addWindowOrderUpdateListener, attach, changeVariables, close, detach, doInit, doRefresh, focus, getActionManager, getActiveDragSource, getComponentCount, getConnectorTracker, getCurrent, getEmbedId, getLastHeartbeatTimestamp, getLastProcessedClientToServerId, getLoadingIndicatorConfiguration, getLocaleService, getNavigator, getNotificationConfiguration, getOverlayContainerLabel, getPage, getPollInterval, getPushConfiguration, getPushConnection, getReconnectDialogConfiguration, getScrollLeft, getScrollTop, getSession, getState, getState, getStateType, getTabIndex, getTheme, getTooltipConfiguration, getUI, getUIId, getUiPathInfo, getUiRootPath, getWindows, isClosing, isConnectorEnabled, isMobileHtml5DndEnabled, isResizeLazy, isUsingThoroughSizeCheck, iterator, paintContent, push, refresh, removeAction, removeActionHandler, removeClickListener, removePollListener, removeWindow, scrollIntoView, setActiveDragSource, setCaption, setContent, setCurrent, setFocusedComponent, setLastHeartbeatTimestamp, setLastProcessedClientToServerId, setMobileHtml5DndEnabled, setNavigator, setOverlayContainerLabel, setPollInterval, setPushConnection, setResizeLazy, setScrollLeft, setScrollTop, setSession, setTabIndex, setTheme, setUsingThoroughSizeCheck, showNotification, showNotification, showNotification, showNotification, showNotification, showNotification

    Methods inherited from class com.vaadin.ui.AbstractSingleComponentContainer

    addComponentAttachListener, addComponentDetachListener, fireComponentAttachEvent, fireComponentDetachEvent, getContent, readDesign, readDesignChildren, removeComponentAttachListener, removeComponentDetachListener, removeFromParent, setHeight, setWidth, writeDesign

    Methods inherited from class com.vaadin.ui.AbstractComponent

    addContextClickListener, addListener, addShortcutListener, addStyleName, beforeClientResponse, findAncestor, fireComponentErrorEvent, fireComponentEvent, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined

    Methods inherited from class com.vaadin.server.AbstractClientConnector

    addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.server.ClientConnector

    addAttachListener, addDetachListener, beforeClientResponse, encodeState, getErrorHandler, getExtensions, getRpcManager, handleConnectorRequest, isAttached, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

    Methods inherited from interface com.vaadin.ui.Component

    addListener, addStyleName, addStyleNames, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesign

    Methods inherited from interface com.vaadin.shared.Connector

    getConnectorId

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface com.vaadin.ui.LegacyComponent

    markAsDirty

    Methods inherited from interface com.vaadin.server.Sizeable

    getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

    Methods inherited from interface com.vaadin.server.VariableOwner

    isEnabled

  • Field Details

  • Constructor Details

  • Method Details

    • displayVaadinLoginDialog

      public static String displayVaadinLoginDialog(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws IOException, CmsException
      Returns the initial HTML for the Vaadin based login dialog.

      Parameters:
      request - the request
      response - the response
      Returns:
      the initial page HTML for the Vaadin login dialog
      Throws:
      IOException - in case writing to the response fails
      CmsException - in case the user has not the required role

    • generateLoginHtmlFragment

      public static String generateLoginHtmlFragment(CmsObject cms, com.vaadin.server.VaadinRequest request) throws IOException
      Returns the bootstrap html fragment required to display the login dialog.

      Parameters:
      cms - the cms context
      request - the request
      Returns:
      the html fragment
      Throws:
      IOException - in case reading the html template fails

    • setAdminCmsObject

      public static void setAdminCmsObject(CmsObject cms)
      Sets the admin CMS object.

      Parameters:
      cms - the admin cms object

    • clearError

      public void clearError()

    • getOrgUnit

      public String getOrgUnit()
      Gets the selected org unit.

      Returns:
      the selected org unit

    • getPassword

      public String getPassword()
      Gets the password.

      Returns:
      the password

    • getPcType

      public String getPcType()
      Gets the selected PC type.

      Returns:
      the PC type

    • getUser

      public String getUser()
      Gets the user name.

      Returns:
      the user name

    • openLoginTarget

      public void openLoginTarget(String loginTarget, boolean isPublicPC)
      Opens the login target for a logged in user.

      Parameters:
      loginTarget - the login target
      isPublicPC - the public PC flag

    • setSelectableOrgUnits

      public void setSelectableOrgUnits(List<CmsOrganizationalUnit> ous)
      Sets the org units which should be selectable by the user.

      Parameters:
      ous - the selectable org units

    • showAlreadyLoggedIn

      public void showAlreadyLoggedIn()
      Show notification that the user is already loogged in.

    • showForgotPasswordView

      public void showForgotPasswordView(String authToken)
      Shows the 'forgot password view'.

      Parameters:
      authToken - the authorization token given as a request parameter

    • showLoginError

      public void showLoginError(String messageHtml)
      Shows the given login error message.

      Parameters:
      messageHtml - the message HTML

    • showLoginView

      public void showLoginView(String preselectedOu)
      Initializes the login view.

      Parameters:
      preselectedOu - a potential preselected OU

    • showPasswordResetDialog

      public void showPasswordResetDialog(String orgUnit)
      Shows the password reset dialog.

      Parameters:
      orgUnit - the OU that should be preselected

    • init

      protected void init(com.vaadin.server.VaadinRequest request)
      Overrides:
      init in class A_CmsUI
      See Also:
      • UI.init(com.vaadin.server.VaadinRequest)