org.apache.archiva.repository

Class AbstractRemoteRepository

java.lang.Object

org.apache.archiva.repository.AbstractRepository

org.apache.archiva.repository.AbstractRemoteRepository

All Implemented Interfaces:

EditableRemoteRepository, EditableRepository, RemoteRepository, Repository, RepositoryEventHandler, RepositoryEventListener

Direct Known Subclasses:

BasicRemoteRepository, MavenRemoteRepository

public abstract class AbstractRemoteRepository
extends AbstractRepository
implements EditableRemoteRepository

Abstract implementation of a remote repository. Abstract classes must implement the features and capabilities by themselves.

Field Summary

Fields

Modifier and Type	Field and Description
private String	checkPath
private RemoteRepositoryContent	content
private RepositoryCredentials	credentials
private Map<String,String>	extraHeaders
private Map<String,String>	extraParameters
private String	proxyId
private Duration	timeout
private Map<String,String>	uExtraHeaders
private Map<String,String>	uExtraParameters

Fields inherited from class org.apache.archiva.repository.AbstractRepository

CRON_DEFINITION, featureMap, log, repositoryBase, schedulingDefinition

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteRepository(Locale primaryLocale, RepositoryType type, String id, String name, Path repositoryBase)
AbstractRemoteRepository(RepositoryType type, String id, String name, Path repositoryBase)

Method Summary

Modifier and Type	Method and Description
void	addExtraHeader(String header, String value) Adds an extra header.
void	addExtraParameter(String key, String value) Adds an additional parameter.
String	getCheckPath() Returns the path relative to the root url of the repository that should be used to check the availability of the repository.
RemoteRepositoryContent	getContent() Returns the interface to access the content of the repository.
Map<String,String>	getExtraHeaders() Returns extra headers that are added to the request to the remote repository.
Map<String,String>	getExtraParameters() Returns additional parameters, that are used for accessing the remote repository.
Path	getLocalPath() Remote repositories resolve always relative to the base directory.
RepositoryCredentials	getLoginCredentials() Returns the credentials used to login to the remote repository.
Duration	getTimeout() Returns the time duration, after that the request is aborted and a error is returned, if the remote repository does not respond.
void	setCheckPath(String path) Sets the path relative to the root url of the repository that should be used to check the availability of the repository.
void	setContent(RemoteRepositoryContent content) Sets the content.
void	setCredentials(RepositoryCredentials credentials) Sets the login credentials for login to the remote repository.
void	setExtraHeaders(Map<String,String> headers) Sets the extra headers, that are added to the requests to the remote repository.
void	setExtraParameters(Map<String,String> params) Sets additional parameters to be used to access the remote repository.
void	setTimeout(Duration duration) Sets the timeout for requests to the remote repository.
String	toString()

Methods inherited from class org.apache.archiva.repository.AbstractRepository

addFailoverLocation, addFeature, addListener, clearFailoverLocations, clearListeners, close, getCapabilities, getDescription, getDescription, getFailoverLocations, getFeature, getId, getIndexingContext, getLayout, getLocation, getName, getName, getPrimaryLocale, getSchedulingDefinition, getType, hasIndex, isScanned, raise, removeFailoverLocation, removeListener, setBaseUri, setDescription, setIndexingContext, setLayout, setLocation, setName, setPrimaryLocale, setScanned, setSchedulingDefinition, supportsFeature

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.archiva.repository.EditableRepository

addFailoverLocation, clearFailoverLocations, getPrimaryLocale, removeFailoverLocation, setBaseUri, setDescription, setIndexingContext, setLayout, setLocation, setName, setScanned, setSchedulingDefinition

Methods inherited from interface org.apache.archiva.repository.Repository

close, getCapabilities, getDescription, getDescription, getFailoverLocations, getFeature, getId, getIndexingContext, getLayout, getLocation, getName, getName, getSchedulingDefinition, getType, hasIndex, isScanned, supportsFeature

Methods inherited from interface org.apache.archiva.repository.RepositoryEventHandler

addListener, clearListeners, removeListener

Field Detail

credentials

private RepositoryCredentials credentials

checkPath

private String checkPath

extraParameters

private Map<String,String> extraParameters

uExtraParameters

private Map<String,String> uExtraParameters

extraHeaders

private Map<String,String> extraHeaders

