Package org.apache.fulcrum.intake
Schnittstelle IntakeService
- Alle bekannten Implementierungsklassen:
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$
- Autor:
- John McNally, Henning P. Schmiedehausen, Quinton McCombs
-
Feldübersicht
FelderModifizierer und TypFeldBeschreibungstatic final int
The default pool capacity.static final String
Avalon role - used to id the component within the managerstatic final String
The configuration property specifying the location where a serialized version of the xml specification can be written for faster restarts..static final String
The default location where a serialized version of the xml specification can be written for faster restarts..static final String
The default location of the xml specification.static final String
The configuration property specifying the location of the xml specification. -
Methodenübersicht
Modifizierer und TypMethodeBeschreibunggetFieldGetter
(String className, String propName) Gets the Method that can be used to get a property value.getFieldSetter
(String className, String propName) Gets the Method that can be used to set a property.Gets an instance of a named group either from the pool or by calling the Factory Service if the pool is empty.getGroupKey
(String groupName) Gets the key (usually a short identifier) for a group.getGroupName
(String groupKey) Gets the group name given its key.String[]
Names of all the defined groups.int
Gets the current size of the pool for a named group.void
releaseGroup
(Group instance) Puts a group back to the pool.
-
Felddetails
-
ROLE
Avalon role - used to id the component within the manager -
XML_PATHS
The configuration property specifying the location of the xml specification.- Siehe auch:
-
XML_PATH_DEFAULT
The default location of the xml specification.- Siehe auch:
-
SERIAL_XML
The configuration property specifying the location where a serialized version of the xml specification can be written for faster restarts..- Siehe auch:
-
SERIAL_XML_DEFAULT
The default location where a serialized version of the xml specification can be written for faster restarts..- Siehe auch:
-
DEFAULT_POOL_CAPACITY
static final int DEFAULT_POOL_CAPACITYThe default pool capacity.- Siehe auch:
-
-
Methodendetails
-
getGroup
Gets an instance of a named group either from the pool or by calling the Factory Service if the pool is empty.- Parameter:
groupName
- the name of the group.- Gibt zurück:
- a Group instance.
- Löst aus:
IntakeException
- if recycling fails.
-
releaseGroup
Puts a group back to the pool.- Parameter:
instance
- the object instance to recycle.- Löst aus:
IntakeException
- The passed group name does not exist.
-
getSize
Gets the current size of the pool for a named group.- Parameter:
groupName
- the name of the group.- Gibt zurück:
- the size of the group pool
- Löst aus:
IntakeException
- The passed group name does not exist.
-
getGroupNames
String[] getGroupNames()Names of all the defined groups.- Gibt zurück:
- array of names.
-
getGroupKey
Gets the key (usually a short identifier) for a group.- Parameter:
groupName
- the name of the group.- Gibt zurück:
- the key.
-
getGroupName
Gets the group name given its key.- Parameter:
groupKey
- the key.- Gibt zurück:
- 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.- Parameter:
className
- the name of the object.propName
- the name of the property.- Gibt zurück:
- the setter.
- Löst aus:
ClassNotFoundException
- if the class specified could not be loadedIntrospectionException
- if the property setter could not be called
-
getFieldGetter
Method getFieldGetter(String className, String propName) throws ClassNotFoundException, IntrospectionException Gets the Method that can be used to get a property value.- Parameter:
className
- the name of the object.propName
- the name of the property.- Gibt zurück:
- the getter.
- Löst aus:
ClassNotFoundException
- if the class specified could not be loadedIntrospectionException
- if the property getter could not be called
-