org.eclipse.ecf.internal.provider.filetransfer

Class Activator

java.lang.Object

org.eclipse.ecf.internal.provider.filetransfer.Activator

All Implemented Interfaces:

IFileTransferProtocolToFactoryMapper

public class Activator
extends java.lang.Object
implements IFileTransferProtocolToFactoryMapper

The activator class controls the plug-in life cycle

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_EXCLUDED_SYS_PROP_NAME
static java.lang.String	PLUGIN_ID

Constructor Summary

Constructors

Constructor and Description
Activator() The constructor

Method Summary

Modifier and Type	Method and Description
IAdapterManager	getAdapterManager()
IRemoteFileSystemBrowser	getBrowseFileTransfer(java.lang.String protocol)
java.lang.String	getBrowseFileTransferFactoryId(java.lang.String protocol) Get the factory id of the active factory for the given protocol.
int	getBrowseFileTransferPriority(java.lang.String protocol) Get the priority of the active factory for the given protocol.
Bundle	getBundle()
static Activator	getDefault() Returns the shared instance
IExtensionRegistry	getExtensionRegistry()
IRetrieveFileTransfer	getFileTransfer(java.lang.String protocol)
protected LogService	getLogService()
java.lang.String[]	getPlatformSupportedSchemes()
IProxyService	getProxyService()
java.lang.String	getRetrieveFileTransferFactoryId(java.lang.String protocol) Get the factory id of the active factory for the given protocol.
int	getRetrieveFileTransferPriority(java.lang.String protocol) Get the priority of the active factory for the given protocol.
ISendFileTransfer	getSendFileTransfer(java.lang.String protocol)
java.lang.String	getSendFileTransferFactoryId(java.lang.String protocol) Get the factory id of the active factory for the given protocol.
int	getSendFileTransferPriority(java.lang.String protocol) Get the priority of the active factory for the given protocol.
IURLConnectionModifier	getURLConnectionModifier()
void	log(IStatus status)
static void	logNoProxyWarning(java.lang.Throwable e)
boolean	reinitialize() Reinitialized protocol to factory mapping defined via extension registry/extension points.
boolean	removeBrowseFileTransferFactory(java.lang.String id) Remove the factory with the given id.
boolean	removeRetrieveFileTransferFactory(java.lang.String id) Remove the factory with the given id.
boolean	removeSendFileTransferFactory(java.lang.String id) Remove the factory with the given id.
boolean	setBrowseFileTransferFactory(java.lang.String protocol, java.lang.String id, IRemoteFileSystemBrowserFactory factory, int priority) For the given protocol, set the given factory to be used for retrieve file transfer.
boolean	setBrowseFileTransferFactory(java.lang.String protocol, java.lang.String id, IRemoteFileSystemBrowserFactory factory, int priority, boolean uri) For the given protocol, set the given factory to be used for retrieve file transfer.
boolean	setRetrieveFileTransferFactory(java.lang.String protocol, java.lang.String id, IRetrieveFileTransferFactory factory, int priority) For the given protocol, set the given factory to be used for retrieve file transfer.
boolean	setRetrieveFileTransferFactory(java.lang.String protocol, java.lang.String id, IRetrieveFileTransferFactory factory, int priority, boolean uri) For the given protocol, set the given factory to be used for retrieve file transfer.
boolean	setSendFileTransferFactory(java.lang.String protocol, java.lang.String id, ISendFileTransferFactory factory, int priority) For the given protocol, set the given factory to be used for retrieve file transfer.
boolean	setSendFileTransferFactory(java.lang.String protocol, java.lang.String id, ISendFileTransferFactory factory, int priority, boolean uri) For the given protocol, set the given factory to be used for retrieve file transfer.
void	start(BundleContext ctxt)
void	stop(BundleContext ctxt)

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_EXCLUDED_SYS_PROP_NAME

public static final java.lang.String PLUGIN_EXCLUDED_SYS_PROP_NAME

See Also:

Constant Field Values

PLUGIN_ID

public static final java.lang.String PLUGIN_ID

See Also:

Constant Field Values

Constructor Detail

Activator

public Activator()

The constructor

Method Detail

getLogService

protected LogService getLogService()

getProxyService

public IProxyService getProxyService()

logNoProxyWarning

public static void logNoProxyWarning(java.lang.Throwable e)

log

public void log(IStatus status)

getBundle

