com.saperion.ngc.authorization

Class AuthorizationViewImpl

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Window

com.saperion.ngc.authorization.AuthorizationViewImpl

All Implemented Interfaces:

AuthorizationView, EventChild, Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.IdSpace, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.ext.Framable

public class AuthorizationViewImpl
extends org.zkoss.zul.Window
implements AuthorizationView, EventChild

Logon window. Works with the popup "/popup/authorization.zul".

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zul.Window

org.zkoss.zul.Window.Mode

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zul.Window

EMBEDDED, HIGHLIGHTED, MODAL, OVERLAPPED, POPUP

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface com.saperion.ngc.authorization.AuthorizationView

CLEAR_USER_AND_MANDANT

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface com.saperion.ngc.events.EventChild

ALL_EVENTS, ON_ADD_LINK, ON_ADD_LOOKUP, ON_ADD_TO_FAVORITES, ON_AFTER_QUERY, ON_BUTTON, ON_BUTTON_QUERY, ON_CANCEL, ON_CANCEL_AND, ON_CANCEL_EDIT, ON_CHANGE_DOCUMENT_SECURITY, ON_CHANGE_FOLDER_SECURITY, ON_CLEAR, ON_DELETE_SELECTED, ON_DISPLAY_POPUP, ON_DISPLAY_RESULTITEM, ON_DISPLAY_TEMPORARY_DOCUMENT, ON_DOCUMENT_ADDED, ON_DOCUMENT_CHECK, ON_DOCUMENT_FILING, ON_DOCUMENT_LOCKED, ON_DOCUMENT_RELEASE, ON_DOWNLOAD_RESULTITEM, ON_EDIT_CONTENT, ON_EDIT_FOLDER, ON_EDIT_ITEM, ON_EDIT_ITEM_SELECTED, ON_EDIT_LOOKUP, ON_EDIT_SELECTED, ON_EDIT_STRUCTURE, ON_EXPORT, ON_FAST_ACCESS_DRAG_OVER, ON_FIELD_CHANGE, ON_FILE_ACTION, ON_FILE_PREVIEW, ON_FILE_SEARCH, ON_FORM_CREATED, ON_FORM_RENDER_ERROR, ON_FORWARD, ON_IGNORE, ON_INDEX, ON_INDEX_CLEAR, ON_INDEX_RESULTITEM, ON_ITEM_DOUBLECLICK, ON_LAUNCH_WORKFLOW, ON_LOG, ON_LOGON, ON_MACRO, ON_NAVIGATION, ON_NAVIGATION_FOLDER, ON_NAVIGATION_FORM, ON_NAVIGATION_WEBPART, ON_NEW_ITEM, ON_NEW_SELECTED, ON_OK, ON_OPEN_INDEX_MASK, ON_OPEN_MASK, ON_OPEN_QUERY_MASK, ON_PASSWORD_EXPIRED, ON_PRINT_DOCUMENTS, ON_QUERY, ON_QUERY_FAVORITE, ON_REFRESH, ON_REFRESH_FOLDER, ON_RESET_GUI, ON_REVISION_CREATED, ON_SAVE_AND, ON_SAVE_DOC, ON_SAVE_FOLDER, ON_SCROLL_NODE, ON_SELECT_TREE_ITEM, ON_SELECTDDC, ON_SEND_MAIL_RESULTITEM, ON_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_DOCUMENT, ON_UPLOAD_SUCCESS, ON_VARIABLES_AVAILABLE, ON_WF, ON_WF_COMMENT_DIALOG_CANCEL, ON_WF_COMMENT_DIALOG_OK, ON_WFCOMMENTS, ON_WFDELEGATE, ON_WFFORWARD, ON_WFFORWARD1, ON_WFFORWARD2, ON_WFFORWARD3, ON_WFFORWARD4, ON_WFFORWARD5, ON_WFHISTORY, ON_WFPUTBACK, ON_WFREMINDER, ON_WFTAKE, ON_WORKFLOW_ACTION, ON_WORKFLOW_COMMENT

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
AuthorizationViewImpl() Constructor.

Method Summary

