com.arsdigita.web
Class WebConfig

java.lang.Object
  extended bycom.arsdigita.util.parameter.AbstractParameterContext
      extended bycom.arsdigita.runtime.AbstractConfig
          extended bycom.arsdigita.web.WebConfig
All Implemented Interfaces:
ParameterContext

public final class WebConfig
extends AbstractConfig

A record containing server-session scoped configuration properties. Accessors of this class may return null. Developers should take care to trap null return values in their code.

Version:
$Id: //core-platform/dev/src/com/arsdigita/web/WebConfig.java#15 $
Author:
Justin Ross <jross@redhat.com>
See Also:
Web

Field Summary
static String versionId
           
 
Constructor Summary
WebConfig()
           
 
Method Summary
 ApplicationFileResolver getApplicationFileResolver()
           
 CachePolicy getCachePolicy()
          Gets the system default cache policy.
 Host getCurrentHost()
          Deprecated. Use Host.retrieve(Web.getConfig().getHost()) instead.
 String getDefaultScheme()
           
 String getDispatcherContextPath()
           
 String getDispatcherServletPath()
           
 HttpHost getHost()
           
 Host[] getHosts()
          Deprecated. Use Host.retrieveAll() instead.
 HttpHost getServer()
           
 String getServerName()
          Deprecated. Use getServer().getName() instead.
 int getServerPort()
          Deprecated. Use getServer().getPort() instead.
 String getSiteName()
           
 
Methods inherited from class com.arsdigita.runtime.AbstractConfig
load, load, load, require
 
Methods inherited from class com.arsdigita.util.parameter.AbstractParameterContext
get, get, getParameters, load, load, loadInfo, register, save, set, validate, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Constructor Detail

WebConfig

public WebConfig()
Method Detail

getDefaultScheme

public final String getDefaultScheme()

getServer

public final HttpHost getServer()

getHost

public final HttpHost getHost()

getSiteName

public final String getSiteName()

getDispatcherContextPath

public final String getDispatcherContextPath()

getDispatcherServletPath

public final String getDispatcherServletPath()

getApplicationFileResolver

public final ApplicationFileResolver getApplicationFileResolver()

getCachePolicy

public final CachePolicy getCachePolicy()
Gets the system default cache policy. This value is set via the com.arsdigita.web.cache_policy system property using one fo the following values: user for per-user caching, world for globally enabled caching, and disable to always prevent caching.


getServerName

public final String getServerName()
Deprecated. Use getServer().getName() instead.


getServerPort

public final int getServerPort()
Deprecated. Use getServer().getPort() instead.


getCurrentHost

public final Host getCurrentHost()
Deprecated. Use Host.retrieve(Web.getConfig().getHost()) instead.


getHosts

public final Host[] getHosts()
Deprecated. Use Host.retrieveAll() instead.



Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC