org.apache.archiva.repository.features

Class RemoteIndexFeature

java.lang.Object

org.apache.archiva.repository.features.RemoteIndexFeature

All Implemented Interfaces:

RepositoryFeature<RemoteIndexFeature>

public class RemoteIndexFeature
extends Object
implements RepositoryFeature<RemoteIndexFeature>

Feature for remote index download.

Constructor Summary

Constructors

Constructor and Description
RemoteIndexFeature()

Method Summary

Modifier and Type	Method and Description
RemoteIndexFeature	get() Returns the concrete feature instance.
Duration	getDownloadTimeout() Returns the timeout after that the remote index download is aborted.
URI	getIndexUri() The URI to access the remote index.
String	getProxyId() Returns the id of the proxy, that should be used to download the remote index.
boolean	hasIndex() Returns true, if there is a index available.
boolean	isDownloadRemoteIndex() True, if the remote index should be downloaded.
boolean	isDownloadRemoteIndexOnStartup() Returns true, if the remote index should be downloaded on startup of the repository.
void	setDownloadRemoteIndex(boolean downloadRemoteIndex)
void	setDownloadRemoteIndexOnStartup(boolean downloadRemoteIndexOnStartup) Sets the flag for download of the remote repository index.
void	setDownloadTimeout(Duration timeout) Sets the timeout after that a remote index download will be aborted.
void	setIndexUri(URI indexUri) Sets the URI to access the remote index.
void	setProxyId(String proxyId) Sets the id of the proxy that should be used to download the remote index.
String	toString()

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.features.RepositoryFeature

getId, isFeature, isFeature

Constructor Detail

RemoteIndexFeature

public RemoteIndexFeature()

Method Detail

get

public RemoteIndexFeature get()

Description copied from interface: RepositoryFeature

Returns the concrete feature instance.

Specified by:

get in interface RepositoryFeature<RemoteIndexFeature>

Returns:

the feature instance.

isDownloadRemoteIndex

public boolean isDownloadRemoteIndex()

True, if the remote index should be downloaded.

Returns:

True if download, otherwise false.

setDownloadRemoteIndex

public void setDownloadRemoteIndex(boolean downloadRemoteIndex)

getIndexUri

public URI getIndexUri()

The URI to access the remote index. May be a relative URI that is relative to the repository URI.

Returns:

setIndexUri

public void setIndexUri(URI indexUri)

Sets the URI to access the remote index. May be a relative URI that is relative to the repository URI. The allowed URI schemes are dependent on the repository type.

Parameters:

indexUri - The URI of the index

isDownloadRemoteIndexOnStartup

public boolean isDownloadRemoteIndexOnStartup()

Returns true, if the remote index should be downloaded on startup of the repository.

Returns:

true, if the index should be downloaded during startup, otherwise false.

setDownloadRemoteIndexOnStartup

public void setDownloadRemoteIndexOnStartup(boolean downloadRemoteIndexOnStartup)

Sets the flag for download of the remote repository index.

Parameters:

downloadRemoteIndexOnStartup -

getDownloadTimeout

public Duration getDownloadTimeout()

Returns the timeout after that the remote index download is aborted.

Returns:

the time duration after that, the download is aborted.

setDownloadTimeout

public void setDownloadTimeout(Duration timeout)

Sets the timeout after that a remote index download will be aborted.

Parameters:

timeout - The duration

getProxyId

public String getProxyId()

Returns the id of the proxy, that should be used to download the remote index.

Returns:

The proxy id

setProxyId

public void setProxyId(String proxyId)

Sets the id of the proxy that should be used to download the remote index.

Parameters:

proxyId -

hasIndex

public boolean hasIndex()

Returns true, if there is a index available.

Returns:

toString

public String toString()

Overrides:

toString in class Object