blob: 49da1f20f6aec7296cb68177eb07f5b584294c2e [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>ArchivaConfiguration (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="ArchivaConfiguration (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/ArchivaConfiguration.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/configuration/AbstractRepositoryConnectorConfiguration.html" title="class in org.apache.archiva.configuration"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/archiva/configuration/ArchivaDefaultConfiguration.html" title="class in org.apache.archiva.configuration"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/archiva/configuration/ArchivaConfiguration.html" target="_top">Frames</a></li>
<li><a href="ArchivaConfiguration.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.configuration</div>
<h2 title="Interface ArchivaConfiguration" class="title">Interface ArchivaConfiguration</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/configuration/DefaultArchivaConfiguration.html" title="class in org.apache.archiva.configuration">DefaultArchivaConfiguration</a></dd>
</dl>
<hr>
<br>
<pre>public interface <a href="../../../../src-html/org/apache/archiva/configuration/ArchivaConfiguration.html#line.28">ArchivaConfiguration</a></pre>
<div class="block">Configuration holder for the model read from the registry.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/configuration/ArchivaConfiguration.html#addChangeListener(org.apache.archiva.redback.components.registry.RegistryListener)">addChangeListener</a></strong>(org.apache.archiva.redback.components.registry.RegistryListener&nbsp;listener)</code>
<div class="block">Add a registry listener to notify of events in spring-registry.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/configuration/ArchivaConfiguration.html#addListener(org.apache.archiva.configuration.ConfigurationListener)">addListener</a></strong>(<a href="../../../../org/apache/archiva/configuration/ConfigurationListener.html" title="interface in org.apache.archiva.configuration">ConfigurationListener</a>&nbsp;listener)</code>
<div class="block">Add a configuration listener to notify of changes to the configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/archiva/configuration/Configuration.html" title="class in org.apache.archiva.configuration">Configuration</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/configuration/ArchivaConfiguration.html#getConfiguration()">getConfiguration</a></strong>()</code>
<div class="block">Get the configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/configuration/ArchivaConfiguration.html#isDefaulted()">isDefaulted</a></strong>()</code>
<div class="block">Determines if the configuration in use was as a result of a defaulted configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/configuration/ArchivaConfiguration.html#reload()">reload</a></strong>()</code>
<div class="block">reload configuration from file included registry</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/configuration/ArchivaConfiguration.html#removeChangeListener(org.apache.archiva.redback.components.registry.RegistryListener)">removeChangeListener</a></strong>(org.apache.archiva.redback.components.registry.RegistryListener&nbsp;listener)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/configuration/ArchivaConfiguration.html#removeListener(org.apache.archiva.configuration.ConfigurationListener)">removeListener</a></strong>(<a href="../../../../org/apache/archiva/configuration/ConfigurationListener.html" title="interface in org.apache.archiva.configuration">ConfigurationListener</a>&nbsp;listener)</code>
<div class="block">Remove a configuration listener to stop notifications of changes to the configuration.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/archiva/configuration/ArchivaConfiguration.html#save(org.apache.archiva.configuration.Configuration)">save</a></strong>(<a href="../../../../org/apache/archiva/configuration/Configuration.html" title="class in org.apache.archiva.configuration">Configuration</a>&nbsp;configuration)</code>
<div class="block">Save any updated configuration.</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="getConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre><a href="../../../../org/apache/archiva/configuration/Configuration.html" title="class in org.apache.archiva.configuration">Configuration</a>&nbsp;<a href="../../../../src-html/org/apache/archiva/configuration/ArchivaConfiguration.html#line.35">getConfiguration</a>()</pre>
<div class="block">Get the configuration.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the configuration</dd></dl>
</li>
</ul>
<a name="save(org.apache.archiva.configuration.Configuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>save</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/archiva/configuration/ArchivaConfiguration.html#line.46">save</a>(<a href="../../../../org/apache/archiva/configuration/Configuration.html" title="class in org.apache.archiva.configuration">Configuration</a>&nbsp;configuration)
throws org.apache.archiva.redback.components.registry.RegistryException,
<a href="../../../../org/apache/archiva/configuration/IndeterminateConfigurationException.html" title="class in org.apache.archiva.configuration">IndeterminateConfigurationException</a></pre>
<div class="block">Save any updated configuration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>configuration</code> - the configuration to save</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>org.apache.archiva.redback.components.registry.RegistryException</code> - if there is a problem saving the registry data</dd>
<dd><code><a href="../../../../org/apache/archiva/configuration/IndeterminateConfigurationException.html" title="class in org.apache.archiva.configuration">IndeterminateConfigurationException</a></code> - if the configuration cannot be saved because it was read from two sources</dd></dl>
</li>
</ul>
<a name="isDefaulted()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDefaulted</h4>
<pre>boolean&nbsp;<a href="../../../../src-html/org/apache/archiva/configuration/ArchivaConfiguration.html#line.56">isDefaulted</a>()</pre>
<div class="block">Determines if the configuration in use was as a result of a defaulted configuration.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if the configuration was created from the default-archiva.xml as opposed
to being loaded from the usual locations of ${user.home}/.m2/archiva.xml or
${appserver.base}/conf/archiva.xml</dd></dl>
</li>
</ul>
<a name="addListener(org.apache.archiva.configuration.ConfigurationListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addListener</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/archiva/configuration/ArchivaConfiguration.html#line.63">addListener</a>(<a href="../../../../org/apache/archiva/configuration/ConfigurationListener.html" title="interface in org.apache.archiva.configuration">ConfigurationListener</a>&nbsp;listener)</pre>
<div class="block">Add a configuration listener to notify of changes to the configuration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener</dd></dl>
</li>
</ul>
<a name="removeListener(org.apache.archiva.configuration.ConfigurationListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeListener</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/archiva/configuration/ArchivaConfiguration.html#line.70">removeListener</a>(<a href="../../../../org/apache/archiva/configuration/ConfigurationListener.html" title="interface in org.apache.archiva.configuration">ConfigurationListener</a>&nbsp;listener)</pre>
<div class="block">Remove a configuration listener to stop notifications of changes to the configuration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener</dd></dl>
</li>
</ul>
<a name="addChangeListener(org.apache.archiva.redback.components.registry.RegistryListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addChangeListener</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/archiva/configuration/ArchivaConfiguration.html#line.78">addChangeListener</a>(org.apache.archiva.redback.components.registry.RegistryListener&nbsp;listener)</pre>
<div class="block">Add a registry listener to notify of events in spring-registry.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - the listener
TODO: Remove in future.</dd></dl>
</li>
</ul>
<a name="removeChangeListener(org.apache.archiva.redback.components.registry.RegistryListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeChangeListener</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/archiva/configuration/ArchivaConfiguration.html#line.80">removeChangeListener</a>(org.apache.archiva.redback.components.registry.RegistryListener&nbsp;listener)</pre>
</li>
</ul>
<a name="reload()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reload</h4>
<pre>void&nbsp;<a href="../../../../src-html/org/apache/archiva/configuration/ArchivaConfiguration.html#line.87">reload</a>()</pre>
<div class="block">reload configuration from file included registry</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.4-M1</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/ArchivaConfiguration.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/configuration/AbstractRepositoryConnectorConfiguration.html" title="class in org.apache.archiva.configuration"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/archiva/configuration/ArchivaDefaultConfiguration.html" title="class in org.apache.archiva.configuration"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/archiva/configuration/ArchivaConfiguration.html" target="_top">Frames</a></li>
<li><a href="ArchivaConfiguration.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>