public Bundle getBundle()

start

public void start(BundleContext ctxt)
           throws java.lang.Exception

Throws:

java.lang.Exception

reinitialize

public boolean reinitialize()

Description copied from interface: IFileTransferProtocolToFactoryMapper

Reinitialized protocol to factory mapping defined via extension registry/extension points.

Specified by:

reinitialize in interface IFileTransferProtocolToFactoryMapper

Returns:

true if reinitialization succeeds, false if not

stop

public void stop(BundleContext ctxt)
          throws java.lang.Exception

Throws:

java.lang.Exception

getDefault

public static Activator getDefault()

Returns the shared instance

Returns:

the shared instance

getPlatformSupportedSchemes

public java.lang.String[] getPlatformSupportedSchemes()

getExtensionRegistry

public IExtensionRegistry getExtensionRegistry()

getFileTransfer

public IRetrieveFileTransfer getFileTransfer(java.lang.String protocol)

getSendFileTransfer

public ISendFileTransfer getSendFileTransfer(java.lang.String protocol)

getBrowseFileTransfer

public IRemoteFileSystemBrowser getBrowseFileTransfer(java.lang.String protocol)

getAdapterManager

public IAdapterManager getAdapterManager()

getURLConnectionModifier

public IURLConnectionModifier getURLConnectionModifier()

setRetrieveFileTransferFactory

public boolean setRetrieveFileTransferFactory(java.lang.String protocol,
                                              java.lang.String id,
                                              IRetrieveFileTransferFactory factory,
                                              int priority)

Description copied from interface: IFileTransferProtocolToFactoryMapper

For the given protocol, set the given factory to be used for retrieve file transfer. If successful, subsequent retrieve requests for the given protocol will use the given factory.

For this method to be successful the protocol has to be non-null, the id has to be non-null and unique (should probably be set to the bundle symbolic name of the bundle calling this method), the factory must be non-null, and the priority must be higher (a *smaller number*) than any existing factory for the given protocol. The default priority is 100, and the highest priority is 0.

Specified by:

setRetrieveFileTransferFactory in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol (e.g. http/https) to map the factory to.

id - a unique id for the factory (should be bundle symbolic name of bundle calling method)

factory - the factory to associate with the given protocol

priority - priority (highest = 0) to use for this factory relative to any existing factories.

Returns:

true if the given factory was set for this protocol, false if not

setRetrieveFileTransferFactory

public boolean setRetrieveFileTransferFactory(java.lang.String protocol,
                                              java.lang.String id,
                                              IRetrieveFileTransferFactory factory,
                                              int priority,
                                              boolean uri)

Description copied from interface: IFileTransferProtocolToFactoryMapper

For the given protocol, set the given factory to be used for retrieve file transfer. If successful, subsequent retrieve requests for the given protocol will use the given factory.

For this method to be successful the protocol has to be non-null, the id has to be non-null and unique (should probably be set to the bundle symbolic name of the bundle calling this method), the factory must be non-null, and the priority must be higher (a *smaller number*) than any existing factory for the given protocol. The default priority is 100, and the highest priority is 0.

Specified by:

setRetrieveFileTransferFactory in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol (e.g. http/https) to map the factory to.

id - a unique id for the factory (should be bundle symbolic name of bundle calling method)

factory - the factory to associate with the given protocol

priority - priority (highest = 0) to use for this factory relative to any existing factories.

uri - if true the factory is added as a URI rather than a URL, meaning that no URLStreamHandler is registered for the given protocol. This is in contrast to the IFileTransferProtocolToFactoryMapper.setRetrieveFileTransferFactory(String, String, IRetrieveFileTransferFactory, int), which automatically registers an URLStreamHandler for the given protocol. If false, URLs will be used and an URLStreamHandler will be registered for the given protocol factory. NOTE: If this flag is true, providers that attempt to access IFileID.getURL() may be unable to do so, since the URI may not be successfully parsed as a URL.

Returns:

true if the given factory was set for this protocol, false if not

getRetrieveFileTransferFactoryId

public java.lang.String getRetrieveFileTransferFactoryId(java.lang.String protocol)

Description copied from interface: IFileTransferProtocolToFactoryMapper

Get the factory id of the active factory for the given protocol. If the given protocol does not have an active factory, returns null.

Specified by:

getRetrieveFileTransferFactoryId in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol to get the id for (e.g. http/https)

