ComponentDefinitionsFactory (Struts 1.3.10 API)

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.struts.tiles
Interface ComponentDefinitionsFactory

All Superinterfaces:
  Serializable

All Known Implementing Classes:
  FactorySet, I18nFactorySet, ReloadableDefinitionsFactory

Deprecated. Use DefinitionsFactory instead.

    public interface ComponentDefinitionsFactory

extends Serializable

Component repository interface. This interface allows to retrieve an definition by its name, independently of the factory implementation. Implementation must be Serializable, in order to be compliant with web Container having this constraint (Weblogic 6.x).

Method Summary
`ComponentDefinition` | `getDefinition(String name, ServletRequest request, ServletContext servletContext)` Deprecated. Get a definition by its name.
`void` | `initFactory(ServletContext servletContext, Map properties)` Deprecated. Init factory.

Method Detail

### getDefinition

    ComponentDefinition getDefinition(String name,
                                      ServletRequest request,
                                      ServletContext servletContext)
                                      throws NoSuchDefinitionException,
                                             DefinitionsFactoryException

  Deprecated.
  Get a definition by its name.

  Parameters:
    `name` - Name of requested definition.
    `request` - Current servelet request
    `servletContext` - current servlet context
  Throws:
    `DefinitionsFactoryException` - An error occur while getting definition.
    `NoSuchDefinitionException` - No definition found for specified name Implementation can throw more accurate exception as a subclass of this exception

### initFactory

    void initFactory(ServletContext servletContext,
                     Map properties)
                     throws DefinitionsFactoryException

  Deprecated.
  Init factory. This method is called exactly once immediately after factory creation in case of internal creation (by DefinitionUtil).

  Parameters:
    `servletContext` - Servlet Context passed to newly created factory.
    `properties` - Map of name/property passed to newly created factory. Map can contains more properties than requested.
  Throws:
    `DefinitionsFactoryException` - An error occur during initialization.

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 © 2000-2008 Apache Software Foundation. All Rights Reserved.