blob: 94a097b0fcc842efae260da4d3dc87df69dbf58c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RemoteRepository (Archiva :: Modules 3.0.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RemoteRepository (Archiva :: Modules 3.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RemoteRepository.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/archiva/repository/RelocatablePath.html" title="class in org.apache.archiva.repository"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html" title="interface in org.apache.archiva.repository"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/archiva/repository/RemoteRepository.html" target="_top">Frames</a></li>
<li><a href="RemoteRepository.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.archiva.repository</div>
<h2 title="Interface RemoteRepository" class="title">Interface RemoteRepository</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/archiva/event/EventSource.html" title="interface in org.apache.archiva.event">EventSource</a>, <a href="../../../../org/apache/archiva/repository/Repository.html" title="interface in org.apache.archiva.repository">Repository</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html" title="interface in org.apache.archiva.repository.storage">RepositoryStorage</a></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/apache/archiva/repository/EditableRemoteRepository.html" title="interface in org.apache.archiva.repository">EditableRemoteRepository</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/archiva/repository/base/AbstractRemoteRepository.html" title="class in org.apache.archiva.repository.base">AbstractRemoteRepository</a>, <a href="../../../../org/apache/archiva/repository/base/BasicRemoteRepository.html" title="class in org.apache.archiva.repository.base">BasicRemoteRepository</a>, <a href="../../../../org/apache/archiva/repository/maven2/MavenRemoteRepository.html" title="class in org.apache.archiva.repository.maven2">MavenRemoteRepository</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../src-html/org/apache/archiva/repository/RemoteRepository.html#line.30">RemoteRepository</a>
extends <a href="../../../../org/apache/archiva/repository/Repository.html" title="interface in org.apache.archiva.repository">Repository</a></pre>
<div class="block">This represents a repository that is not fully managed by archiva. Its some kind of proxy that
forwards requests to the remote repository and is able to cache artifacts locally.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/repository/RemoteRepository.html#getCheckPath--">getCheckPath</a></span>()</code>
<div class="block">Returns the path relative to the root url of the repository that should be used
to check the availability of the repository.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html" title="interface in org.apache.archiva.repository">RemoteRepositoryContent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/repository/RemoteRepository.html#getContent--">getContent</a></span>()</code>
<div class="block">Returns the interface to access the content of the repository.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/repository/RemoteRepository.html#getExtraHeaders--">getExtraHeaders</a></span>()</code>
<div class="block">Returns extra headers that are added to the request to the remote repository.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/repository/RemoteRepository.html#getExtraParameters--">getExtraParameters</a></span>()</code>
<div class="block">Returns additional parameters, that are used for accessing the remote repository.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/archiva/repository/RepositoryCredentials.html" title="interface in org.apache.archiva.repository">RepositoryCredentials</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/repository/RemoteRepository.html#getLoginCredentials--">getLoginCredentials</a></span>()</code>
<div class="block">Returns the credentials used to login to the remote repository.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html?is-external=true" title="class or interface in java.time">Duration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/archiva/repository/RemoteRepository.html#getTimeout--">getTimeout</a></span>()</code>
<div class="block">Returns the time duration, after that the request is aborted and a error is returned, if the remote repository
does not respond.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.archiva.repository.Repository">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.archiva.repository.<a href="../../../../org/apache/archiva/repository/Repository.html" title="interface in org.apache.archiva.repository">Repository</a></h3>
<code><a href="../../../../org/apache/archiva/repository/Repository.html#close--">close</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getCapabilities--">getCapabilities</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getDescription--">getDescription</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getDescription-java.util.Locale-">getDescription</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getFailoverLocations--">getFailoverLocations</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getFeature-java.lang.Class-">getFeature</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getId--">getId</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getIndexingContext--">getIndexingContext</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getLayout--">getLayout</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getLocalPath--">getLocalPath</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getLocation--">getLocation</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getName--">getName</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getName-java.util.Locale-">getName</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getSchedulingDefinition--">getSchedulingDefinition</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#getType--">getType</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#hasIndex--">hasIndex</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#isOpen--">isOpen</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#isScanned--">isScanned</a>, <a href="../../../../org/apache/archiva/repository/Repository.html#supportsFeature-java.lang.Class-">supportsFeature</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.archiva.event.EventSource">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.archiva.event.<a href="../../../../org/apache/archiva/event/EventSource.html" title="interface in org.apache.archiva.event">EventSource</a></h3>
<code><a href="../../../../org/apache/archiva/event/EventSource.html#registerEventHandler-org.apache.archiva.event.EventType-org.apache.archiva.event.EventHandler-">registerEventHandler</a>, <a href="../../../../org/apache/archiva/event/EventSource.html#unregisterEventHandler-org.apache.archiva.event.EventType-org.apache.archiva.event.EventHandler-">unregisterEventHandler</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.archiva.repository.storage.RepositoryStorage">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.archiva.repository.storage.<a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html" title="interface in org.apache.archiva.repository.storage">RepositoryStorage</a></h3>
<code><a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#addAsset-java.lang.String-boolean-">addAsset</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#consumeData-org.apache.archiva.repository.storage.StorageAsset-java.util.function.Consumer-boolean-">consumeData</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#consumeDataFromChannel-org.apache.archiva.repository.storage.StorageAsset-java.util.function.Consumer-boolean-">consumeDataFromChannel</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#copyAsset-org.apache.archiva.repository.storage.StorageAsset-org.apache.archiva.repository.storage.StorageAsset-java.nio.file.CopyOption...-">copyAsset</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#copyAsset-org.apache.archiva.repository.storage.StorageAsset-java.lang.String-java.nio.file.CopyOption...-">copyAsset</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#getAsset-java.lang.String-">getAsset</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#moveAsset-org.apache.archiva.repository.storage.StorageAsset-org.apache.archiva.repository.storage.StorageAsset-java.nio.file.CopyOption...-">moveAsset</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#moveAsset-org.apache.archiva.repository.storage.StorageAsset-java.lang.String-java.nio.file.CopyOption...-">moveAsset</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#removeAsset-org.apache.archiva.repository.storage.StorageAsset-">removeAsset</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#updateLocation-java.net.URI-">updateLocation</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#writeData-org.apache.archiva.repository.storage.StorageAsset-java.util.function.Consumer-boolean-">writeData</a>, <a href="../../../../org/apache/archiva/repository/storage/RepositoryStorage.html#writeDataToChannel-org.apache.archiva.repository.storage.StorageAsset-java.util.function.Consumer-boolean-">writeDataToChannel</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContent</h4>
<pre><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html" title="interface in org.apache.archiva.repository">RemoteRepositoryContent</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepository.html#line.36">getContent</a>()</pre>
<div class="block">Returns the interface to access the content of the repository.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getLoginCredentials--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLoginCredentials</h4>
<pre><a href="../../../../org/apache/archiva/repository/RepositoryCredentials.html" title="interface in org.apache.archiva.repository">RepositoryCredentials</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepository.html#line.42">getLoginCredentials</a>()</pre>
<div class="block">Returns the credentials used to login to the remote repository.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the credentials, null if not set.</dd>
</dl>
</li>
</ul>
<a name="getCheckPath--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCheckPath</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepository.html#line.49">getCheckPath</a>()</pre>
<div class="block">Returns the path relative to the root url of the repository that should be used
to check the availability of the repository.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The check path, null if not set.</dd>
</dl>
</li>
</ul>
<a name="getExtraParameters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtraParameters</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepository.html#line.56">getExtraParameters</a>()</pre>
<div class="block">Returns additional parameters, that are used for accessing the remote repository.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A map of key, value pairs.</dd>
</dl>
</li>
</ul>
<a name="getExtraHeaders--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtraHeaders</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepository.html#line.63">getExtraHeaders</a>()</pre>
<div class="block">Returns extra headers that are added to the request to the remote repository.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getTimeout--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTimeout</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html?is-external=true" title="class or interface in java.time">Duration</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepository.html#line.70">getTimeout</a>()</pre>
<div class="block">Returns the time duration, after that the request is aborted and a error is returned, if the remote repository
does not respond.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The timeout.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RemoteRepository.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/archiva/repository/RelocatablePath.html" title="class in org.apache.archiva.repository"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html" title="interface in org.apache.archiva.repository"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/archiva/repository/RemoteRepository.html" target="_top">Frames</a></li>
<li><a href="RemoteRepository.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>