ResourceManagerImpl (Velocity 1.4 API)
Keywords: org.apache.velocity.runtime.resource.ResourceManagerImpl class

Overview | 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.velocity.runtime.resource
Class ResourceManagerImpl

    java.lang.Object
      org.apache.velocity.runtime.resource.ResourceManagerImpl

All Implemented Interfaces:
  ResourceManager

public class ResourceManagerImpl
extends java.lang.Object
implements ResourceManager

Class to manage the text resource for the Velocity Runtime.

Version:
  $Id: ResourceManagerImpl.java,v 1.7.4.1 2004/03/03 23:23:01 geirm Exp $
Author:
  Jason van Zyl, Paulo Gaspar, Geir Magnusson Jr.

Field Summary
`protected ResourceCache` | `globalCache` Object implementing ResourceCache to be our resource manager's Resource cache.
`private boolean` | `logWhenFound` switch to turn off log notice when a resource is found for the first time.
`static int` | `RESOURCE_CONTENT` A static content resource.
`private static java.lang.String` | `RESOURCE_LOADER_IDENTIFIER` token used to identify the loader internally
`static int` | `RESOURCE_TEMPLATE` A template resources.
`private boolean` | `resourceLoaderInitializersActive` Each loader needs a configuration object for its initialization, this flags keeps track of whether or not the configuration objects have been created for the resource loaders.
`protected java.util.ArrayList` | `resourceLoaders` The List of templateLoaders that the Runtime will use to locate the InputStream source of a template.
`protected RuntimeServices` | `rsvc`
`private java.util.ArrayList` | `sourceInitializerList` This is a list of the template input stream source initializers, basically properties for a particular template stream source.
`private java.util.Hashtable` | `sourceInitializerMap` This is a map of public name of the template stream source to it's initializer.

Constructor Summary
`ResourceManagerImpl()`

Method Summary
`private void` | `assembleResourceLoaderInitializers()` This will produce a List of Hashtables, each hashtable contains the intialization info for a particular resource loader.
`java.lang.String` | `getLoaderNameForResource(java.lang.String resourceName)` Determines is a template exists, and returns name of the loader that provides it.
`Resource` | `getResource(java.lang.String resourceName, int resourceType)` Deprecated. Use `getResource(String resourceName, int resourceType, String encoding )`
`Resource` | `getResource(java.lang.String resourceName, int resourceType, java.lang.String encoding)` Gets the named resource.
`void` | `initialize(RuntimeServices rs)` Initialize the ResourceManager.
`protected Resource` | `loadResource(java.lang.String resourceName, int resourceType, java.lang.String encoding)` Loads a resource from the current set of resource loaders
`protected void` | `refreshResource(Resource resource, java.lang.String encoding)` Takes an existing resource, and 'refreshes' it.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### RESOURCE_TEMPLATE

    public static final int RESOURCE_TEMPLATE

  A template resources.

  See Also:
    Constant Field Values

### RESOURCE_CONTENT

    public static final int RESOURCE_CONTENT

  A static content resource.

  See Also:
    Constant Field Values

### RESOURCE_LOADER_IDENTIFIER

    private static final java.lang.String RESOURCE_LOADER_IDENTIFIER

  token used to identify the loader internally

  See Also:
    Constant Field Values

### globalCache

    protected ResourceCache globalCache

  Object implementing ResourceCache to be our resource manager's Resource cache.

### resourceLoaders

    protected java.util.ArrayList resourceLoaders

  The List of templateLoaders that the Runtime will use to locate the InputStream source of a template.

### sourceInitializerList

    private java.util.ArrayList sourceInitializerList

  This is a list of the template input stream source initializers, basically properties for a particular template stream source. The order in this list reflects numbering of the properties i.e. .resource.loader. =

### sourceInitializerMap

    private java.util.Hashtable sourceInitializerMap

  This is a map of public name of the template stream source to it's initializer. This is so that clients of velocity can set properties of a template source stream with its public name. So for example, a client could set the File.resource.path property and this would change the resource.path property for the file template stream source.

### resourceLoaderInitializersActive

    private boolean resourceLoaderInitializersActive

  Each loader needs a configuration object for its initialization, this flags keeps track of whether or not the configuration objects have been created for the resource loaders.

### logWhenFound

    private boolean logWhenFound

  switch to turn off log notice when a resource is found for the first time.

