Return-Path: Delivered-To: apmail-cocoon-cvs-archive@www.apache.org Received: (qmail 39195 invoked from network); 20 Sep 2007 08:29:51 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 20 Sep 2007 08:29:51 -0000 Received: (qmail 16885 invoked by uid 500); 20 Sep 2007 08:29:42 -0000 Delivered-To: apmail-cocoon-cvs-archive@cocoon.apache.org Received: (qmail 16811 invoked by uid 500); 20 Sep 2007 08:29:42 -0000 Mailing-List: contact cvs-help@cocoon.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@cocoon.apache.org list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list cvs@cocoon.apache.org Received: (qmail 16800 invoked by uid 99); 20 Sep 2007 08:29:42 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 20 Sep 2007 01:29:42 -0700 X-ASF-Spam-Status: No, hits=-100.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 20 Sep 2007 08:29:45 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id BDC4A1A9846; Thu, 20 Sep 2007 01:29:24 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: svn commit: r577626 [4/7] - in /cocoon/site/site/subprojects: ./ configuration/ configuration/configuration-api/ configuration/configuration-api/1.0/ configuration/configuration-api/1.0/apidocs/ configuration/configuration-api/1.0/apidocs/org/ configur... Date: Thu, 20 Sep 2007 08:29:19 -0000 To: cvs@cocoon.apache.org From: reinhard@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20070920082924.BDC4A1A9846@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/PropertyProvider.html URL: http://svn.apache.org/viewvc/cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/PropertyProvider.html?rev=577626&view=auto ============================================================================== --- cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/PropertyProvider.html (added) +++ cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/PropertyProvider.html Thu Sep 20 01:29:13 2007 @@ -0,0 +1,266 @@ + + + + + + + +PropertyProvider (Cocoon Configuration API 1.0.1 API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.cocoon.configuration +
+Interface PropertyProvider

+
+
+
public interface PropertyProvider
+ +

+This is an interface for custom components delivering properties to + configure Cocoon. + This component must be setup as a Spring bean in the root application + context using ROLE as the bean identifier. + The registered provider is asked once on startup for a set of properties. +

+ +

+

+
Since:
+
1.0
+
Version:
+
$Id: PropertyProvider.java 496688 2007-01-16 13:51:23Z cziegeler $
+
+
+ +

+ + + + + + + + + + + + + + +
+Field Summary
+static StringROLE + +
+          The bean must be registered with this name.
+  + + + + + + + + + + + + + + +
+Method Summary
+ PropertiesgetProperties(Settings settings, + String runningMode, + String path) + +
+          Provide the properties.
+  +

+ + + + + + + + +
+Field Detail
+ +

+ROLE

+
+public static final String ROLE
+
+
The bean must be registered with this name. +

+

+
+
+ + + + + + + + + + + +
+Method Detail
+ +

+getProperties

+
+public Properties getProperties(Settings settings,
+                                String runningMode,
+                                String path)
+
+
Provide the properties. +

+

+
Parameters:
settings - The already loaded settings.
runningMode - The current running mode.
path - A path specifying the application context the settings are applied to. + A path of null indicates the root application context. +
Returns:
The additional properties.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved. + + Added: cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/Settings.html URL: http://svn.apache.org/viewvc/cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/Settings.html?rev=577626&view=auto ============================================================================== --- cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/Settings.html (added) +++ cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/Settings.html Thu Sep 20 01:29:13 2007 @@ -0,0 +1,702 @@ + + + + + + + +Settings (Cocoon Configuration API 1.0.1 API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.cocoon.configuration +
+Interface Settings

+
+
All Known Implementing Classes:
MutableSettings
+
+
+
+
public interface Settings
+ +

+This object holds the global configuration of Cocoon. +

+ +

+

+
Since:
+
1.0
+
Version:
+
$Id: Settings.java 496692 2007-01-16 14:01:35Z cziegeler $
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringKEY_CACHE_DIRECTORY + +
+          This parameter allows to specify where Cocoon should create its page + and other objects cache.
+static StringKEY_CONTAINER_ENCODING + +
+          Set encoding used by the container.
+static StringKEY_FORM_ENCODING + +
+          Set form encoding.
+static StringKEY_LOAD_CLASSES + +
+          This parameter is used to list classes that should be loaded at + initialization time of the servlet.
+static StringKEY_RELOAD_DELAY + +
+          Delay between reload checks for the configuration.
+static StringKEY_RELOADING + +
+          Allow reinstantiating (reloading) of the cocoon instance.
+static StringKEY_WORK_DIRECTORY + +
+          This parameter allows to specify where Cocoon should put it's + working files.
+static StringPROPERTY_USER_SETTINGS + +
+          Name of the property specifying a custom user properties file.
+static StringROLE + +
+          The role to lookup this bean.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetCacheDirectory() + +
+           
+ StringgetContainerEncoding() + +
+           
+ longgetCreationTime() + +
+          The creation time of the current settings instance.
+ StringgetFormEncoding() + +
+           
+ ListgetLoadClasses() + +
+           
+ StringgetProperty(String key) + +
+          Get the value of a property.
+ StringgetProperty(String key, + String defaultValue) + +
+          Get the value of a property.
+ ListgetPropertyNames() + +
+          Return all available property names.
+ ListgetPropertyNames(String keyPrefix) + +
+          Return all available property names starting with the prefix.
+ longgetReloadDelay(String type) + +
+          This method can be used by components to get the configured + delay period inbetween checks.
+ StringgetRunningMode() + +
+          Return the current running mode.
+ StringgetWorkDirectory() + +
+           
+ booleanisReloadingEnabled(String type) + +
+          This method can be used by components to query if they are + configured to check for reloading.
+  +

+ + + + + + + + +
+Field Detail
+ +

+ROLE

+
+public static final String ROLE
+
+
The role to lookup this bean. +

+

+
+
+
+ +

+PROPERTY_USER_SETTINGS

+
+public static final String PROPERTY_USER_SETTINGS
+
+
Name of the property specifying a custom user properties file. +

+

+
See Also:
Constant Field Values
+
+
+ +

+KEY_LOAD_CLASSES

+
+public static final String KEY_LOAD_CLASSES
+
+
This parameter is used to list classes that should be loaded at + initialization time of the servlet. For example, JDBC Drivers used need to + be named here. Additional entries may be inserted here during build + depending on your build properties. +

+

+
See Also:
Constant Field Values
+
+
+ +

+KEY_CACHE_DIRECTORY

+
+public static final String KEY_CACHE_DIRECTORY
+
+
This parameter allows to specify where Cocoon should create its page + and other objects cache. The path specified can be either absolute or + relative to the context path of the servlet. On windows platform, + absolute directory must start with volume: C:\Path\To\Cache\Directory. +

+

+
See Also:
Constant Field Values
+
+
+ +

+KEY_WORK_DIRECTORY

+
+public static final String KEY_WORK_DIRECTORY
+
+
This parameter allows to specify where Cocoon should put it's + working files. The path specified is either absolute or relative + to the context path of the Cocoon servlet. On windows platform, + absolute directory must start with volume: C:\Path\To\Work\Directory. +

+

+
See Also:
Constant Field Values
+
+
+ +

+KEY_FORM_ENCODING

+
+public static final String KEY_FORM_ENCODING
+
+
Set form encoding. This will be the character set used to decode request + parameters. If not set the ISO-8859-1 encoding will be assumed. +

+

+
See Also:
Constant Field Values
+
+
+ +

+KEY_CONTAINER_ENCODING

+
+public static final String KEY_CONTAINER_ENCODING
+
+
Set encoding used by the container. If not set the ISO-8859-1 encoding + will be assumed. + Since the servlet specification requires that the ISO-8859-1 encoding + is used (by default), you should never change this value unless + you have a buggy servlet container. +

+

+
See Also:
Constant Field Values
+
+
+ +

+KEY_RELOADING