Modifier and Type	Method and Description
void	disableAuthorizationView() Disable view.
void	enableAuthorizationView() Enable view.
Set<org.zkoss.zk.ui.Component>	getEventtarget(String eventName) Reads the event target for the given event name, if set or the root element.
void	invalidateSession() Invalidates the current running session.
void	onCreate() Called when the view is created.
void	onLogon(org.zkoss.zk.ui.event.Event event) Event handler for LogonEvent.
void	onPasswordExpired(org.zkoss.zk.ui.event.Event event) Event handler for PasswordExpiredEvent.
void	postErrorLogEvent(LogMessage message) Posts an ErrorLogEvent.
void	postInfoLogEvent(LogMessage message) Posts an InfoLogEvent.
void	postLogonEvent(LogonEvent.LogonResult result, String userName) Post a logon event.
void	setEventtarget(org.zkoss.zk.ui.Component comp, String eventName) Set the event target.
void	setLocaleList(List<Locale> localeList) set Locales in Language Combobox .
void	setLogoffWarningDisabled(boolean disabled) The WebClient displays a warning-message when a user closes the browser window or navigates to another page without having logged off from the system before.
void	setRedirectAfterLogoffDisabled(boolean disabled) For security reasons the WebClient redirects to self after a user has logged of.
void	setSelectedLocale(Locale selectLocale) setSelectedLocale in Language Combobox .
void	setSelectedUserType(UserType userType) setSelectedUserType in userType Combobox .
void	setSingleMandant(boolean isSingleMandant) Set single mandant.
void	setSsoLogin() For specific SSO providers the identity token e.g OpenId Connect is expired after some time.
void	setUserTypeList(List<UserType> userTypeList) Set user types.

Methods inherited from class org.zkoss.zul.Window

beforeChildAdded, clone, doEmbedded, doHighlighted, doModal, doOverlapped, doPopup, getBorder, getCaption, getContentSclass, getContentStyle, getDefaultActionOnShow, getMinheight, getMinwidth, getMode, getModeType, getPosition, getTitle, getZclass, inEmbedded, inHighlighted, inModal, inOverlapped, inPopup, insertBefore, isClosable, isCollapsible, isMaximizable, isMaximized, isMinimizable, isMinimized, isShadow, isSizable, onChildRemoved, onClose, onModal, onPageDetached, renderProperties, service, setBorder, setBorder, setClosable, setContentSclass, setContentStyle, setDefaultActionOnShow, setDraggable, setMaximizable, setMaximized, setMinheight, setMinimizable, setMinimized, setMinwidth, setMode, setMode, setMode, setPosition, setShadow, setSizable, setTitle, setTopmost, setVisible

Methods inherited from class org.zkoss.zul.impl.XulElement

getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

addSclass, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onPageAttached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zk.ui.Component

addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Methods inherited from interface org.zkoss.zk.ui.IdSpace

getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow

Constructor Detail

AuthorizationViewImpl

public AuthorizationViewImpl()

Constructor.

Method Detail

onCreate

public void onCreate()

Called when the view is created.

enableAuthorizationView

public void enableAuthorizationView()

Enable view.

Specified by:

enableAuthorizationView in interface AuthorizationView

disableAuthorizationView

public void disableAuthorizationView()

Disable view.

Specified by:

disableAuthorizationView in interface AuthorizationView

setUserTypeList

public void setUserTypeList(List<UserType> userTypeList)

Set user types.

Specified by:

setUserTypeList in interface AuthorizationView

Parameters:

userTypeList - user types

setLocaleList

public void setLocaleList(List<Locale> localeList)

set Locales in Language Combobox .

Specified by:

setLocaleList in interface AuthorizationView

Parameters:

localeList - localeList

setSelectedLocale

public void setSelectedLocale(Locale selectLocale)

setSelectedLocale in Language Combobox .

Specified by:

setSelectedLocale in interface AuthorizationView

Parameters:

selectLocale - selectLocale

setSelectedUserType

public void setSelectedUserType(UserType userType)

setSelectedUserType in userType Combobox .

Specified by:

