Class DelegatingFileSystemOptionsBuilder

java.lang.Object

org.apache.commons.vfs2.util.DelegatingFileSystemOptionsBuilder

public class DelegatingFileSystemOptionsBuilder
extends Object

This class use reflection to set a configuration value using the fileSystemConfigBuilder associated the a scheme.

Example:

FileSystemOptions fso = new FileSystemOptions();
DelegatingFileSystemOptionsBuilder delegate = new DelegatingFileSystemOptionsBuilder(VFS.getManager());
delegate.setConfigString(fso, "sftp", "identities", "c:/tmp/test.ident");
delegate.setConfigString(fso, "http", "proxyPort", "8080");
delegate.setConfigClass(fso, "sftp", "userinfo", TrustEveryoneUserInfo.class);

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	DelegatingFileSystemOptionsBuilder.Context	Context.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String, Map<String, List<Method>>>	beanMethods
private static final org.apache.commons.logging.Log	log
private final FileSystemManager	manager
private static final Map<String,Class<?>>	PRIMATIVE_TO_OBJECT
private static final Class<String>[]	STRING_PARAM

Constructor Summary

Constructors

Constructor	Description
DelegatingFileSystemOptionsBuilder(FileSystemManager manager)	Constructor.

Method Summary

Modifier and Type	Method	Description
private boolean	convertValuesAndInvoke(Method configSetter, DelegatingFileSystemOptionsBuilder.Context ctx)	Tries to convert the value and pass it to the given method
private Map<String, List<Method>>	createSchemeMethods(String scheme)	Creates the list of all set*() methods for the given scheme
private boolean	fillConfigSetters(DelegatingFileSystemOptionsBuilder.Context ctx)	Fills all available set*() methods for the context-scheme into the context.
protected FileSystemManager	getManager()
private Map<String, List<Method>>	getSchemeMethods(String scheme)	Gets (cached) list of set*() methods for the given scheme
private void	invokeSetter(Class<?> valueParameter, DelegatingFileSystemOptionsBuilder.Context ctx, Method configSetter, Object values)	Invokes the method with the converted values
void	setConfigClass(FileSystemOptions fso, String scheme, String name, Class<?> className)	Sets a single class value.
void	setConfigClasses(FileSystemOptions fso, String scheme, String name, Class<?>[] classNames)	Sets an array of class values.
void	setConfigString(FileSystemOptions fso, String scheme, String name, String value)	Sets a single string value.
void	setConfigStrings(FileSystemOptions fso, String scheme, String name, String[] values)	Sets an array of string value.
private void	setValues(DelegatingFileSystemOptionsBuilder.Context ctx)	Sets the values using the informations of the given context.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

STRING_PARAM

private static final Class<String>[] STRING_PARAM

PRIMATIVE_TO_OBJECT

private static final Map<String,Class<?>> PRIMATIVE_TO_OBJECT

log

private static final org.apache.commons.logging.Log log

manager

private final FileSystemManager manager

beanMethods

private final Map<String, Map<String, List<Method>>> beanMethods

Constructor Details

DelegatingFileSystemOptionsBuilder

public DelegatingFileSystemOptionsBuilder(FileSystemManager manager)

Constructor.

Pass in your fileSystemManager instance.

Parameters:

manager - the manager to use to get the fileSystemConfigBuilder assocated to a scheme

Method Details

getManager

protected FileSystemManager getManager()

setConfigString

public void setConfigString(FileSystemOptions fso,
 String scheme,
 String name,
 String value)
                     throws FileSystemException

Sets a single string value.

Parameters:

fso - FileSystemOptions

scheme - scheme

name - name

value - value

Throws:

FileSystemException - if an error occurs.

setConfigStrings

public void setConfigStrings(FileSystemOptions fso,
 String scheme,
 String name,
 String[] values)
                      throws FileSystemException

Sets an array of string value.

Parameters:

fso - FileSystemOptions

scheme - scheme

name - name

values - values

Throws:

FileSystemException - if an error occurs.

setConfigClass

public void setConfigClass(FileSystemOptions fso,
 String scheme,
 String name,
 Class<?> className)
                    throws FileSystemException,
IllegalAccessException,
InstantiationException

Sets a single class value.

The class has to implement a no-args constructor, else the instantiation might fail.

Parameters:

fso - FileSystemOptions

scheme - scheme

name - name

className - className

Throws:

FileSystemException - if an error occurs.

IllegalAccessException - if a class canoot be accessed.

InstantiationException - if a class cannot be instantiated.

setConfigClasses

public void setConfigClasses(FileSystemOptions fso,
 String scheme,
 String name,
 Class<?>[] classNames)
                      throws FileSystemException,
IllegalAccessException,
InstantiationException

Sets an array of class values.

The class has to implement a no-args constructor, else the instantiation might fail.

Parameters:

fso - FileSystemOptions

scheme - scheme

name - name

classNames - classNames

Throws:

FileSystemException - if an error occurs.

IllegalAccessException - if a class canoot be accessed.

InstantiationException - if a class cannot be instantiated.

setValues

private void setValues(DelegatingFileSystemOptionsBuilder.Context ctx)
                throws FileSystemException

Sets the values using the informations of the given context.

Throws:

FileSystemException

convertValuesAndInvoke

private boolean convertValuesAndInvoke(Method configSetter,
 DelegatingFileSystemOptionsBuilder.Context ctx)
                                throws FileSystemException

Tries to convert the value and pass it to the given method

Throws:

FileSystemException

invokeSetter

private void invokeSetter(Class<?> valueParameter,
 DelegatingFileSystemOptionsBuilder.Context ctx,
 Method configSetter,
 Object values)
                   throws FileSystemException

Invokes the method with the converted values

Throws:

FileSystemException

fillConfigSetters

private boolean fillConfigSetters(DelegatingFileSystemOptionsBuilder.Context ctx)
                           throws FileSystemException

Fills all available set*() methods for the context-scheme into the context.

Throws:

FileSystemException

getSchemeMethods

private Map<String, List<Method>> getSchemeMethods(String scheme)
                                            throws FileSystemException

Gets (cached) list of set*() methods for the given scheme

Throws:

FileSystemException

createSchemeMethods

private Map<String, List<Method>> createSchemeMethods(String scheme)
                                               throws FileSystemException

Creates the list of all set*() methods for the given scheme

Throws:

FileSystemException