Package org.apache.fulcrum.parser
Interface ParserService
- All Known Implementing Classes:
DefaultParserService
public interface ParserService
ParserService defines the methods which are needed by the parser objects
to get their necessities.
- Version:
- $Id: ValueParser.java 535465 2007-05-05 06:58:06Z tv $
- Author:
- Thomas Vandahl
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final boolean
The default value of 'automaticUpload' property (false
).static final String
Parse file upload items automaticallystatic final int
The default value of 'maxIdle' property in 'pool' (2
).static final int
The default value of 'maxTotal' property in 'pool' (1024
).static final boolean
fulcrum pool by default falsestatic final String
fulcrum pool activation parameterstatic final String
Default Encoding for Parameter Parserstatic final String
Key for the Parameter Parser Encodingstatic final String
commons pool2 parametersstatic final String
Avalon Identifierstatic final String
Property for setting the URL folding value -
Method Summary
Modifier and TypeMethodDescriptionTrims the string data and applies the conversion specified in the property given by URL_CASE_FOLDING.convertAndTrim
(String value) Convert a String value according to the url-case-folding property.convertAndTrim
(String value, ValueParser.URLCaseFolding fold) A convert method, which trims the string data and applies the conversion specified in the parameter given.boolean
Gets the automaticUpload value from the configurationGet the parameter encoding that has been configured as default for the ParserService.<P extends ValueParser>
PGet aValueParser
instance from the service.Gets the folding value from the configurationList
<jakarta.servlet.http.Part> parseUpload
(jakarta.servlet.http.HttpServletRequest request) Parse the given request for uploaded filesvoid
putParser
(ValueParser parser) Put the parser into service
-
Field Details
-
ROLE
Avalon Identifier -
PARAMETER_ENCODING_DEFAULT
Default Encoding for Parameter Parser- See Also:
-
PARAMETER_ENCODING_KEY
Key for the Parameter Parser Encoding- See Also:
-
URL_CASE_FOLDING_KEY
Property for setting the URL folding value- See Also:
-
AUTOMATIC_KEY
Parse file upload items automatically- See Also:
-
FULCRUM_POOL_DEFAULT
static final boolean FULCRUM_POOL_DEFAULTfulcrum pool by default false- See Also:
-
FULCRUM_POOL_KEY
fulcrum pool activation parameter- See Also:
-
POOL_KEY
commons pool2 parameters- See Also:
-
AUTOMATIC_DEFAULT
static final boolean AUTOMATIC_DEFAULTThe default value of 'automaticUpload' property (
false
). If set totrue
, parsing the multipart request will be performed automatically byParameterParser
. Otherwise, an org.apache.turbine.modules.Action may decide to parse the request by callingparseRequest
manually.- See Also:
-
DEFAULT_POOL_CAPACITY
static final int DEFAULT_POOL_CAPACITYThe default value of 'maxTotal' property in 'pool' (
1024
). The default pool capacity.- See Also:
-
DEFAULT_MAX_IDLE
static final int DEFAULT_MAX_IDLEThe default value of 'maxIdle' property in 'pool' (
2
). The default maximum idle object.- See Also:
-
-
Method Details
-
getParameterEncoding
String getParameterEncoding()Get the parameter encoding that has been configured as default for the ParserService.- Returns:
- A String for the parameter encoding
-
convert
Trims the string data and applies the conversion specified in the property given by URL_CASE_FOLDING. It returns a new string so that it does not destroy the value data.- Parameters:
value
- A String to be processed.- Returns:
- A new String converted to lowercase and trimmed.
-
convertAndTrim
Convert a String value according to the url-case-folding property.- Parameters:
value
- the String to convert- Returns:
- a new String.
-
convertAndTrim
A convert method, which trims the string data and applies the conversion specified in the parameter given. It returns a new string so that it does not destroy the value data.- Parameters:
value
- A String to be processed.fold
- The parameter folding to be applied (seeParserService
)- Returns:
- A new String converted to the correct case and trimmed.
-
getUrlFolding
ValueParser.URLCaseFolding getUrlFolding()Gets the folding value from the configuration- Returns:
- The current Folding Value
-
getAutomaticUpload
boolean getAutomaticUpload()Gets the automaticUpload value from the configuration- Returns:
- The current automaticUpload Value
-
parseUpload
List<jakarta.servlet.http.Part> parseUpload(jakarta.servlet.http.HttpServletRequest request) throws org.apache.avalon.framework.service.ServiceException Parse the given request for uploaded files- Parameters:
request
- the HttpServletRequest object- Returns:
- A list of
Part
s - Throws:
org.apache.avalon.framework.service.ServiceException
- if parsing fails
-
getParser
Get aValueParser
instance from the service. Use the default implementation.- Type Parameters:
P
- The ValueParser we are using- Parameters:
ppClass
- parameter parser class- Returns:
- An object that implements ValueParser
- Throws:
InstantiationException
- if the instance could not be created
-
putParser
Put the parser into service- Parameters:
parser
- The value parser to be used
-