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

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.components.modules.input.AbstractInputModule
          extended byorg.apache.cocoon.components.modules.input.AbstractJXPathModule
              extended byorg.apache.cocoon.components.modules.input.PropertiesFileModule
All Implemented Interfaces:
Configurable, Disposable, org.apache.cocoon.components.modules.input.InputModule, Serviceable, ThreadSafe

public class PropertiesFileModule
extends org.apache.cocoon.components.modules.input.AbstractJXPathModule
implements Serviceable, ThreadSafe

Input module for accessing properties in a properties file.

The properties file can only be configured statically and is resolved via the SourceResolver system.

Version:
$Id: PropertiesFileModule.html 1304280 2012-03-23 11:18:01Z ilgrosso $

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
PropertiesFileModule()
           
 
Method Summary
 void configure(Configuration configuration)
          Configure the location of the properties file:
 void dispose()
           
protected  Object getContextObject(Configuration modeConf, Map objectModel)
           
 void service(ServiceManager manager)
           
 
Methods inherited from class org.apache.cocoon.components.modules.input.AbstractJXPathModule
getAttribute, getAttributeNames, getAttributeValues
 
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertiesFileModule

public PropertiesFileModule()
Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException
Specified by:
service in interface Serviceable
Throws:
ServiceException

dispose

public void dispose()
Specified by:
dispose in interface Disposable

configure

public void configure(Configuration configuration)
               throws ConfigurationException
Configure the location of the properties file:

<file src="resource://my.properties" />

Specified by:
configure in interface Configurable
Throws:
ConfigurationException

getContextObject

protected Object getContextObject(Configuration modeConf,
                                  Map objectModel)
                           throws ConfigurationException
Throws:
ConfigurationException


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.