Package org.opencms.ui.apps.user

Class CmsImportExportUserDialog

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.AbstractOrderedLayout

com.vaadin.ui.VerticalLayout

org.opencms.ui.components.CmsBasicDialog

org.opencms.ui.apps.user.A_CmsImportExportUserDialog

org.opencms.ui.apps.user.CmsImportExportUserDialog

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler, com.vaadin.ui.Upload.Receiver, Serializable, Iterable<com.vaadin.ui.Component>, I_CmsPasswordFetcher

public final class CmsImportExportUserDialog
extends A_CmsImportExportUserDialog
implements com.vaadin.ui.Upload.Receiver, I_CmsPasswordFetcher

Dialog for CSV im- and export.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.ui.components.CmsBasicDialog

CmsBasicDialog.DialogWidth

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.ui.Layout

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

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	DIALOG_HEIGHT	The dialog height.
protected com.vaadin.ui.Label	m_uploadname	Label to show uploaded file.

Fields inherited from class org.opencms.ui.apps.user.A_CmsImportExportUserDialog

m_ou, m_window

Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

ALIGNMENT_DEFAULT, components

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

Method Summary

Modifier and Type	Method	Description
static Map<CmsUUID,CmsUser>	addExportAllUsers(CmsObject cms, String ou, Map<CmsUUID,CmsUser> exportUsers)	Returns a map with the users to export added.
static Map<CmsUUID,CmsUser>	addExportUsersFromGroups(CmsObject cms, List<String> groups, Map<CmsUUID,CmsUser> exportUsers)	Returns a map with the users to export added.
static Map<CmsUUID,CmsUser>	addExportUsersFromRoles(CmsObject cms, String ou, List<String> roles, Map<CmsUUID,CmsUser> exportUsers)	Returns a map with the users to export added.
void	fetchPassword(String password)	Fetches password.
static CmsImportExportUserDialog	getExportUserDialogForGroup(CmsUUID groupID, String ou, com.vaadin.ui.Window window, boolean allowTechnicalFieldsExport)	Gets an dialog instance for fixed group.
static CmsImportExportUserDialog	getExportUserDialogForOU(String ou, com.vaadin.ui.Window window, boolean allowTechnicalFieldsExport)	Gets an dialog instance for fixed group.
protected CmsPrincipalSelect	getGroupSelect(String ou, boolean enabled, CmsUUID groupID)	Get a principle select for choosing groups.
protected com.vaadin.ui.ComboBox<CmsRole>	getRoleComboBox(String ou)	Get ComboBox for selecting roles.
protected List<CmsUser>	getUsersFromFile()	Reads user from import file.
protected void	importUserFromFile()	Import user from file.
OutputStream	receiveUpload(String filename, String mimeType)

Methods inherited from class org.opencms.ui.apps.user.A_CmsImportExportUserDialog

init, initDownloadButton, isExportable

Methods inherited from class org.opencms.ui.components.CmsBasicDialog

addButton, addButton, createButtonCancel, createButtonClose, createButtonOK, createResourceListPanel, createResourceListPanelDirectly, displayResourceInfo, displayResourceInfo, displayResourceInfo, displayResourceInfoDirectly, enableMaxHeight, getInfoResources, initActionHandler, prepareWindow, prepareWindow, readDesign, setAbove, setActionHandler, setBelow, setContent, setContentMinHeight, setContentVisibility, setWindowMinFullHeight

Methods inherited from class com.vaadin.ui.VerticalLayout

addComponentsAndExpand, getState, getState

Methods inherited from class com.vaadin.ui.AbstractOrderedLayout

addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getExpandRatio, getMargin, isSpacing, iterator, removeComponent, removeLayoutClickListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setExpandRatio, setMargin, setMargin, setSpacing, writeDesign

Methods inherited from class com.vaadin.ui.AbstractLayout

readMargin, writeMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, 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, getSession, getStateType, getUI, 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, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.ui.Component

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

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponents, getComponentIterator, moveComponentsFrom, removeAllComponents

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.server.Sizeable

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

Field Details

DIALOG_HEIGHT

public static final String DIALOG_HEIGHT

The dialog height.

See Also:

• Constant Field Values

m_uploadname

protected com.vaadin.ui.Label m_uploadname

Label to show uploaded file.

Method Details

addExportAllUsers

public static Map<CmsUUID,CmsUser> addExportAllUsers(CmsObject cms,
 String ou,
 Map<CmsUUID,CmsUser> exportUsers)
                                              throws CmsException

Returns a map with the users to export added.

Parameters:

cms - CmsObject

ou - ou name

exportUsers - the map to add the users

Returns:

a map with the users to export added

Throws:

CmsException - if getting users failed

addExportUsersFromGroups

public static Map<CmsUUID,CmsUser> addExportUsersFromGroups(CmsObject cms,
 List<String> groups,
 Map<CmsUUID,CmsUser> exportUsers)
                                                     throws CmsException

Returns a map with the users to export added.

Parameters:

cms - CmsObject

groups - the selected groups

exportUsers - the map to add the users

Returns:

a map with the users to export added

Throws:

CmsException - if getting groups or users of group failed

addExportUsersFromRoles

public static Map<CmsUUID,CmsUser> addExportUsersFromRoles(CmsObject cms,
 String ou,
 List<String> roles,
 Map<CmsUUID,CmsUser> exportUsers)
                                                    throws CmsException

Returns a map with the users to export added.

Parameters:

cms - CmsObject

ou - ou name

roles - the selected roles

exportUsers - the map to add the users

Returns:

a map with the users to export added

Throws:

CmsException - if getting roles or users of role failed

getExportUserDialogForGroup

public static CmsImportExportUserDialog getExportUserDialogForGroup(CmsUUID groupID,
 String ou,
 com.vaadin.ui.Window window,
 boolean allowTechnicalFieldsExport)

Gets an dialog instance for fixed group.

Parameters:

groupID - id

ou - ou name

window - window

allowTechnicalFieldsExport - flag indicates if technical field export option should be available

Returns:

an instance of this class

getExportUserDialogForOU

public static CmsImportExportUserDialog getExportUserDialogForOU(String ou,
 com.vaadin.ui.Window window,
 boolean allowTechnicalFieldsExport)

Gets an dialog instance for fixed group.

Parameters:

ou - ou name

window - window

allowTechnicalFieldsExport - flag indicates if technical field export option should be available

Returns:

an instance of this class

fetchPassword

public void fetchPassword(String password)

Description copied from interface: I_CmsPasswordFetcher

Fetches password.

Specified by:

fetchPassword in interface I_CmsPasswordFetcher

Parameters:

password - string

See Also:

• I_CmsPasswordFetcher.fetchPassword(java.lang.String)

receiveUpload

public OutputStream receiveUpload(String filename,
 String mimeType)

Specified by:

receiveUpload in interface com.vaadin.ui.Upload.Receiver

See Also:

• Upload.Receiver.receiveUpload(java.lang.String, java.lang.String)

getGroupSelect

protected CmsPrincipalSelect getGroupSelect(String ou,
 boolean enabled,
 CmsUUID groupID)

Get a principle select for choosing groups.

Parameters:

ou - name

enabled - enabled?

groupID - default value

Returns:

CmsPrinicpalSelect

getRoleComboBox

protected com.vaadin.ui.ComboBox<CmsRole> getRoleComboBox(String ou)

Get ComboBox for selecting roles.

Parameters:

ou - name

Returns:

ComboBox

getUsersFromFile

protected List<CmsUser> getUsersFromFile()

Reads user from import file.

Returns:

List of user (with passwords)

importUserFromFile

protected void importUserFromFile()

Import user from file.