### rsvc

    protected RuntimeServices rsvc

Constructor Detail

### ResourceManagerImpl

    public ResourceManagerImpl()

Method Detail

### initialize

    public void initialize(RuntimeServices rs)
                    throws java.lang.Exception

  Initialize the ResourceManager.

  Specified by:
    `initialize` in interface `ResourceManager`
  Throws:
    `java.lang.Exception`

### assembleResourceLoaderInitializers

    private void assembleResourceLoaderInitializers()

  This will produce a List of Hashtables, each hashtable contains the intialization info for a particular resource loader. This Hastable will be passed in when initializing the the template loader.

### getResource

    public Resource getResource(java.lang.String resourceName,
                                int resourceType,
                                java.lang.String encoding)
                         throws ResourceNotFoundException,
                                ParseErrorException,
                                java.lang.Exception

  Gets the named resource. Returned class type corresponds to specified type (i.e. `Template` to `RESOURCE_TEMPLATE`).

  Specified by:
    `getResource` in interface `ResourceManager`
  Parameters:
    `resourceName` - The name of the resource to retrieve.
    `resourceType` - The type of resource (`RESOURCE_TEMPLATE`, `RESOURCE_CONTENT`, etc.).
    `encoding` - The character encoding to use.
  Returns:
    Resource with the template parsed and ready.
  Throws:
    `ResourceNotFoundException` - if template not found from any available source.
    `ParseErrorException` - if template cannot be parsed due to syntax (or other) error.
    `java.lang.Exception` - if a problem in parse

### loadResource

    protected Resource loadResource(java.lang.String resourceName,
                                    int resourceType,
                                    java.lang.String encoding)
                             throws ResourceNotFoundException,
                                    ParseErrorException,
                                    java.lang.Exception

  Loads a resource from the current set of resource loaders

  Parameters:
    `resourceName` - The name of the resource to retrieve.
    `resourceType` - The type of resource (`RESOURCE_TEMPLATE`, `RESOURCE_CONTENT`, etc.).
    `encoding` - The character encoding to use.
  Returns:
    Resource with the template parsed and ready.
  Throws:
    `ResourceNotFoundException` - if template not found from any available source.
    `ParseErrorException` - if template cannot be parsed due to syntax (or other) error.
    `java.lang.Exception` - if a problem in parse

### refreshResource

    protected void refreshResource(Resource resource,
                                   java.lang.String encoding)
                            throws ResourceNotFoundException,
                                   ParseErrorException,
                                   java.lang.Exception

  Takes an existing resource, and 'refreshes' it. This generally means that the source of the resource is checked for changes according to some cache/check algorithm and if the resource changed, then the resource data is reloaded and re-parsed.

  Parameters:
    `resource` - resource to refresh
  Throws:
    `ResourceNotFoundException` - if template not found from current source for this Resource
    `ParseErrorException` - if template cannot be parsed due to syntax (or other) error.
    `java.lang.Exception` - if a problem in parse

### getResource

    public Resource getResource(java.lang.String resourceName,
                                int resourceType)
                         throws ResourceNotFoundException,
                                ParseErrorException,
                                java.lang.Exception

  Deprecated. Use `getResource(String resourceName, int resourceType, String encoding )`

  Gets the named resource. Returned class type corresponds to specified type (i.e. `Template` to `RESOURCE_TEMPLATE`).

  Parameters:
    `resourceName` - The name of the resource to retrieve.
    `resourceType` - The type of resource (`RESOURCE_TEMPLATE`, `RESOURCE_CONTENT`, etc.).
  Returns:
    Resource with the template parsed and ready.
  Throws:
    `ResourceNotFoundException` - if template not found from any available source.
    `ParseErrorException` - if template cannot be parsed due to syntax (or other) error.
    `java.lang.Exception` - if a problem in parse

### getLoaderNameForResource

    public java.lang.String getLoaderNameForResource(java.lang.String resourceName)

  Determines is a template exists, and returns name of the loader that provides it. This is a slightly less hokey way to support the Velocity.templateExists() utility method, which was broken when per-template encoding was introduced. We can revisit this.

  Specified by:
    `getLoaderNameForResource` in interface `ResourceManager`
  Parameters:
    `resourceName` - Name of template or content resource
  Returns:
    class name of loader than can provide it

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002 Apache Software Foundation. All Rights Reserved.