com.filenet.wcm.apps.server.ui.select

Class WcmSecurityAccessSelect

java.lang.Object
com.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.toolkit.server.ui.WcmJSPModule
com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
com.filenet.wcm.apps.server.ui.select.WcmSecurityAccessSelect

All implemented interfaces:

com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmSecurityAccessSelect
extends WcmWorkplaceLayoutModule

The WcmSecurityAccessSelect class displays the detail view of a grantee's access rights. It uses the WcmSecurityAccessSelect.xsl to display the access rights of the current selected grantee returned by the WcmAuthoringDataProvider. This class also uses the WcmSecurityUtil class extensively to compute and update the security data.

See Also:

WcmSecurityUtil, WcmAuthoringDataProvider

Field Summary

Fields inherited from class com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
`bannerModule, contextMenu, footerLinksBarModule, footerModule, leftCSSClass, MAIN_MODE, multiSelectMenu, OPERATION_MODE, renderLeftBar, showFooterLinksBar, tabBarModule, treeModule`

Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
`jspMode, layout`

Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
`locale, NAME_DELIMITER`

Constructor Summary

Constructor and Description
`WcmSecurityAccessSelect()` Create a new WcmSecurityAccessSelect object for displaying the selected grantee's access rights.

Method Summary

Modifier and Type	Method and Description
void	`cleanup()` Cleans up session data to reduce resource usage.
java.lang.String	`getFormName()` Returns the form name used by the WcmSecurityAccessSelect UI so that the container object can use the same form name to submit events.\
WcmSecurityUtil	`getSecurityUtil()` Accessor method to return the WcmSecurityUtil object.
WcmTextLinksBar	`getTextLinksBar()` Accessor method to return the WcmTextLinksBar object.
com.filenet.wcm.toolkit.server.ui.WcmXSLModule	`getXSLModule()` Accessor method to return the WcmXSLModule object.
void	`initialize()` Initializes data providers and XSL parameters.
void	`onAccept(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Handles the Modify event triggered by the user selecting the Continue link.
void	`onClose(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Handles the Cancel event triggered by the user selecting the Cancel link.
void	`onSelectAccess(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Handles the Select Access event triggered by the user selecting one of the access checkboxes.
void	`onSelectView(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` The updated selected grantee's access right is saved to the Permission Object XML using the WcmSecurityUtil module.
void	`onStartPage(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Handles the Start Page event triggered by the controller.
void	`onUpdate(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Handles the Update event triggered by the user selecting the Continue link on the warning page.

Methods inherited from class com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
`addModule, addModule, addPrimaryPageAnchors, createLayout, getAnchorTree, getBannerBar, getFooter, getFooterLinksBar, getOperationTitle, getPageTabId, getPrimaryPageAnchors, getTabBar, isAdminLinkAvailable, registerAddedModules, renderLayout, resetPrimaryPageAnchors, setAddContextMenu, setMode, setOperationTitle, setOperationTitle, setOperationTitle, setOperationTitle, setRemoveTreeModule, setShowFooterLinksBar, setTabBarSelection`

Methods inherited from class com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule

addModule, addModule, addPrimaryPageAnchors, createLayout, getAnchorTree, getBannerBar, getFooter, getFooterLinksBar, getOperationTitle, getPageTabId, getPrimaryPageAnchors, getTabBar, isAdminLinkAvailable, registerAddedModules, renderLayout, resetPrimaryPageAnchors, setAddContextMenu, setMode, setOperationTitle, setOperationTitle, setOperationTitle, setOperationTitle, setRemoveTreeModule, setShowFooterLinksBar, setTabBarSelection

Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
`getLayout, render, setJSP`

Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmJSPModule
`getCurrentModule`

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
`getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive`

getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive

Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
`subscribeGlobalEvent`

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
`addChild, addChild, addChild, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty`

addChild, addChild, addChild, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
`addDataProvider, addDataProvider`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
`addDataProvider, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent`

Constructor Detail

WcmSecurityAccessSelect

public WcmSecurityAccessSelect( )
throws java.lang.Exception

Create a new WcmSecurityAccessSelect object for displaying the selected grantee's access rights.

Throws:

java.lang.Exception - All errors.

Method Detail

initialize

public void initialize()
throws java.lang.Exception

Initializes data providers and XSL parameters.

Specified by:

initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface

Overrides:

initialize in class WcmWorkplaceLayoutModule

Throws:

java.lang.Exception - All errors.

See Also:

WcmAuthoringDataProvider

getFormName

public java.lang.String getFormName( )

Returns the form name used by the WcmSecurityAccessSelect UI so that the container object can use the same form name to submit events.\

Specified by:

getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

getFormName in class com.filenet.wcm.toolkit.server.base.WcmUiModule

Returns:

String The html form name.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Handles the Start Page event triggered by the controller.

Data is retrieved from the WcmAuthoringDataProvider class property and all XSL parameters are set for the XSL rendering process.

Specified by:

onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

onStartPage in class com.filenet.wcm.toolkit.server.base.GlobalEventModule

Parameters:

request - The JSP request object.

response - The JSP response object.

Throws:

java.lang.Exception - All errors.

See Also:

WcmAuthoringDataProvider

onSelectView

public void onSelectView(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

The updated selected grantee's access right is saved to the Permission Object XML using the WcmSecurityUtil module. The module then redirects back to the calling page.

Parameters:

request - The JSP request object.

response - The JSP response object.

Throws:

java.lang.Exception - All errors.

See Also:

WcmSecurityUtil

onSelectAccess

public void onSelectAccess(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Handles the Select Access event triggered by the user selecting one of the access checkboxes.

The selected access level is granted or denied based on the user's selection using the WcmSecurityUtil module.

Parameters:

request - The JSP request object.

response - The JSP response object.

Throws:

java.lang.Exception - All errors.

See Also:

WcmSecurityUtil

onClose

public void onClose(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Handles the Cancel event triggered by the user selecting the Cancel link.

Discards changes made to the grantee's security. Gets the return URL and redirect back to the calling page.

Parameters:

request - The JSP request object.

response - The JSP response object.

Throws:

java.lang.Exception - All errors.

See Also:

WcmSecurityUtil

onAccept

public void onAccept(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Handles the Modify event triggered by the user selecting the Continue link.

The updated selected grantee's access right is saved to the Permission Object XML using the WcmSecurityUtil module. A warning page will be shown if an explicit deny entry existed and was set for the first time by the user. The user is then required to confirm the selection by clicking on the Continue link in the warning page.

Parameters:

request - The JSP request object.

response - The JSP response object.

Throws:

java.lang.Exception - All errors.

See Also:

WcmSecurityUtil

onUpdate

public void onUpdate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Handles the Update event triggered by the user selecting the Continue link on the warning page.

The updated selected grantee's access right is saved to the Permission Object XML using the WcmSecurityUtil module. The module then redirects back to the calling page.

Parameters:

request - The JSP request object.

response - The JSP response object.

Throws:

java.lang.Exception - All errors.

See Also:

WcmSecurityUtil

cleanup

public void cleanup()
throws java.lang.Exception

Cleans up session data to reduce resource usage.

Specified by:

cleanup in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface

Overrides:

cleanup in class com.filenet.wcm.toolkit.server.base.WcmModule

Throws:

java.lang.Exception - All errors.

getTextLinksBar

public WcmTextLinksBar getTextLinksBar( )

Accessor method to return the WcmTextLinksBar object.

Returns:

WcmTextLinksBar object.

getSecurityUtil

public WcmSecurityUtil getSecurityUtil( )

Accessor method to return the WcmSecurityUtil object.

Returns:

WcmSecurityUtil object.

getXSLModule

public com.filenet.wcm.toolkit.server.ui.WcmXSLModule getXSLModule( )

Accessor method to return the WcmXSLModule object.

Returns:

WcmXSLModule object.