org.eclipse.aether.transport.classpath

Class ClasspathTransporterFactory

java.lang.Object

org.eclipse.aether.transport.classpath.ClasspathTransporterFactory

All Implemented Interfaces:

TransporterFactory, Service

@Named(value="classpath")
public final class ClasspathTransporterFactory
extends Object
implements TransporterFactory, Service

A transporter factory for repositories using the classpath: protocol. As example, getting an item named some/file.txt from a repository with the URL classpath:/base/dir results in retrieving the resource base/dir/some/file.txt from the classpath. The classpath to load the resources from is given via a ClassLoader that can be configured via the configuration property CONFIG_PROP_CLASS_LOADER.

Note: Such repositories are read-only and uploads to them are generally not supported.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_PROP_CLASS_LOADER The key in the repository session's configuration properties used to store a ClassLoader from which resources should be retrieved.

Constructor Summary

Constructors

Constructor and Description
ClasspathTransporterFactory() Creates an (uninitialized) instance of this transporter factory.

Method Summary

Modifier and Type	Method and Description
float	getPriority() The priority of this factory.
void	initService(ServiceLocator locator) Provides the opportunity to initialize this service and to acquire other services for its operation from the locator.
Transporter	newInstance(RepositorySystemSession session, RemoteRepository repository) Tries to create a transporter for the specified remote repository.
ClasspathTransporterFactory	setLoggerFactory(LoggerFactory loggerFactory) Sets the logger factory to use for this component.
ClasspathTransporterFactory	setPriority(float priority) Sets the priority of this component.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_PROP_CLASS_LOADER

public static final String CONFIG_PROP_CLASS_LOADER

The key in the repository session's configuration properties used to store a ClassLoader from which resources should be retrieved. If unspecified, the context class loader of the current thread will be used.

See Also:

Constant Field Values

Constructor Detail

ClasspathTransporterFactory

public ClasspathTransporterFactory()

Creates an (uninitialized) instance of this transporter factory. Note: In case of manual instantiation by clients, the new factory needs to be configured via its various mutators before first use or runtime errors will occur.

Method Detail

initService

public void initService(ServiceLocator locator)

Description copied from interface: Service

Provides the opportunity to initialize this service and to acquire other services for its operation from the locator. A service must not save the reference to the provided service locator.

Specified by:

initService in interface Service

Parameters:

locator - The service locator, must not be null.

setLoggerFactory

public ClasspathTransporterFactory setLoggerFactory(LoggerFactory loggerFactory)

Sets the logger factory to use for this component.

Parameters:

loggerFactory - The logger factory to use, may be null to disable logging.

Returns:

This component for chaining, never null.

getPriority

public float getPriority()

Description copied from interface: TransporterFactory

The priority of this factory. When multiple factories can handle a given repository, factories with higher priority are preferred over those with lower priority.

Specified by:

getPriority in interface TransporterFactory

Returns:

The priority of this factory.

setPriority

public ClasspathTransporterFactory setPriority(float priority)

Sets the priority of this component.

Parameters:

priority - The priority.

Returns:

This component for chaining, never null.

newInstance

public Transporter newInstance(RepositorySystemSession session,
                               RemoteRepository repository)
                        throws NoTransporterException

Description copied from interface: TransporterFactory

Tries to create a transporter for the specified remote repository. Typically, a factory will inspect RemoteRepository.getProtocol() to determine whether it can handle a repository.

Specified by:

newInstance in interface TransporterFactory

Parameters:

session - The repository system session from which to configure the transporter, must not be null. In particular, a transporter should obey the timeouts configured for the session.

repository - The remote repository to create a transporter for, must not be null.

Returns:

The transporter for the given repository, never null.

Throws:

NoTransporterException - If the factory cannot create a transporter for the specified remote repository.