org.apache.jetspeed.layout.impl
Class BaseUserAction

java.lang.Object
  extended by org.apache.jetspeed.layout.impl.BaseUserAction
All Implemented Interfaces:
AjaxAction, AjaxBuilder, Constants
Direct Known Subclasses:
GetUserInformationAction, GetUserListAction

public abstract class BaseUserAction
extends java.lang.Object
implements AjaxAction, AjaxBuilder, Constants

Abstract portlet placement action

Version:
$Id: $
Author:
David Gurney, David Sean Taylor, Mikko Wuokko

Field Summary
protected  java.lang.String errorTemplate
           
protected  org.apache.commons.logging.Log log
           
protected  RolesSecurityBehavior securityBehavior
           
protected  java.lang.String template
           
protected  UserManager userManager
           
 
Fields inherited from interface org.apache.jetspeed.layout.impl.Constants
ABS, ACTION, CARTESIAN, COL, CUSTOM_MENUS, DEFAULT_LAYOUT, DESKTOP_EXTENDED, DESKTOP_PAGE_DECORATIONS, DESKTOP_PORTLET_DECORATIONS, DESTINATION, DOWN, FILTER, FOLDER, FOLDERS, FORMAT, FRAGMENTID, FRAGMENTS, GUESTUSERS, HEIGHT, INCLUDE_MENU_DEFS, IPADDRESS, LAYOUT, LAYOUTID, LAYOUTS, LEFT, LINK, LINKS, MENU, MENU_CONTEXT, MENU_DEFINITIONS, MENU_LOCALE, MENU_NAME, METADATA, NEWCOL, NEWROW, OFFLINE, OLD_DESKTOP_EXTENDED, OLD_HEIGHT, OLD_PORTLET_MODE, OLD_WIDTH, OLD_WINDOW_STATE, OLD_X, OLD_Y, OLD_Z, OLDCOL, OLDROW, ONLINE, PAGE, PAGE_DECORATIONS, PAGE_QUALIFIED_CREATE_ON_EDIT, PAGES, PORTLET_DECORATIONS, PORTLET_MODE, PORTLETENTITY, PORTLETID, PORTLETS, PROFILED_PATH, REASON, RESOURCE_NAME, RIGHT, ROLES, ROW, SECURITY_DEFS, SECURITY_OWNER, SECURITY_REFS, SESSIONS, SHORT_TITLE, SIZES, SOURCE, STANDARD_MENUS, STATUS, TITLE, TYPE, UP, USER_IS_ANONYMOUS, USERINFO, USERNAME, USERS, WIDTH, WINDOW_STATE, X, Y, Z
 
Constructor Summary
BaseUserAction(java.lang.String template, java.lang.String errorTemplate, RolesSecurityBehavior securityBehavior)
           
BaseUserAction(java.lang.String template, java.lang.String errorTemplate, UserManager userManager)
           
BaseUserAction(java.lang.String template, java.lang.String errorTemplate, UserManager userManager, RolesSecurityBehavior securityBehavior)
           
 
Method Summary
 boolean buildContext(RequestContext requestContext, java.util.Map responseContext)
          Build the normal context template
 boolean buildErrorContext(RequestContext requestContext, java.util.Map responseContext)
          Build the error context template
 boolean checkAccess(RequestContext context, java.lang.String action)
          Checks to see if the current subject has access to to execute this action.
 boolean createNewPageOnEdit(RequestContext context)
           
 java.lang.String getActionParameter(RequestContext requestContext, java.lang.String name)
           
 java.lang.String getErrorTemplate()
           
 Fragment getFragmentIdFromLocation(int row, int column, Page page)
           
 Fragment getParentFragmentById(java.lang.String id, Fragment root)
           
 java.lang.String getTemplate()
           
 boolean isTrue(java.lang.String parameter)
          Helper method to determine if a parameter is true.
 boolean runBatch(RequestContext requestContext, java.util.Map resultMap)
          Same as run method, but runs in batch mode, as a hint to the action that it is running a multiple action and can delay its update runBatch currently supports pageManager.updatePage
protected  Fragment searchForParentFragmentById(java.lang.String id, Fragment parent)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.ajax.AjaxAction
run
 

Field Detail

log

protected org.apache.commons.logging.Log log

template

protected java.lang.String template

userManager

protected UserManager userManager

errorTemplate

protected java.lang.String errorTemplate

securityBehavior

protected RolesSecurityBehavior securityBehavior
Constructor Detail

BaseUserAction

public BaseUserAction(java.lang.String template,
                      java.lang.String errorTemplate,
                      RolesSecurityBehavior securityBehavior)

BaseUserAction

public BaseUserAction(java.lang.String template,
                      java.lang.String errorTemplate,
                      UserManager userManager)

BaseUserAction

public BaseUserAction(java.lang.String template,
                      java.lang.String errorTemplate,
                      UserManager userManager,
                      RolesSecurityBehavior securityBehavior)
Method Detail

buildContext

public boolean buildContext(RequestContext requestContext,
                            java.util.Map responseContext)
Description copied from interface: AjaxBuilder
Build the normal context template

Specified by:
buildContext in interface AjaxBuilder
Parameters:
requestContext - The Jetspeed Request Context
responseContext - Context variables to be substituted into template
Returns:
true on success false onerror

buildErrorContext

public boolean buildErrorContext(RequestContext requestContext,
                                 java.util.Map responseContext)
Description copied from interface: AjaxBuilder
Build the error context template

Specified by:
buildErrorContext in interface AjaxBuilder
Parameters:
requestContext - The Jetspeed Request Context
responseContext - Context variables to be substituted into template
Returns:
true on success false onerror

getErrorTemplate

public java.lang.String getErrorTemplate()
Specified by:
getErrorTemplate in interface AjaxBuilder
Returns:
the name of the error template used for this builder

getTemplate

public java.lang.String getTemplate()
Specified by:
getTemplate in interface AjaxBuilder
Returns:
the name of the template used for this builder

checkAccess

public boolean checkAccess(RequestContext context,
                           java.lang.String action)
Description copied from interface: AjaxAction
Checks to see if the current subject has access to to execute this action.

Specified by:
checkAccess in interface AjaxAction
Returns:
true if access granted, false if denied.

createNewPageOnEdit

public boolean createNewPageOnEdit(RequestContext context)

getFragmentIdFromLocation

public Fragment getFragmentIdFromLocation(int row,
                                          int column,
                                          Page page)

runBatch

public boolean runBatch(RequestContext requestContext,
                        java.util.Map resultMap)
                 throws AJAXException
Description copied from interface: AjaxAction
Same as run method, but runs in batch mode, as a hint to the action that it is running a multiple action and can delay its update runBatch currently supports pageManager.updatePage

Specified by:
runBatch in interface AjaxAction
Parameters:
requestContext - The Jetspeed Request Context
resultMap - map of action parameters passed to the builder context
Returns:
success is true, failure is false
Throws:
AJAXException

getActionParameter

public java.lang.String getActionParameter(RequestContext requestContext,
                                           java.lang.String name)

getParentFragmentById

public Fragment getParentFragmentById(java.lang.String id,
                                      Fragment root)

searchForParentFragmentById

protected Fragment searchForParentFragmentById(java.lang.String id,
                                               Fragment parent)

isTrue

public boolean isTrue(java.lang.String parameter)
Helper method to determine if a parameter is true. Prevents accidental NullPointerExceptions when comparing or or using the parameter value.

Parameters:
parameter - The value to be determined as boolean true or false.
Returns:
boolean true or false according to the @param value.


Copyright © 1999-2010 Apache Software Foundation. All Rights Reserved.