org.apache.fulcrum.intake
Interface IntakeService

All Known Implementing Classes:
IntakeServiceImpl

public interface IntakeService

This service provides access to input processing objects based on an XML specification.

Localization of Intake's error messages can be accomplished using Turbine's LocalizationTool from a Velocity template as follows:

$l10n.get($intake.SomeGroup.SomeField.Message)

Version:
$Id: IntakeService.java 757801 2009-03-24 13:46:25Z tv $
Author:
John McNally, Henning P. Schmiedehausen, Quinton McCombs

Field Summary
static int DEFAULT_POOL_CAPACITY
          The default pool capacity.
static String ROLE
          Avalon role - used to id the component within the manager
static String SERIAL_XML
          The configuration property specifying the location where a serialized version of the xml specification can be written for faster restarts..
static String SERIAL_XML_DEFAULT
          The default location where a serialized version of the xml specification can be written for faster restarts..
static String XML_PATH_DEFAULT
          The default location of the xml specification.
static String XML_PATHS
          The configuration property specifying the location of the xml specification.
 
Method Summary
 Method getFieldGetter(String className, String propName)
          Gets the Method that can be used to get a property value.
 Method getFieldSetter(String className, String propName)
          Gets the Method that can be used to set a property.
 Group getGroup(String groupName)
          Gets an instance of a named group either from the pool or by calling the Factory Service if the pool is empty.
 String getGroupKey(String groupName)
          Gets the key (usually a short identifier) for a group.
 String getGroupName(String groupKey)
          Gets the group name given its key.
 String[] getGroupNames()
          Names of all the defined groups.
 int getSize(String groupName)
          Gets the current size of the pool for a named group.
 void releaseGroup(Group instance)
          Puts a group back to the pool.
 

Field Detail

ROLE

static final String ROLE
Avalon role - used to id the component within the manager


XML_PATHS

static final String XML_PATHS
The configuration property specifying the location of the xml specification.

See Also:
Constant Field Values

XML_PATH_DEFAULT

static final String XML_PATH_DEFAULT
The default location of the xml specification.

See Also:
Constant Field Values

SERIAL_XML

static final String SERIAL_XML
The configuration property specifying the location where a serialized version of the xml specification can be written for faster restarts..

See Also:
Constant Field Values

SERIAL_XML_DEFAULT

static final String SERIAL_XML_DEFAULT
The default location where a serialized version of the xml specification can be written for faster restarts..

See Also:
Constant Field Values

DEFAULT_POOL_CAPACITY

static final int DEFAULT_POOL_CAPACITY
The default pool capacity.

See Also:
Constant Field Values
Method Detail

getGroup

Group getGroup(String groupName)
               throws IntakeException
Gets an instance of a named group either from the pool or by calling the Factory Service if the pool is empty.

Parameters:
groupName - the name of the group.
Returns:
a Group instance.
Throws:
IntakeException - if recycling fails.

releaseGroup

void releaseGroup(Group instance)
                  throws IntakeException
Puts a group back to the pool.

Parameters:
instance - the object instance to recycle.
Throws:
IntakeException - The passed group name does not exist.

getSize

int getSize(String groupName)
            throws IntakeException
Gets the current size of the pool for a named group.

Parameters:
groupName - the name of the group.
Throws:
IntakeException - The passed group name does not exist.

getGroupNames

String[] getGroupNames()
Names of all the defined groups.

Returns:
array of names.

getGroupKey

String getGroupKey(String groupName)
Gets the key (usually a short identifier) for a group.

Parameters:
groupName - the name of the group.
Returns:
the key.

getGroupName

String getGroupName(String groupKey)
Gets the group name given its key.

Parameters:
groupKey - the key.
Returns:
groupName the name of the group.

getFieldSetter

Method getFieldSetter(String className,
                      String propName)
                      throws ClassNotFoundException,
                             IntrospectionException
Gets the Method that can be used to set a property.

Parameters:
className - the name of the object.
propName - the name of the property.
Returns:
the setter.
Throws:
ClassNotFoundException
IntrospectionException

getFieldGetter

Method getFieldGetter(String className,
                      String propName)
                      throws ClassNotFoundException,
                             IntrospectionException
Gets the Method that can be used to get a property value.

Parameters:
className - the name of the object.
propName - the name of the property.
Returns:
the getter.
Throws:
ClassNotFoundException
IntrospectionException


Copyright © 2005-2009 The Apache Software Foundation. All Rights Reserved.