blob: 5982175a303a14db67a743778cc971e8a59cb526 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RemoteRepositoryContent (Archiva :: Modules 2.2.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RemoteRepositoryContent (Archiva :: Modules 2.2.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/RemoteRepositoryContent.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/ManagedRepositoryContent.html" title="interface in org.apache.archiva.repository"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/archiva/repository/RepositoryContentFactory.html" title="class in org.apache.archiva.repository"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/archiva/repository/RemoteRepositoryContent.html" target="_top">Frames</a></li>
<li><a href="RemoteRepositoryContent.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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 RemoteRepositoryContent" class="title">Interface RemoteRepositoryContent</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/archiva/repository/content/maven2/RemoteDefaultRepositoryContent.html" title="class in org.apache.archiva.repository.content.maven2">RemoteDefaultRepositoryContent</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../src-html/org/apache/archiva/repository/RemoteRepositoryContent.html#line.33">RemoteRepositoryContent</a></pre>
<div class="block">RemoteRepositoryContent interface for interacting with a remote repository in an abstract way,
without the need for processing based on URLs, or working with the database.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html#getId()">getId</a></strong>()</code>
<div class="block">
Convenience method to get the repository id.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/archiva/admin/model/beans/RemoteRepository.html" title="class in org.apache.archiva.admin.model.beans">RemoteRepository</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html#getRepository()">getRepository</a></strong>()</code>
<div class="block">Get the repository configuration associated with this
repository content.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/archiva/model/RepositoryURL.html" title="class in org.apache.archiva.model">RepositoryURL</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html#getURL()">getURL</a></strong>()</code>
<div class="block">
Convenience method to get the repository url.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html#setRepository(org.apache.archiva.admin.model.beans.RemoteRepository)">setRepository</a></strong>(<a href="../../../../org/apache/archiva/admin/model/beans/RemoteRepository.html" title="class in org.apache.archiva.admin.model.beans">RemoteRepository</a>&nbsp;repo)</code>
<div class="block">Set the repository configuration to associate with this
repository content.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/archiva/model/ArtifactReference.html" title="class in org.apache.archiva.model">ArtifactReference</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html#toArtifactReference(java.lang.String)">toArtifactReference</a></strong>(<a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)</code>
<div class="block">Given a repository relative path to a filename, return the <a href="../../../../org/apache/archiva/model/VersionedReference.html" title="class in org.apache.archiva.model"><code>VersionedReference</code></a> object suitable for the path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html#toPath(org.apache.archiva.model.ArtifactReference)">toPath</a></strong>(<a href="../../../../org/apache/archiva/model/ArtifactReference.html" title="class in org.apache.archiva.model">ArtifactReference</a>&nbsp;reference)</code>
<div class="block">Given an ArtifactReference, return the relative path to the artifact.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/archiva/model/RepositoryURL.html" title="class in org.apache.archiva.model">RepositoryURL</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/repository/RemoteRepositoryContent.html#toURL(org.apache.archiva.model.ArtifactReference)">toURL</a></strong>(<a href="../../../../org/apache/archiva/model/ArtifactReference.html" title="class in org.apache.archiva.model">ArtifactReference</a>&nbsp;reference)</code>
<div class="block">Given an ArtifactReference, return the url to the artifact.</div>
</td>
</tr>
</table>
</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="getId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre><a href="http://java.sun.com/j2se/1.5.0/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/RemoteRepositoryContent.html#line.46">getId</a>()</pre>
<div class="block"><p>
Convenience method to get the repository id.
</p>
<p>
Equivalent to calling <code>.getRepository().getId()</code>
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the repository id.</dd></dl>
</li>
</ul>
<a name="getRepository()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRepository</h4>
<pre><a href="../../../../org/apache/archiva/admin/model/beans/RemoteRepository.html" title="class in org.apache.archiva.admin.model.beans">RemoteRepository</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepositoryContent.html#line.54">getRepository</a>()</pre>
<div class="block">Get the repository configuration associated with this
repository content.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the repository that is associated with this repository content.</dd></dl>
</li>
</ul>
<a name="getURL()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURL</h4>
<pre><a href="../../../../org/apache/archiva/model/RepositoryURL.html" title="class in org.apache.archiva.model">RepositoryURL</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepositoryContent.html#line.67">getURL</a>()</pre>
<div class="block"><p>
Convenience method to get the repository url.
</p>
<p>
Equivalent to calling <code>new RepositoryURL( this.getRepository().getUrl() )</code>
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the repository url.</dd></dl>
</li>
</ul>
<a name="setRepository(org.apache.archiva.admin.model.beans.RemoteRepository)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRepository</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepositoryContent.html#line.75">setRepository</a>(<a href="../../../../org/apache/archiva/admin/model/beans/RemoteRepository.html" title="class in org.apache.archiva.admin.model.beans">RemoteRepository</a>&nbsp;repo)</pre>
<div class="block">Set the repository configuration to associate with this
repository content.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repo</code> - the repository to associate with this repository content.</dd></dl>
</li>
</ul>
<a name="toArtifactReference(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArtifactReference</h4>
<pre><a href="../../../../org/apache/archiva/model/ArtifactReference.html" title="class in org.apache.archiva.model">ArtifactReference</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepositoryContent.html#line.85">toArtifactReference</a>(<a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;path)
throws <a href="../../../../org/apache/archiva/repository/layout/LayoutException.html" title="class in org.apache.archiva.repository.layout">LayoutException</a></pre>
<div class="block">Given a repository relative path to a filename, return the <a href="../../../../org/apache/archiva/model/VersionedReference.html" title="class in org.apache.archiva.model"><code>VersionedReference</code></a> object suitable for the path.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path relative to the repository base dir for the artifact.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../org/apache/archiva/model/ArtifactReference.html" title="class in org.apache.archiva.model"><code>ArtifactReference</code></a> representing the path. (or null if path cannot be converted to
a <a href="../../../../org/apache/archiva/model/ArtifactReference.html" title="class in org.apache.archiva.model"><code>ArtifactReference</code></a>)</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/archiva/repository/layout/LayoutException.html" title="class in org.apache.archiva.repository.layout">LayoutException</a></code> - if there was a problem converting the path to an artifact.</dd></dl>
</li>
</ul>
<a name="toPath(org.apache.archiva.model.ArtifactReference)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPath</h4>
<pre><a href="http://java.sun.com/j2se/1.5.0/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/RemoteRepositoryContent.html#line.94">toPath</a>(<a href="../../../../org/apache/archiva/model/ArtifactReference.html" title="class in org.apache.archiva.model">ArtifactReference</a>&nbsp;reference)</pre>
<div class="block">Given an ArtifactReference, return the relative path to the artifact.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - the artifact reference to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the relative path to the artifact.</dd></dl>
</li>
</ul>
<a name="toURL(org.apache.archiva.model.ArtifactReference)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toURL</h4>
<pre><a href="../../../../org/apache/archiva/model/RepositoryURL.html" title="class in org.apache.archiva.model">RepositoryURL</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/repository/RemoteRepositoryContent.html#line.102">toURL</a>(<a href="../../../../org/apache/archiva/model/ArtifactReference.html" title="class in org.apache.archiva.model">ArtifactReference</a>&nbsp;reference)</pre>
<div class="block">Given an ArtifactReference, return the url to the artifact.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - the artifact reference to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the relative path to the artifact.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/RemoteRepositoryContent.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/ManagedRepositoryContent.html" title="interface in org.apache.archiva.repository"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/archiva/repository/RepositoryContentFactory.html" title="class in org.apache.archiva.repository"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/archiva/repository/RemoteRepositoryContent.html" target="_top">Frames</a></li>
<li><a href="RemoteRepositoryContent.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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;2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>