setSelectedUserType in interface AuthorizationView

Parameters:

userType - userType

setSingleMandant

public void setSingleMandant(boolean isSingleMandant)

Set single mandant.

Specified by:

setSingleMandant in interface AuthorizationView

Parameters:

isSingleMandant - isSingleMandant

invalidateSession

public void invalidateSession()

Invalidates the current running session.

Specified by:

invalidateSession in interface AuthorizationView

onLogon

public void onLogon(org.zkoss.zk.ui.event.Event event)

Event handler for LogonEvent.

Specified by:

onLogon in interface AuthorizationView

Parameters:

event - event to handle

See Also:

AuthorizationView.onLogon(org.zkoss.zk.ui.event.Event)

getEventtarget

public Set<org.zkoss.zk.ui.Component> getEventtarget(String eventName)

Reads the event target for the given event name, if set or the root element.

Specified by:

getEventtarget in interface EventChild

Parameters:

eventName - Event name or null for main target

Returns:

Set of event targets

See Also:

EventChild.getEventtarget(java.lang.String)

postLogonEvent

public void postLogonEvent(LogonEvent.LogonResult result,
                           String userName)

Post a logon event.

Specified by:

postLogonEvent in interface AuthorizationView

Parameters:

result - logon result

userName - user name

See Also:

EventChildHandler.postLogonEvent(com.saperion.ngc.events.LogonEvent.LogonResult, java.lang.String)

setEventtarget

public void setEventtarget(org.zkoss.zk.ui.Component comp,
                           String eventName)

Set the event target.

Specified by:

setEventtarget in interface EventChild

Parameters:

comp - Event target

eventName - Event name or null for main target

See Also:

EventChild.setEventtarget(org.zkoss.zk.ui.Component, java.lang.String)

postErrorLogEvent

public void postErrorLogEvent(LogMessage message)

Posts an ErrorLogEvent.

Specified by:

postErrorLogEvent in interface AuthorizationView

Parameters:

message - LogMessage

See Also:

LogEventChildHandler.postErrorLogEvent(LogMessage)

postInfoLogEvent

public void postInfoLogEvent(LogMessage message)

Posts an InfoLogEvent.

Specified by:

postInfoLogEvent in interface AuthorizationView

Parameters:

message - LogMessage

See Also:

LogEventChildHandler.postInfoLogEvent(LogMessage)

setLogoffWarningDisabled

public void setLogoffWarningDisabled(boolean disabled)

The WebClient displays a warning-message when a user closes the browser window or navigates to another page without having logged off from the system before. By setting this parameter to true, this warning message can be disabled.

Specified by:

setLogoffWarningDisabled in interface AuthorizationView

Parameters:

disabled - true to disabled warning message

See Also:

AuthorizationView.setLogoffWarningDisabled(boolean)

setRedirectAfterLogoffDisabled

public void setRedirectAfterLogoffDisabled(boolean disabled)

For security reasons the WebClient redirects to self after a user has logged of. By setting this parameter to true, the redirecting is disabled. This might be required when parts of the WebClient are included in a portal or some other page.

Specified by:

setRedirectAfterLogoffDisabled in interface AuthorizationView

Parameters:

disabled - true to disable redirecting after logoff

See Also:

AuthorizationView.setRedirectAfterLogoffDisabled(boolean)

setSsoLogin

public void setSsoLogin()

For specific SSO providers the identity token e.g OpenId Connect is expired after some time. Also the refresh token. This leads to opening the Login dialog, without any chance for relogin. If it was a SsoLogin, then a relogin with SSO button should be available. This method should dis-/enable the Relogin with SSO button depends on login type.

Specified by:

setSsoLogin in interface AuthorizationView

See Also:

AuthorizationView.setSsoLogin()

onPasswordExpired

public void onPasswordExpired(org.zkoss.zk.ui.event.Event event)

Event handler for PasswordExpiredEvent.

Specified by:

onPasswordExpired in interface AuthorizationView

Parameters:

event - event to handle

See Also:

AuthorizationView.onPasswordExpired(org.zkoss.zk.ui.event.Event)