uExtraHeaders

private Map<String,String> uExtraHeaders

timeout

private Duration timeout

proxyId

private String proxyId

content

private RemoteRepositoryContent content

Constructor Detail

AbstractRemoteRepository

public AbstractRemoteRepository(RepositoryType type,
                                String id,
                                String name,
                                Path repositoryBase)

AbstractRemoteRepository

public AbstractRemoteRepository(Locale primaryLocale,
                                RepositoryType type,
                                String id,
                                String name,
                                Path repositoryBase)

Method Detail

setCredentials

public void setCredentials(RepositoryCredentials credentials)

Description copied from interface: EditableRemoteRepository

Sets the login credentials for login to the remote repository.

Specified by:

setCredentials in interface EditableRemoteRepository

setCheckPath

public void setCheckPath(String path)

Description copied from interface: EditableRemoteRepository

Sets the path relative to the root url of the repository that should be used to check the availability of the repository.

Specified by:

setCheckPath in interface EditableRemoteRepository

Parameters:

path - The path string.

setExtraParameters

public void setExtraParameters(Map<String,String> params)

Description copied from interface: EditableRemoteRepository

Sets additional parameters to be used to access the remote repository.

Specified by:

setExtraParameters in interface EditableRemoteRepository

Parameters:

params - A map of parameters, may not be null.

addExtraParameter

public void addExtraParameter(String key,
                              String value)

Description copied from interface: EditableRemoteRepository

Adds an additional parameter.

Specified by:

addExtraParameter in interface EditableRemoteRepository

Parameters:

key - The key of the parameter

value - The value of the parameter

setExtraHeaders

public void setExtraHeaders(Map<String,String> headers)

Description copied from interface: EditableRemoteRepository

Sets the extra headers, that are added to the requests to the remote repository.

Specified by:

setExtraHeaders in interface EditableRemoteRepository

addExtraHeader

public void addExtraHeader(String header,
                           String value)

Description copied from interface: EditableRemoteRepository

Adds an extra header.

Specified by:

addExtraHeader in interface EditableRemoteRepository

Parameters:

header - The header name

value - The header value

setTimeout

public void setTimeout(Duration duration)

Description copied from interface: EditableRemoteRepository

Sets the timeout for requests to the remote repository.

Specified by:

setTimeout in interface EditableRemoteRepository

Parameters:

duration - The amount of time, after that the request is aborted.

getContent

public RemoteRepositoryContent getContent()

Description copied from interface: RemoteRepository

Returns the interface to access the content of the repository.

Specified by:

getContent in interface RemoteRepository

Returns:

setContent

public void setContent(RemoteRepositoryContent content)

Description copied from interface: EditableRemoteRepository

Sets the content.

Specified by:

setContent in interface EditableRemoteRepository

getLoginCredentials

public RepositoryCredentials getLoginCredentials()

Description copied from interface: RemoteRepository

Returns the credentials used to login to the remote repository.

Specified by:

getLoginCredentials in interface RemoteRepository

Returns:

the credentials, null if not set.

getCheckPath

public String getCheckPath()

Description copied from interface: RemoteRepository

Returns the path relative to the root url of the repository that should be used to check the availability of the repository.

Specified by:

getCheckPath in interface RemoteRepository

Returns:

The check path, null if not set.

getExtraParameters

public Map<String,String> getExtraParameters()

Description copied from interface: RemoteRepository

Returns additional parameters, that are used for accessing the remote repository.

Specified by:

getExtraParameters in interface RemoteRepository

Returns:

A map of key, value pairs.

getExtraHeaders

public Map<String,String> getExtraHeaders()

Description copied from interface: RemoteRepository

Returns extra headers that are added to the request to the remote repository.

Specified by:

getExtraHeaders in interface RemoteRepository

Returns:

getTimeout

public Duration getTimeout()

Description copied from interface: RemoteRepository

Returns the time duration, after that the request is aborted and a error is returned, if the remote repository does not respond.

Specified by:

getTimeout in interface RemoteRepository

Returns:

The timeout.

getLocalPath

public Path getLocalPath()

Remote repositories resolve always relative to the base directory.

Specified by:

getLocalPath in interface Repository

Overrides:

getLocalPath in class AbstractRepository

Returns:

toString

public String toString()

Overrides:

toString in class Object