Returns:

id of the factory associated with the given protocol

getRetrieveFileTransferPriority

public int getRetrieveFileTransferPriority(java.lang.String protocol)

Description copied from interface: IFileTransferProtocolToFactoryMapper

Get the priority of the active factory for the given protocol. If the given protocol does not have an active factory, returns -1.

Specified by:

getRetrieveFileTransferPriority in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol to get the priority for (e.g. http/https)

Returns:

int priority for the given protocol

removeRetrieveFileTransferFactory

public boolean removeRetrieveFileTransferFactory(java.lang.String id)

Description copied from interface: IFileTransferProtocolToFactoryMapper

Remove the factory with the given id.

Specified by:

removeRetrieveFileTransferFactory in interface IFileTransferProtocolToFactoryMapper

Parameters:

id - the id of the factory to remove.

Returns:

true if a factory was removed. false otherwise.

setBrowseFileTransferFactory

public boolean setBrowseFileTransferFactory(java.lang.String protocol,
                                            java.lang.String id,
                                            IRemoteFileSystemBrowserFactory factory,
                                            int priority)

Description copied from interface: IFileTransferProtocolToFactoryMapper

For the given protocol, set the given factory to be used for retrieve file transfer. If successful, subsequent retrieve requests for the given protocol will use the given factory.

For this method to be successful the protocol has to be non-null, the id has to be non-null and unique (should probably be set to the bundle symbolic name of the bundle calling this method), the factory must be non-null, and the priority must be higher (a *smaller number*) than any existing factory for the given protocol. The default priority is 100, and the highest priority is 0.

Specified by:

setBrowseFileTransferFactory in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol (e.g. http/https) to map the factory to.

id - a unique id for the factory (should be bundle symbolic name of bundle calling method)

factory - the factory to associate with the given protocol

priority - priority (highest = 0) to use for this factory relative to any existing factories.

Returns:

true if the given factory was set for this protocol, false if not

setBrowseFileTransferFactory

public boolean setBrowseFileTransferFactory(java.lang.String protocol,
                                            java.lang.String id,
                                            IRemoteFileSystemBrowserFactory factory,
                                            int priority,
                                            boolean uri)

Description copied from interface: IFileTransferProtocolToFactoryMapper

For the given protocol, set the given factory to be used for retrieve file transfer. If successful, subsequent retrieve requests for the given protocol will use the given factory.

For this method to be successful the protocol has to be non-null, the id has to be non-null and unique (should probably be set to the bundle symbolic name of the bundle calling this method), the factory must be non-null, and the priority must be higher (a *smaller number*) than any existing factory for the given protocol. The default priority is 100, and the highest priority is 0.

Specified by:

setBrowseFileTransferFactory in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol (e.g. http/https) to map the factory to.

id - a unique id for the factory (should be bundle symbolic name of bundle calling method)

factory - the factory to associate with the given protocol

priority - priority (highest = 0) to use for this factory relative to any existing factories.

uri - if true the factory is added as a URI rather than a URL, meaning that no URLStreamHandler is registered for the given protocol. This is in contrast to the IFileTransferProtocolToFactoryMapper.setRetrieveFileTransferFactory(String, String, IRetrieveFileTransferFactory, int), which automatically registers an URLStreamHandler for the given protocol. If false, URLs will be used and an URLStreamHandler will be registered for the given protocol factory. NOTE: If this flag is true, providers that attempt to access IFileID.getURL() may be unable to do so, since the URI may not be successfully parsed as a URL.

Returns:

true if the given factory was set for this protocol, false if not

getBrowseFileTransferFactoryId

public java.lang.String getBrowseFileTransferFactoryId(java.lang.String protocol)

Description copied from interface: IFileTransferProtocolToFactoryMapper

Get the factory id of the active factory for the given protocol. If the given protocol does not have an active factory, returns null.

Specified by:

getBrowseFileTransferFactoryId in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol to get the id for (e.g. http/https)

Returns:

id of the factory associated with the given protocol

getBrowseFileTransferPriority

public int getBrowseFileTransferPriority(java.lang.String protocol)

Description copied from interface: IFileTransferProtocolToFactoryMapper

Get the priority of the active factory for the given protocol. If the given protocol does not have an active factory, returns -1.

Specified by:

getBrowseFileTransferPriority in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol to get the priority for (e.g. http/https)

