com.filenet.wcm.apps.server.ui
Class WcmSecurityPolicyModule

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.apps.server.ui.WcmSecurityPolicyModule
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmSecurityPolicyModule
extends com.filenet.wcm.toolkit.server.base.WcmUiModule


Field Summary
static int HIDE
           
static int MODIFY
           
static int READ_ONLY
           
static com.filenet.wcm.toolkit.util.WcmString wsAssignPolicy
           
static com.filenet.wcm.toolkit.util.WcmString wsNotDefined
           
static com.filenet.wcm.toolkit.util.WcmString wsNotSelected
           
static com.filenet.wcm.toolkit.util.WcmString wsSecurityPolicy
           
static com.filenet.wcm.toolkit.util.WcmString wsUnAssignPolicy
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmSecurityPolicyModule()
          Create a new WcmSecurityPolicyModule object for displaying the security policy.
WcmSecurityPolicyModule(int mode)
          Constructor sets the WcmSecurityPolicyModule mode to one of the static int mode values.
WcmSecurityPolicyModule(int mode, boolean multiAction, java.lang.String objStoreName)
          Constructor sets the WcmSecurityPolicyModule mode to one of the static int mode values.
 
Method Summary
 void cleanup()
          Cleans up session data to reduce resource usage.
 int getMode()
          Returns the WcmSecurityPolicyModule mode.
 java.lang.String getSecurityPolicyId()
          Gets the selected Policy Id.
 java.lang.String getSecurityPolicyName()
          Gets the selected Policy Name.
 void initialize()
          Initializes the WcmSecurityPolicyModule class.
 void onSelectPolicy(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select Policy event handler.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onUnAssignPolicy(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Unassign Policy event handler.
 void render(java.io.Writer w)
          Renders the WcmSecurityPolicyModule in HTML.
 void setMode(int mode)
          Sets the WcmSecurityPolicyModule mode to one of the static int mode values.
 void setSecurityPolicyId(java.lang.String securityPolicyId)
          Sets the selected Policy Id into module properties.
 void setSecurityPolicyName(java.lang.String securityPolicyName)
          Sets the selected Policy Name into module properties.
 
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, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
subscribeGlobalEvent
 
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
 
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
 

Field Detail

wsSecurityPolicy

public static final com.filenet.wcm.toolkit.util.WcmString wsSecurityPolicy

wsNotDefined

public static final com.filenet.wcm.toolkit.util.WcmString wsNotDefined

wsNotSelected

public static final com.filenet.wcm.toolkit.util.WcmString wsNotSelected

wsAssignPolicy

public static final com.filenet.wcm.toolkit.util.WcmString wsAssignPolicy

wsUnAssignPolicy

public static final com.filenet.wcm.toolkit.util.WcmString wsUnAssignPolicy

MODIFY

public static final int MODIFY
See Also:
Constant Field Values

READ_ONLY

public static final int READ_ONLY
See Also:
Constant Field Values

HIDE

public static final int HIDE
See Also:
Constant Field Values
Constructor Detail

WcmSecurityPolicyModule

public WcmSecurityPolicyModule()
                        throws java.lang.Exception
Create a new WcmSecurityPolicyModule object for displaying the security policy.


WcmSecurityPolicyModule

public WcmSecurityPolicyModule(int mode)
                        throws java.lang.Exception
Constructor sets the WcmSecurityPolicyModule mode to one of the static int mode values.

Parameters:
mode - int specifying the operation mode.

WcmSecurityPolicyModule

public WcmSecurityPolicyModule(int mode,
                               boolean multiAction,
                               java.lang.String objStoreName)
                        throws java.lang.Exception
Constructor sets the WcmSecurityPolicyModule mode to one of the static int mode values.

Parameters:
mode - int specifying the operation mode.
multiAction - boolean true to use it in a multi action setttings.
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the WcmSecurityPolicyModule class.

Throws:
java.lang.Exception

onStartPage

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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the WcmSecurityPolicyModule in HTML.

Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.

onSelectPolicy

public void onSelectPolicy(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Select Policy event handler.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

onUnAssignPolicy

public void onUnAssignPolicy(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception
Unassign Policy event handler.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

setSecurityPolicyId

public void setSecurityPolicyId(java.lang.String securityPolicyId)
                         throws java.lang.Exception
Sets the selected Policy Id into module properties.

Parameters:
securityPolicyId - String security policy id.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getSecurityPolicyId

public java.lang.String getSecurityPolicyId()
                                     throws java.lang.Exception
Gets the selected Policy Id.

Returns:
String Security policy id.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

setSecurityPolicyName

public void setSecurityPolicyName(java.lang.String securityPolicyName)
                           throws java.lang.Exception
Sets the selected Policy Name into module properties.

Parameters:
securityPolicyName - String security policy name.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getSecurityPolicyName

public java.lang.String getSecurityPolicyName()
                                       throws java.lang.Exception
Gets the selected Policy Name.

Returns:
String Security policy name.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

cleanup

public void cleanup()
             throws java.lang.Exception
Cleans up session data to reduce resource usage.

Throws:
java.lang.Exception - All errors.

setMode

public void setMode(int mode)
Sets the WcmSecurityPolicyModule mode to one of the static int mode values.

Parameters:
mode - int specifying the operation mode.

getMode

public int getMode()
Returns the WcmSecurityPolicyModule mode.



© Copyright IBM Corp. 2002, 2007. All Rights Reserved.