org.apache.cocoon.components.modules.input
Class SystemPropertyModule

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.modules.input.AbstractInputModule
          org.apache.cocoon.components.modules.input.AbstractJXPathModule
              org.apache.cocoon.components.modules.input.SystemPropertyModule

All Implemented Interfaces:

Disposable, Component, Configurable, LogEnabled, ThreadSafe, InputModule

public class SystemPropertyModule
extends AbstractJXPathModule
implements ThreadSafe

SystemPropertyModule is an JXPath based InputModule implementation that provides access to system properties. Available system properties are defined by Java's System.getProperties(). JXPath allows to apply XPath functions to system properties.

If there is a security manager, its checkPropertiesAccess method is called with no arguments. This may result in a security exception which is wrapped into a configuration exception and re-thrown.

Version:

$Id: SystemPropertyModule.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Konstantin Piroumian

Field Summary

Fields inherited from class org.apache.cocoon.components.modules.input.AbstractJXPathModule

configuration, parameter

Fields inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

settings

Fields inherited from interface org.apache.cocoon.components.modules.input.InputModule

ROLE

Constructor Summary

SystemPropertyModule()

Method Summary

protected Object

getContextObject(Configuration modeConf, Map objectModel) Returns the object which should be used as JXPath context.

Methods inherited from class org.apache.cocoon.components.modules.input.AbstractJXPathModule

configure, getAttribute, getAttributeNames, getAttributeValues

Methods inherited from class org.apache.cocoon.components.modules.input.AbstractInputModule

dispose

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemPropertyModule

public SystemPropertyModule()

Method Detail

getContextObject

protected Object getContextObject(Configuration modeConf,
                                  Map objectModel)

Description copied from class: AbstractJXPathModule

Returns the object which should be used as JXPath context. Descendants should override this method to return a specific object that is requried by the implementing class. Examples are: request, session and application context objects.

Specified by:

getContextObject in class AbstractJXPathModule

Throws:

SecurityException - if access is denied