Returns:

int priority for the given protocol

removeBrowseFileTransferFactory

public boolean removeBrowseFileTransferFactory(java.lang.String id)

Description copied from interface: IFileTransferProtocolToFactoryMapper

Remove the factory with the given id.

Specified by:

removeBrowseFileTransferFactory in interface IFileTransferProtocolToFactoryMapper

Parameters:

id - the id of the factory to remove.

Returns:

true if a factory was removed. false otherwise.

setSendFileTransferFactory

public boolean setSendFileTransferFactory(java.lang.String protocol,
                                          java.lang.String id,
                                          ISendFileTransferFactory factory,
                                          int priority)

Description copied from interface: IFileTransferProtocolToFactoryMapper

For the given protocol, set the given factory to be used for retrieve file transfer. If successful, subsequent retrieve requests for the given protocol will use the given factory.

For this method to be successful the protocol has to be non-null, the id has to be non-null and unique (should probably be set to the bundle symbolic name of the bundle calling this method), the factory must be non-null, and the priority must be higher (a *smaller number*) than any existing factory for the given protocol. The default priority is 100, and the highest priority is 0.

Specified by:

setSendFileTransferFactory in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol (e.g. http/https) to map the factory to.

id - a unique id for the factory (should be bundle symbolic name of bundle calling method)

factory - the factory to associate with the given protocol

priority - priority (highest = 0) to use for this factory relative to any existing factories.

Returns:

true if the given factory was set for this protocol, false if not

setSendFileTransferFactory

public boolean setSendFileTransferFactory(java.lang.String protocol,
                                          java.lang.String id,
                                          ISendFileTransferFactory factory,
                                          int priority,
                                          boolean uri)

Description copied from interface: IFileTransferProtocolToFactoryMapper

For the given protocol, set the given factory to be used for retrieve file transfer. If successful, subsequent retrieve requests for the given protocol will use the given factory.

For this method to be successful the protocol has to be non-null, the id has to be non-null and unique (should probably be set to the bundle symbolic name of the bundle calling this method), the factory must be non-null, and the priority must be higher (a *smaller number*) than any existing factory for the given protocol. The default priority is 100, and the highest priority is 0.

Specified by:

setSendFileTransferFactory in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol (e.g. http/https) to map the factory to.

id - a unique id for the factory (should be bundle symbolic name of bundle calling method)

factory - the factory to associate with the given protocol

priority - priority (highest = 0) to use for this factory relative to any existing factories.

uri - if true the factory is added as a URI rather than a URL, meaning that no URLStreamHandler is registered for the given protocol. This is in contrast to the IFileTransferProtocolToFactoryMapper.setRetrieveFileTransferFactory(String, String, IRetrieveFileTransferFactory, int), which automatically registers an URLStreamHandler for the given protocol. If false, URLs will be used and an URLStreamHandler will be registered for the given protocol factory. NOTE: If this flag is true, providers that attempt to access IFileID.getURL() may be unable to do so, since the URI may not be successfully parsed as a URL.

Returns:

true if the given factory was set for this protocol, false if not

getSendFileTransferFactoryId

public java.lang.String getSendFileTransferFactoryId(java.lang.String protocol)

Description copied from interface: IFileTransferProtocolToFactoryMapper

Get the factory id of the active factory for the given protocol. If the given protocol does not have an active factory, returns null.

Specified by:

getSendFileTransferFactoryId in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol to get the id for (e.g. http/https)

Returns:

id of the factory associated with the given protocol

getSendFileTransferPriority

public int getSendFileTransferPriority(java.lang.String protocol)

Description copied from interface: IFileTransferProtocolToFactoryMapper

Get the priority of the active factory for the given protocol. If the given protocol does not have an active factory, returns -1.

Specified by:

getSendFileTransferPriority in interface IFileTransferProtocolToFactoryMapper

Parameters:

protocol - the protocol to get the priority for (e.g. http/https)

Returns:

int priority for the given protocol

removeSendFileTransferFactory

public boolean removeSendFileTransferFactory(java.lang.String id)

Description copied from interface: IFileTransferProtocolToFactoryMapper

Remove the factory with the given id.

Specified by:

removeSendFileTransferFactory in interface IFileTransferProtocolToFactoryMapper

Parameters:

id - the id of the factory to remove.

Returns:

true if a factory was removed. false otherwise.