com.toolsverse.io

Class IoProcessorFactory

Object

com.toolsverse.ext.loader.Unit<IoProcessor>

com.toolsverse.io.IoProcessorFactory

public class IoProcessorFactory
extends Unit<IoProcessor>

Instantiates the particular implementation of the IoProcessor by name. Possible names: file, ftp, sftp, class name. IoProcessorFactory is a singleton.

Since:

1.5

Version:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE FILE.
static String	FTP FTP.
static String	FTPS FTPS.
static String	HTTP HTTP.
static String	MAIL MAIL.
static String	SFTP SFTP.

Method Summary

Modifier and Type	Method and Description
void	add(String name, Object object) Adds loaded object using name as a key.
void	addWithoutLicense(String name, Object object) Adds loaded object which doesn't have license using name as a key.
boolean	allowLoadAll() Checks if loader allowed to to load all objects regardless of license.
boolean	canBeLoadedAgain() Checks if module can be loaded again.
void	finishLoad(UnitLoader loader) Executed when UnitLoader finishes load.
void	free() Executed when there is a need to free memory.
IoProcessor	getIoProcessor() Returns FileProcessor.
IoProcessor	getIoProcessor(String resource) Gets the IoProcessor by name.
IoProcessor	getIoProcessor(String resource, String proxyHost, int proxyPort) Gets the IoProcessor by name.
List<IoProcessor>	getList() Gets the list of loaded modules.
List<KeyValue>	getProcessors() Gets the processors.
static IoProcessorFactory	instance() Returns an instance of the IoProcessorFactory.
boolean	loadsConfigurableExtensions() Returns true if Unit is indented to load configurable extensions.
boolean	startLoad() Executed when UnitLoader starts loading.

Methods inherited from class com.toolsverse.ext.loader.Unit

getClassPath, getJarPath, getObjClass, getPath, isSingleton, setClassPath, setJarPath, setObjClass, setPath, setSingleton

Methods inherited from class Object

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

Field Detail

FILE

public static final String FILE

FILE.

See Also:

Constant Field Values

FTP

public static final String FTP

FTP.

See Also:

Constant Field Values

FTPS

public static final String FTPS

FTPS.

See Also:

Constant Field Values

SFTP

public static final String SFTP

SFTP.

See Also:

Constant Field Values

HTTP

public static final String HTTP

HTTP.

See Also:

Constant Field Values

MAIL

public static final String MAIL

MAIL.

See Also:

Constant Field Values

Method Detail

instance

public static IoProcessorFactory instance()

Returns an instance of the IoProcessorFactory.

Returns:

the IoProcessorFactory

add

public void add(String name,
                Object object)

Description copied from class: Unit

Adds loaded object using name as a key.

Specified by:

add in class Unit<IoProcessor>

Parameters:

name - the unique name of the object

object - the object

addWithoutLicense

public void addWithoutLicense(String name,
                              Object object)

Description copied from class: Unit

Adds loaded object which doesn't have license using name as a key.

Specified by:

addWithoutLicense in class Unit<IoProcessor>

Parameters:

name - the unique name of the object

object - the object

allowLoadAll

public boolean allowLoadAll()

Description copied from class: Unit

Checks if loader allowed to to load all objects regardless of license.

Specified by:

allowLoadAll in class Unit<IoProcessor>

Returns:

true, if successful

canBeLoadedAgain

public boolean canBeLoadedAgain()

Description copied from class: Unit

Checks if module can be loaded again.

Specified by:

canBeLoadedAgain in class Unit<IoProcessor>

Returns:

true, if successful

finishLoad

public void finishLoad(UnitLoader loader)

Description copied from class: Unit

Executed when UnitLoader finishes load.

Specified by:

finishLoad in class Unit<IoProcessor>

Parameters:

loader - the UnitLoader

free

public void free()

Description copied from class: Unit

Executed when there is a need to free memory.

Specified by:

free in class Unit<IoProcessor>

getIoProcessor

public IoProcessor getIoProcessor()

Returns FileProcessor.

Returns:

the IoProcessor

See Also:

FileProcessor

getIoProcessor

public IoProcessor getIoProcessor(String resource)

Gets the IoProcessor by name.

Parameters:

resource - the name of the IoProcessor. Possible values: file, ftp, sftp, http

Returns:

the IoProcessor

getIoProcessor

public IoProcessor getIoProcessor(String resource,
                                  String proxyHost,
                                  int proxyPort)

Gets the IoProcessor by name. If proxyHost != null and proxyPort != - 1 returns a proxy version (if exists) for the particular IoProcessor.

Parameters:

resource - the name of the IoProcessor. Possible values: file, ftp, sftp, http

proxyHost - the proxy host

proxyPort - the proxy port

Returns:

the resource processor

getList

public List<IoProcessor> getList()

Description copied from class: Unit

Gets the list of loaded modules.

Specified by:

getList in class Unit<IoProcessor>

Returns:

the list

getProcessors

public List<KeyValue> getProcessors()

Gets the processors.

Returns:

the processors

loadsConfigurableExtensions

public boolean loadsConfigurableExtensions()

Description copied from class: Unit

Returns true if Unit is indented to load configurable extensions. The configurable extension will have a place in the configuration UI and requires xml configuration file.

Specified by:

loadsConfigurableExtensions in class Unit<IoProcessor>

Returns:

true, if successful

startLoad

public boolean startLoad()

Description copied from class: Unit

Executed when UnitLoader starts loading. Put initialization code here.

Specified by:

startLoad in class Unit<IoProcessor>

Returns:

true, if supported