+
+public static final String KEY_RELOADING
+
+
Allow reinstantiating (reloading) of the cocoon instance. If this is + set to "yes" or "true", a new cocoon instance can be created using + the request parameter "cocoon-reload". It also enables that Cocoon is + reloaded when cocoon.xconf changes. Default is no for security reasons. +

+

+
See Also:
Constant Field Values
+
+
+ +

+KEY_RELOAD_DELAY

+
+public static final String KEY_RELOAD_DELAY
+
+
Delay between reload checks for the configuration. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + + + + +
+Method Detail
+ +

+getProperty

+
+public String getProperty(String key)
+
+
Get the value of a property. +

+

+
Parameters:
key - The name of the property. +
Returns:
The value of the property or null.
+
+
+
+ +

+getProperty

+
+public String getProperty(String key,
+                          String defaultValue)
+
+
Get the value of a property. +

+

+
Parameters:
key - The name of the property.
defaultValue - The value returned if the property is not available. +
Returns:
The value of the property or if the property cannot + be found the default value.
+
+
+
+ +

+getPropertyNames

+
+public List getPropertyNames(String keyPrefix)
+
+
Return all available property names starting with the prefix. +

+

+
Parameters:
keyPrefix - The prefix each property name must have. +
Returns:
A list of property names (including the prefix) or + an empty list.
+
+
+
+ +

+getPropertyNames

+
+public List getPropertyNames()
+
+
Return all available property names. +

+

+ +
Returns:
A list of all property names or an empty list.
+
+
+
+ +

+getLoadClasses

+
+public List getLoadClasses()
+
+
+ +
Returns:
Returns the loadClasses.
See Also:
KEY_LOAD_CLASSES
+
+
+
+ +

+getWorkDirectory

+
+public String getWorkDirectory()
+
+
+ +
Returns:
Returns the workDirectory.
See Also:
KEY_WORK_DIRECTORY
+
+
+
+ +

+getFormEncoding

+
+public String getFormEncoding()
+
+
+ +
Returns:
Returns the formEncoding.
See Also:
KEY_FORM_ENCODING
+
+
+
+ +

+getContainerEncoding

+
+public String getContainerEncoding()
+
+
+ +
Returns:
Returns the container encoding
See Also:
KEY_CONTAINER_ENCODING
+
+
+
+ +

+getCacheDirectory

+
+public String getCacheDirectory()
+
+
+ +
Returns:
Returns the cacheDirectory.
See Also:
KEY_CACHE_DIRECTORY
+
+
+
+ +

+getCreationTime

+
+public long getCreationTime()
+
+
The creation time of the current settings instance. +

+

+ +
Returns:
The creation time.
+
+
+
+ +

+isReloadingEnabled

+
+public boolean isReloadingEnabled(String type)
+
+
This method can be used by components to query if they are + configured to check for reloading. +

+

+
Parameters:
type - The type of the component that wants to check for reload. +
Returns:
Returns if reloading is enabled for this component.
See Also:
KEY_RELOADING
+
+
+
+ +

+getReloadDelay

+
+public long getReloadDelay(String type)
+
+
This method can be used by components to get the configured + delay period inbetween checks. +

+

+
Parameters:
type - The type of the component that wants to check for reload. +
Returns:
Returns the delay inbetween checks in milliseconds.
See Also:
KEY_RELOAD_DELAY
+
+
+
+ +

+getRunningMode

+
+public String getRunningMode()
+
+
Return the current running mode. +

+

+ +
Returns:
The current running mode.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved. + + Added: cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/SettingsDefaults.html URL: http://svn.apache.org/viewvc/cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/SettingsDefaults.html?rev=577626&view=auto ============================================================================== --- cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/SettingsDefaults.html (added) +++ cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/SettingsDefaults.html Thu Sep 20 01:29:13 2007 @@ -0,0 +1,325 @@ + + + + + + + +SettingsDefaults (Cocoon Configuration API 1.0.1 API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.cocoon.configuration +
+Class SettingsDefaults

+
+java.lang.Object
+  extended byorg.apache.cocoon.configuration.SettingsDefaults
+
+
+
+
public abstract class SettingsDefaults
extends Object
+ +

