Package org.eclipse.aether.transport.wagon

Class WagonTransporterFactory

java.lang.Object

org.eclipse.aether.transport.wagon.WagonTransporterFactory

All Implemented Interfaces:

TransporterFactory

@Named("wagon")
public final class WagonTransporterFactory
extends Object
implements TransporterFactory

A transporter factory using Apache Maven Wagon. Note that this factory merely serves as an adapter to the Wagon API and by itself does not provide any transport services unless one or more wagon implementations are registered with the WagonProvider.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
WagonTransporterFactory(WagonProvider wagonProvider, WagonConfigurator wagonConfigurator)

Method Summary

Modifier and Type	Method	Description
float	getPriority()	The priority of this factory.
Transporter	newInstance(RepositorySystemSession session, RemoteRepository repository)	Tries to create a transporter for the specified remote repository.
WagonTransporterFactory	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 Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

WagonTransporterFactory

@Inject
public WagonTransporterFactory(WagonProvider wagonProvider,
 WagonConfigurator wagonConfigurator)

Method Details

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 WagonTransporterFactory 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.