ERXDirectAction Class Reference

Inherits com::webobjects::appserver::WODirectAction.

Inherited by DirectAction, DirectAction, DirectAction, DirectAction, AjaxRemoteLogging.Log, DirectAction, PageAction, ERD2WDirectAction, DirectAction, DirectAction, DirectAction, ERODirectAction, DirectAction, DirectAction, SeleniumAction, DirectAction, SEDirectAction, DirectAction, DirectAction, and PageAction.

Collaboration diagram for ERXDirectAction:

Collaboration graph
[legend]

List of all members.

Public Member Functions

ERXBrowser browser ()
WOActionResults closeHTTPSessionAction ()
WOComponent databaseConsoleAction ()
WOActionResults dumpCreatedKeysAction ()
WOActionResults editLocalizedFilesAction ()
WOActionResults emptyAction ()
WOComponent eoAdaptorDebuggingAction ()
 ERXDirectAction (WORequest r)
WOActionResults eventsAction ()
WOActionResults eventsSetupAction ()
WOActionResults flushComponentCacheAction ()
WOComponent forceGCAction ()
WOComponent log4jAction ()
WOActionResults logoutAction ()
WOActionResults performActionNamed (String actionName)
WOComponent remoteShellAction ()
WOActionResults resetStatsAction ()
WOComponent showOpenEditingContextLockTracesAction ()
WOActionResults statsAction ()
WOActionResults systemPropertyAction ()
WOComponent testAction ()

Static Public Attributes

static final Logger log = Logger.getLogger(ERXDirectAction.class)

Protected Member Functions

boolean canPerformActionWithPasswordKey (String passwordKey)

Package Functions

public< T extends WOComponent > T pageWithName (Class< T > componentClass)

Private Attributes

ERXBrowser browser


Detailed Description

Basic collector for direct action additions. All of the actions are password protected, you need to give an argument "pw" that matches the corresponding system property for the action.

Constructor & Destructor Documentation

ERXDirectAction ( WORequest  r  ) 

Public constructor


Member Function Documentation

Returns the browser object representing the web browser's "user-agent" string. You can obtain browser name, version, platform and Mozilla version, etc. through this object.
Good for WOConditional's condition binding to deal with different browser versions.

Returns:
browser object

boolean canPerformActionWithPasswordKey ( String  passwordKey  )  [protected]

Checks if the action can be executed.

Parameters:
passwordKey 

WOActionResults closeHTTPSessionAction (  ) 

To use this, include this line in appendToResponse on any pages with uploads: AjaxUtils.addScriptResourceInHead(context, response, "Ajax", "prototype.js"); AjaxUtils.addScriptResourceInHead(context, response, "Ajax", "SafariUploadHack.js");

To be called before multi-form submits to get past Safari 3.2.1 and 4.x intermittent hang-ups when posting binary data. A nice succinct description and solution is posted here: http://blog.airbladesoftware.com/2007/8/17/note-to-self-prevent-uploads-hanging-in-safari The radar ticket is here: https://bugs.webkit.org/show_bug.cgi?id=5760

Returns:
simple response to close the connection

WOComponent databaseConsoleAction (  ) 

Action used for accessing the database console

Synopsis:
pw=aPassword
Form Values:
pw password to be checked against the system property er.extensions.ERXRemoteShellPassword.

Returns:
ERXLog4JConfiguration for modifying current logging settings.

WOActionResults dumpCreatedKeysAction (  ) 

WOActionResults editLocalizedFilesAction (  ) 

Opens the localizer edit page if the app is in development mode.

WOActionResults emptyAction (  ) 

Returns an empty response.

Returns:
nothing

WOComponent eoAdaptorDebuggingAction (  ) 

Action used for turning EOAdaptorDebugging output on or off.

Synopsis:
pw=aPassword
Form Values:
pw password to be checked against the system property er.extensions.ERXEOAdaptorDebuggingPassword.
debug flag signaling whether to turn EOAdaptorDebugging on or off (defaults to off). The value should be one of:

  • on
  • true
  • 1
  • y
  • yes
  • off
  • false
  • 0
  • n
  • no

    Note: this action must be invoked against a specific instance (the instance number must be in the request URL).
    Returns:
    a page showing what action was taken (with regard to EOAdaptorDebugging), if any.

WOActionResults eventsAction (  ) 

Direct access to WOEventDisplay by giving over the password in the "pw" parameter.

WOActionResults eventsSetupAction (  ) 

Direct access to WOEventDisplay by giving over the password in the "pw" parameter and turning on all events.

WOActionResults flushComponentCacheAction (  ) 

Flushes the component cache to allow reloading components even when WOCachingEnabled=true.

Returns:
"OK"

WOComponent forceGCAction (  ) 

Action used for forcing garbage collection. If WOCachingEnabled is true (we take this to mean that the application is in production) you need to give a password to access it.

Synopsis:
pw=aPassword
Form Values:
pw password to be checked against the system property er.extensions.ERXGCPassword.

Returns:
short info about free and used memory before and after GC.

WOComponent log4jAction (  ) 

Action used for changing logging settings at runtime. This method is only active when WOCachingEnabled is disabled (we take this to mean that the application is not in production).

Synopsis:
pw=aPassword
Form Values:
pw password to be checked against the system property er.extensions.ERXLog4JPassword.

Returns:
ERXLog4JConfiguration for modifying current logging settings.

WOActionResults logoutAction (  ) 

Reimplemented in DirectAction.

public<T extends WOComponent> T pageWithName ( Class< T >  componentClass  )  [package]

WOActionResults performActionNamed ( String  actionName  ) 

WOComponent remoteShellAction (  ) 

Action used for sending shell commands to the server and receive the result

Synopsis:
pw=aPassword
Form Values:
pw password to be checked against the system property er.extensions.ERXRemoteShellPassword.

Returns:
ERXLog4JConfiguration for modifying current logging settings.

WOActionResults resetStatsAction (  ) 

Direct access to reset the stats by giving over the password in the "pw" parameter. This calls ERXStats.reset();

WOComponent showOpenEditingContextLockTracesAction (  ) 

Returns a list of the traces of open editing context locks. This is only useful if er.extensions.ERXApplication.traceOpenEditingContextLocks is enabled and er.extensions.ERXOpenEditingContextLocksPassword is set.

WOActionResults statsAction (  ) 

Direct access to WOStats by giving over the password in the "pw" parameter.

WOActionResults systemPropertyAction (  ) 

Sets a System property. This is also active in deployment mode because one might want to change a System property at runtime. Synopsis:
pw=aPassword&key=someSystemPropertyKey&value=someSystemPropertyValue

Returns:
either null when the password is wrong or a new page showing the System properties

WOComponent testAction (  ) 

Action used for junit tests. This method is only active when WOCachingEnabled is disabled (we take this to mean that the application is not in production).

Synopsis:
pw=aPassword&case=classNameOfTestCase
Form Values:
pw password to be checked against the system property er.extensions.ERXJUnitPassword. case class name for unit test to be performed.

Returns:
ERXWOTestInterface with the results after performing the given test.


Member Data Documentation

ERXBrowser browser [private]

holds a reference to the current browser used for this session

final Logger log = Logger.getLogger(ERXDirectAction.class) [static]

logging support

Reimplemented in Selenium, DirectAction, ERD2WDirectAction, and SeleniumAction.


The documentation for this class was generated from the following file:

Generated on Sat May 26 06:43:02 2012 for Project Wonder by  doxygen 1.5.8