+This object defines the default values for the Settings. +

+ +

+

+
Since:
+
1.0
+
Version:
+
$Id: SettingsDefaults.java 496692 2007-01-16 14:01:35Z cziegeler $
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static longDEFAULT_CONFIGURATION_RELOAD_DELAY + +
+          Default reload delay for configurations in milliseconds.
+static StringDEFAULT_CONTAINER_ENCODING + +
+          The default encoding for the web container.
+static StringDEFAULT_RUNNING_MODE + +
+          The default running mode.
+static booleanRELOADING_ENABLED_DEFAULT + +
+          Default value for Settings.isReloadingEnabled(String) parameter (false).
+  + + + + + + + + + + +
+Constructor Summary
SettingsDefaults() + +
+           
+  + + + + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+DEFAULT_RUNNING_MODE

+
+public static final String DEFAULT_RUNNING_MODE
+
+
The default running mode. +

+

+
See Also:
Settings.getRunningMode(), +Constant Field Values
+
+
+ +

+RELOADING_ENABLED_DEFAULT

+
+public static final boolean RELOADING_ENABLED_DEFAULT
+
+
Default value for Settings.isReloadingEnabled(String) parameter (false). +

+

+
See Also:
Constant Field Values
+
+
+ +

+DEFAULT_CONFIGURATION_RELOAD_DELAY

+
+public static final long DEFAULT_CONFIGURATION_RELOAD_DELAY
+
+
Default reload delay for configurations in milliseconds. +

+

+
See Also:
Settings.getReloadDelay(String), +Constant Field Values
+
+
+ +

+DEFAULT_CONTAINER_ENCODING

+
+public static final String DEFAULT_CONTAINER_ENCODING
+
+
The default encoding for the web container. +

+

+
See Also:
Settings.getContainerEncoding(), +Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+SettingsDefaults

+
+public SettingsDefaults()
+
+
+ + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved. + + Added: cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/MutableSettings.html URL: http://svn.apache.org/viewvc/cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/MutableSettings.html?rev=577626&view=auto ============================================================================== --- cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/MutableSettings.html (added) +++ cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/MutableSettings.html Thu Sep 20 01:29:13 2007 @@ -0,0 +1,135 @@ + + + + + + + +Uses of Class org.apache.cocoon.configuration.MutableSettings (Cocoon Configuration API 1.0.1 API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+
+

+Uses of Class
org.apache.cocoon.configuration.MutableSettings

+
+No usage of org.apache.cocoon.configuration.MutableSettings +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved. + + Added: cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/PropertyHelper.html URL: http://svn.apache.org/viewvc/cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/PropertyHelper.html?rev=577626&view=auto ============================================================================== --- cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/PropertyHelper.html (added) +++ cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/PropertyHelper.html Thu Sep 20 01:29:13 2007 @@ -0,0 +1,135 @@ + + + + + + + +Uses of Class org.apache.cocoon.configuration.PropertyHelper (Cocoon Configuration API 1.0.1 API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+
+

+Uses of Class
org.apache.cocoon.configuration.PropertyHelper

+
+No usage of org.apache.cocoon.configuration.PropertyHelper +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved. + + Added: cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/PropertyProvider.html URL: http://svn.apache.org/viewvc/cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/PropertyProvider.html?rev=577626&view=auto ============================================================================== --- cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/PropertyProvider.html (added) +++ cocoon/site/site/subprojects/configuration/configuration-api/1.0/apidocs/org/apache/cocoon/configuration/class-use/PropertyProvider.html Thu Sep 20 01:29:13 2007 @@ -0,0 +1,135 @@ + + + + + + + +Uses of Interface org.apache.cocoon.configuration.PropertyProvider (Cocoon Configuration API 1.0.1 API) + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+
+

+Uses of Interface
org.apache.cocoon.configuration.PropertyProvider

+
+No usage of org.apache.cocoon.configuration.PropertyProvider +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+Copyright © 1999-2007 The Apache Software Foundation. All Rights Reserved. + +