Class DefaultFTPFileEntryParserFactory
- java.lang.Object
-
- org.apache.commons.net.ftp.parser.DefaultFTPFileEntryParserFactory
-
- All Implemented Interfaces:
FTPFileEntryParserFactory
public class DefaultFTPFileEntryParserFactory extends java.lang.Object implements FTPFileEntryParserFactory
This is the default implementation of the FTPFileEntryParserFactory interface. This is the implementation that will be used by org.apache.commons.net.ftp.FTPClient.listFiles() if no other implementation has been specified.
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
JAVA_IDENTIFIER
private static java.lang.String
JAVA_QUALIFIED_NAME
private static java.util.regex.Pattern
JAVA_QUALIFIED_NAME_PATTERN
-
Constructor Summary
Constructors Constructor Description DefaultFTPFileEntryParserFactory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FTPFileEntryParser
createFileEntryParser(java.lang.String key)
This default implementation of the FTPFileEntryParserFactory interface works according to the following logic: First it attempts to interpret the supplied key as a fully qualified classname (default package is not allowed) of a class implementing the FTPFileEntryParser interface.private FTPFileEntryParser
createFileEntryParser(java.lang.String key, FTPClientConfig config)
FTPFileEntryParser
createFileEntryParser(FTPClientConfig config)
Implementation extracts a key from the suppliedFTPClientConfig
parameter and creates an object implementing the interface FTPFileEntryParser and uses the supplied configuration to configure it.FTPFileEntryParser
createMVSEntryParser()
FTPFileEntryParser
createNetwareFTPEntryParser()
FTPFileEntryParser
createNTFTPEntryParser()
private FTPFileEntryParser
createNTFTPEntryParser(FTPClientConfig config)
Creates an NT FTP parser: if the config exists, and the system key equalsFTPClientConfig.SYST_NT
then a plainNTFTPEntryParser
is used, otherwise a composite ofNTFTPEntryParser
andUnixFTPEntryParser
is used.FTPFileEntryParser
createOS2FTPEntryParser()
FTPFileEntryParser
createOS400FTPEntryParser()
private FTPFileEntryParser
createOS400FTPEntryParser(FTPClientConfig config)
Creates an OS400 FTP parser: if the config exists, and the system key equalsFTPClientConfig.SYST_OS400
then a plainOS400FTPEntryParser
is used, otherwise a composite ofOS400FTPEntryParser
andUnixFTPEntryParser
is used.FTPFileEntryParser
createUnixFTPEntryParser()
FTPFileEntryParser
createVMSVersioningFTPEntryParser()
-
-
-
Field Detail
-
JAVA_IDENTIFIER
private static final java.lang.String JAVA_IDENTIFIER
- See Also:
- Constant Field Values
-
JAVA_QUALIFIED_NAME
private static final java.lang.String JAVA_QUALIFIED_NAME
- See Also:
- Constant Field Values
-
JAVA_QUALIFIED_NAME_PATTERN
private static final java.util.regex.Pattern JAVA_QUALIFIED_NAME_PATTERN
-
-
Method Detail
-
createFileEntryParser
public FTPFileEntryParser createFileEntryParser(java.lang.String key)
This default implementation of the FTPFileEntryParserFactory interface works according to the following logic: First it attempts to interpret the supplied key as a fully qualified classname (default package is not allowed) of a class implementing the FTPFileEntryParser interface. If that succeeds, a parser object of this class is instantiated and is returned; otherwise it attempts to interpret the key as an identirier commonly used by the FTP SYST command to identify systems.If
key
is not recognized as a fully qualified classname known to the system, this method will then attempt to see whether it contains a string identifying one of the known parsers. This comparison is case-insensitive. The intent here is where possible, to select as keys strings which are returned by the SYST command on the systems which the corresponding parser successfully parses. This enables this factory to be used in the auto-detection system.- Specified by:
createFileEntryParser
in interfaceFTPFileEntryParserFactory
- Parameters:
key
- should be a fully qualified classname corresponding to a class implementing the FTPFileEntryParser interface
OR
a string containing (case-insensitively) one of the following keywords:- Returns:
- the FTPFileEntryParser corresponding to the supplied key.
- Throws:
ParserInitializationException
- thrown if for any reason the factory cannot resolve the supplied key into an FTPFileEntryParser.- See Also:
FTPFileEntryParser
-
createFileEntryParser
private FTPFileEntryParser createFileEntryParser(java.lang.String key, FTPClientConfig config)
-
createFileEntryParser
public FTPFileEntryParser createFileEntryParser(FTPClientConfig config) throws ParserInitializationException
Implementation extracts a key from the supplied
FTPClientConfig
parameter and creates an object implementing the interface FTPFileEntryParser and uses the supplied configuration to configure it.Note that this method will generally not be called in scenarios that call for autodetection of parser type but rather, for situations where the user knows that the server uses a non-default configuration and knows what that configuration is.
- Specified by:
createFileEntryParser
in interfaceFTPFileEntryParserFactory
- Parameters:
config
- AFTPClientConfig
used to configure the parser created- Returns:
- the @link FTPFileEntryParser FTPFileEntryParser} so created.
- Throws:
ParserInitializationException
- Thrown on any exception in instantiationjava.lang.NullPointerException
- ifconfig
isnull
- Since:
- 1.4
-
createUnixFTPEntryParser
public FTPFileEntryParser createUnixFTPEntryParser()
-
createVMSVersioningFTPEntryParser
public FTPFileEntryParser createVMSVersioningFTPEntryParser()
-
createNetwareFTPEntryParser
public FTPFileEntryParser createNetwareFTPEntryParser()
-
createNTFTPEntryParser
public FTPFileEntryParser createNTFTPEntryParser()
-
createNTFTPEntryParser
private FTPFileEntryParser createNTFTPEntryParser(FTPClientConfig config)
Creates an NT FTP parser: if the config exists, and the system key equalsFTPClientConfig.SYST_NT
then a plainNTFTPEntryParser
is used, otherwise a composite ofNTFTPEntryParser
andUnixFTPEntryParser
is used.- Parameters:
config
- the config to use, may benull
- Returns:
- the parser
-
createOS2FTPEntryParser
public FTPFileEntryParser createOS2FTPEntryParser()
-
createOS400FTPEntryParser
public FTPFileEntryParser createOS400FTPEntryParser()
-
createOS400FTPEntryParser
private FTPFileEntryParser createOS400FTPEntryParser(FTPClientConfig config)
Creates an OS400 FTP parser: if the config exists, and the system key equalsFTPClientConfig.SYST_OS400
then a plainOS400FTPEntryParser
is used, otherwise a composite ofOS400FTPEntryParser
andUnixFTPEntryParser
is used.- Parameters:
config
- the config to use, may benull
- Returns:
- the parser
-
createMVSEntryParser
public FTPFileEntryParser createMVSEntryParser()
-
-