| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia |
| | Rendered using Apache Maven Fluido Skin 1.3.1 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="author" content="Maria Odea Ching |
| Olivier Lamy" /> |
| <meta name="Date-Creation-yyyymmdd" content="20120911" /> |
| <meta name="Date-Revision-yyyymmdd" content="20150226" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Archiva Documentation - Searching</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.1.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="../js/apache-maven-fluido-1.3.1.min.js"></script> |
| |
| |
| <!-- Google Analytics --> |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140879-5']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <a href="../../../" id="bannerLeft"> |
| <img src="../../../images/archiva.png" alt="Apache Archiva"/> |
| </a> |
| </div> |
| <div class="pull-right"> <a href="http://www.apache.org/" id="bannerRight"> |
| <img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Software Foundation"/> |
| </a> |
| </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li class=""> |
| <a href="http://www.apache.org/" class="externalLink" title="Apache"> |
| Apache</a> |
| <span class="divider">/</span> |
| </li> |
| <li class=""> |
| <a href="../" title="Apache Archiva"> |
| Apache Archiva</a> |
| <span class="divider">/</span> |
| </li> |
| <li class=""> |
| <a href="../../../index.html" title="Apache Archiva"> |
| Apache Archiva</a> |
| <span class="divider">/</span> |
| </li> |
| <li class="active ">Searching</li> |
| |
| |
| |
| <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-02-26</li> |
| <li id="projectVersion" class="pull-right"> |
| Version: 2.2.0 |
| </li> |
| |
| </ul> |
| </div> |
| |
| |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div class="well sidebar-nav"> |
| |
| |
| <ul class="nav nav-list"> |
| <li class="nav-header">Introduction</li> |
| |
| <li> |
| |
| <a href="../quick-start.html" title="Quick Start"> |
| <i class="none"></i> |
| Quick Start</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tour/index.html" title="Feature Tour"> |
| <i class="none"></i> |
| Feature Tour</a> |
| </li> |
| |
| <li> |
| |
| <a href="../release-notes.html" title="Release Notes"> |
| <i class="none"></i> |
| Release Notes</a> |
| </li> |
| |
| <li> |
| |
| <a href="../../../download.html" title="Downloads"> |
| <i class="none"></i> |
| Downloads</a> |
| </li> |
| <li class="nav-header">Users Guide</li> |
| |
| <li> |
| |
| <a href="../userguide/browsing.html" title="Browsing"> |
| <i class="none"></i> |
| Browsing</a> |
| </li> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="none"></i>Searching</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/delete-artifact.html" title="Deleting an Artifact"> |
| <i class="none"></i> |
| Deleting an Artifact</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/using-repository.html" title="Using as a repository"> |
| <i class="none"></i> |
| Using as a repository</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/deploy.html" title="Deploying to repository"> |
| <i class="none"></i> |
| Deploying to repository</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/virtual-repositories.html" title="Configuring Virtual Repositories"> |
| <i class="none"></i> |
| Configuring Virtual Repositories</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/rss.html" title="Rss Feeds in Archiva"> |
| <i class="none"></i> |
| Rss Feeds in Archiva</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/querying-artifacts.html" title="Querying Artifacts"> |
| <i class="none"></i> |
| Querying Artifacts</a> |
| </li> |
| <li class="nav-header">Administrators Guide</li> |
| |
| <li> |
| |
| <a href="../adminguide/installing.html" title="Installing Archiva"> |
| <i class="icon-chevron-right"></i> |
| Installing Archiva</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/databases.html" title="Databases"> |
| <i class="none"></i> |
| Databases</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/repositories-content-storage.html" title="Repositories Content Storage"> |
| <i class="none"></i> |
| Repositories Content Storage</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/security.html" title="Security"> |
| <i class="icon-chevron-right"></i> |
| Security</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/configuration.html" title="Archiva Configuration"> |
| <i class="icon-chevron-right"></i> |
| Archiva Configuration</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/webservices/rest.html" title="REST Apis"> |
| <i class="none"></i> |
| REST Apis</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/configuration-files.html" title="Configuration Files"> |
| <i class="none"></i> |
| Configuration Files</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/system-status.html" title="System Status"> |
| <i class="none"></i> |
| System Status</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/logging.html" title="Log Files"> |
| <i class="icon-chevron-right"></i> |
| Log Files</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/reports.html" title="Reports"> |
| <i class="none"></i> |
| Reports</a> |
| </li> |
| <li class="nav-header">Customising Archiva</li> |
| |
| <li> |
| |
| <a href="../customising/writing-consumer.html" title="Writing a Consumer Plugin"> |
| <i class="none"></i> |
| Writing a Consumer Plugin</a> |
| </li> |
| <li class="nav-header">More Information</li> |
| |
| <li> |
| |
| <a href="http://cwiki.apache.org/confluence/display/ARCHIVA/Index" class="externalLink" title="Archiva Wiki"> |
| <i class="none"></i> |
| Archiva Wiki</a> |
| </li> |
| <li class="nav-header">ASF</li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"> |
| <i class="none"></i> |
| How Apache Works</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation"> |
| <i class="none"></i> |
| Foundation</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"> |
| <i class="none"></i> |
| Sponsoring Apache</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"> |
| <i class="none"></i> |
| Thanks</a> |
| </li> |
| <li class="nav-header">Project Documentation</li> |
| |
| <li> |
| |
| <a href="../project-info.html" title="Project Information"> |
| <i class="icon-chevron-right"></i> |
| Project Information</a> |
| </li> |
| </ul> |
| |
| |
| <form id="search-form" action="http://www.google.com/search" method="get" > |
| |
| <input value="http://archiva.apache.org/docs/2.2.0/" name="sitesearch" type="hidden"/> |
| <input class="search-query" name="q" id="query" type="text" /> |
| </form> |
| <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script> |
| |
| <hr /> |
| |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| |
| |
| |
| <div id="twitter"> |
| |
| <a href="https://twitter.com/archiva" class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow archiva</a> |
| <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> |
| |
| </div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> |
| </a> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="bodyColumn" class="span10" > |
| |
| <!-- Licensed to the Apache Software Foundation (ASF) under one --><!-- or more contributor license agreements. See the NOTICE file --><!-- distributed with this work for additional information --><!-- regarding copyright ownership. The ASF licenses this file --><!-- to you under the Apache License, Version 2.0 (the --><!-- "License"); you may not use this file except in compliance --><!-- with the License. You may obtain a copy of the License at --><!-- --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!-- --><!-- Unless required by applicable law or agreed to in writing, --><!-- software distributed under the License is distributed on an --><!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --><!-- KIND, either express or implied. See the License for the --><!-- specific language governing permissions and limitations --><!-- under the License. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/guides/mini/guide-apt-format.html --><div class="section"> |
| <h2>Searching<a name="Searching"></a></h2> |
| <p>The Search functionality of Archiva allows a user to search for specific artifact references in the repository.</p> |
| <div class="section"> |
| <h3>Indexing<a name="Indexing"></a></h3> |
| <p>Before artifacts can be searched in Archiva, they need to be indexed first. Aritfacts are indexed during these instances:</p> |
| <ul> |
| <li>when a repository is scanned</li> |
| <li>when an artifact is deployed or uploaded in the repository</li> |
| <li>when an artifact is proxied or downloaded from a remote repository</li> |
| <li>when remote index is available and downloaded</li></ul> |
| <p>During repository scanning, the <tt>index-content</tt> consumer (see <a href="../adminguide/consumers.html">Consumers</a>) creates an indexing task and queues it in an indexing task queue. This indexing task is in turn executed by a task executor and that's where the actual indexing happens. A similar indexing task is also created and queued as artifacts are deployed in the Archiva repository or proxied from a remote repository. The reason behind this is to avoid multiple or simultaneous update of the index (a repository scan might be executing while artifacts are being deployed in the repository). <i>Note:</i> This behavior applies for versions starting 1.2.1.</p></div> |
| <div class="section"> |
| <h3>What Can Be Searched?<a name="What_Can_Be_Searched"></a></h3> |
| <p>The repository files that are indexed during repository scan can be configured in the Repository Scanning page, in the Repository Scanning - File Types section (indexable-content). By default, the indexable-content file types are:</p> |
| <div> |
| <pre>**/*.txt |
| **/*.TXT |
| **/*.block |
| **/*.config |
| **/*.pom |
| **/*.xml |
| **/*.xsd |
| **/*.dtd |
| **/*.tld</pre></div></div> |
| <div class="section"> |
| <h3>Quick Search<a name="Quick_Search"></a></h3> |
| <p>The contents of all the files in the repository that matches the above configuration will be indexed during repository scan. So when you type a word in the search box, Archiva will search the index for that query string and return all the search hits in the form of a paginated list of artifacts. For example you typed in 'ant', the search result would contain the list of artifacts that use or reference 'ant'.</p> |
| <p>For query strings containing whitespaces, Archiva searches for the query string including the whitespaces. So if you typed in 'commons logging', the search result would contain the list of artifacts that reference 'commons logging' which is still separated by whitespace. In this case, 'commons-logging' (hyphen separated) is not included in the search results.</p> |
| <p>Archiva can also search the index for java classes, packages, and methods and return a list of artifacts containing the query string. In the previous versions, we need to append the keyword 'bytecode:' before the query string in the search box (like 'bytecode:myMethod'). But since version 1.2, we no longer need to type the keyword. Just type the java class or package name in the search box.. and voila!</p> |
| <p>You can use various criterias to search artifacts:</p> |
| <div class="section"> |
| <h4>Simple Query string<a name="Simple_Query_string"></a></h4><img src="../images/search-simple.png" alt="" /></div> |
| <div class="section"> |
| <h4>Advanced Paramters<a name="Advanced_Paramters"></a></h4><img src="../images/search-advanced.png" alt="" /></div> |
| <div class="section"> |
| <h4>OSGI Parameters<a name="OSGI_Parameters"></a></h4><img src="../images/search-osgi.png" alt="" /></div></div> |
| <div class="section"> |
| <h3>Search results<a name="Search_results"></a></h3> |
| <p>You can apply various filters on the search results.</p> |
| <p>Below is a sample screenshot of the search results:</p><img src="../images/search-results.png" alt="Search Results" /> |
| <p>When the user clicks a specific artifact in the search results list, Archiva will direct the user in the Artifact Info page (the same page from the Repository Browse). Otherwise if it is not a pom file (ex. metadata.xml), the file will appear as a file to be downloaded from the browser.</p></div> |
| <div class="section"> |
| <h3>Security<a name="Security"></a></h3> |
| <p>The Search functionality respects the repository permissions. If the user is not logged in to Archiva and does a search, only those repositories with guest permissions will be searched for the query string. And if the user is logged in to Archiva and does a search, only those repositories in which that user has permission to access will be searched for the query string.</p></div></div> |
| </div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p >Copyright © 2006–2015 |
| <a href="http://www.apache.org/">The Apache Software Foundation</a>. |
| All rights reserved. |
| |
| </p> |
| </div> |
| |
| |
| <div class="row span12">Apache Archiva :: Documentation, Archiva :: Documentation, Apache, the Apache feather logo, and the Apache Archiva :: Documentation project logos are trademarks of The Apache Software Foundation.</div> |
| |
| <div class="row span12"> |
| <a href="http://archiva.apache.org/docs/2.2.0/privacy-policy.html">Privacy Policy</a> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div id="ohloh" class="pull-right"> |
| <script type="text/javascript" src="http://www.ohloh.net/p/6670/widgets/project_basic_stats.js"></script> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
