io.hawt.maven.indexer

Class MavenIndexerFacade

java.lang.Object

io.hawt.util.MBeanSupport

io.hawt.maven.indexer.MavenIndexerFacade

All Implemented Interfaces:

MavenIndexerFacadeMXBean

public class MavenIndexerFacade
extends io.hawt.util.MBeanSupport
implements MavenIndexerFacadeMXBean

A facade over the Maven indexer code so its easy to query repositories

Constructor Summary

Constructors

Constructor and Description
MavenIndexerFacade()

Method Summary

Modifier and Type	Method and Description
List<String>	artifactIdComplete(String groupId, String artifactId, String packaging, String classifier) Helper method to complete the possible artifact IDs for a given group ID, partial artifact ID and possible packaging and/or classifier
protected ArtifactDTO	createArtifactDTO(org.apache.maven.index.ArtifactInfo ai)
protected org.apache.lucene.search.BooleanQuery	createQuery(String groupId, String artifactId, String version, String packaging, String classifier, String className)
protected org.apache.lucene.search.BooleanQuery	createTextSearchQuery(String searchText)
void	destroy()
void	downloadOrUpdateIndices()
protected String	endWithStarIfNotBlank(String text) If the string is not blank then return a trimmed version of it ending in *
File	getCacheDirectory()
String	getCacheDirName()
protected String	getDefaultObjectName()
List<org.apache.maven.index.context.IndexCreator>	getIndexers()
int	getMaximumIndexersPerMachine()
String	getRepositories() Returns the current list of maven repositories
List<String>	groupIdComplete(String groupId, String packaging, String classifier) Helper method to complete the possible group IDs for a given partial group ID and possible packaging and/or classifier
void	init()
boolean	isUpdateIndexOnStartup()
List<ArtifactDTO>	search(String groupId, String artifactId, String version, String packaging, String classifier, String className) Returns the latest version of each artifact that matches any of the given strings like groupId or groupId and artifactId etc
List<ArtifactDTO>	searchClasses(String classNameSearchText) Attempts to search for the artifact with the given class name.
List<ArtifactDTO>	searchFlat(org.apache.lucene.search.BooleanQuery q)
List<ArtifactDTO>	searchFlat(String groupId, String artifactId, String version, String packaging, String classifier, String className) Returns all versions and artifacts that match the given query; such as to find all versions of a given groupId and artifactId.
List<ArtifactDTO>	searchGrouped(org.apache.lucene.search.Query query)
List<ArtifactDTO>	searchGrouped(org.apache.lucene.search.Query query, org.apache.maven.index.search.grouping.GAGrouping grouping)
List<ArtifactDTO>	searchText(String searchText) Attempts to search the maven repositories given some text to search for
List<ArtifactDTO>	searchTextAndPackaging(String searchText, String packaging, String classifier) Searches for all artifacts for the given text with the optional packaging/classifier filter, returning the latest matching artifact version
void	setCacheDirectory(File cacheDirectory)
void	setCacheDirName(String cacheDirName)
void	setIndexers(List<org.apache.maven.index.context.IndexCreator> indexers)
void	setMaximumIndexersPerMachine(int maximumIndexersPerMachine) If we do not specify the directory to use for caches, then create a directory per process up to this maximum number
void	setRepositories(String repositories) Param is a String, instead of a String[] to support properties replacement in blueprint
void	setUpdateIndexOnStartup(boolean updateIndexOnStartup)
List<String>	versionComplete(String groupId, String artifactId, String version, String packaging, String classifier) Helper method to complete the possible versions for a given group ID, artifact, partial version and possible packaging and/or classifier

Methods inherited from class io.hawt.util.MBeanSupport

getMBeanServer, getObjectName, setMBeanServer, setObjectName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MavenIndexerFacade

public MavenIndexerFacade()

Method Detail

init

public void init()
          throws Exception

Overrides:

init in class io.hawt.util.MBeanSupport

Throws:

Exception

downloadOrUpdateIndices

public void downloadOrUpdateIndices()
                             throws IOException

Throws:

IOException

destroy

public void destroy()
             throws Exception

Overrides:

destroy in class io.hawt.util.MBeanSupport

Throws:

Exception

isUpdateIndexOnStartup

public boolean isUpdateIndexOnStartup()

setUpdateIndexOnStartup

public void setUpdateIndexOnStartup(boolean updateIndexOnStartup)

getIndexers

public List<org.apache.maven.index.context.IndexCreator> getIndexers()

setIndexers

public void setIndexers(List<org.apache.maven.index.context.IndexCreator> indexers)

getRepositories

public String getRepositories()

Description copied from interface: MavenIndexerFacadeMXBean

Returns the current list of maven repositories

Specified by:

getRepositories in interface MavenIndexerFacadeMXBean

setRepositories

public void setRepositories(String repositories)

Param is a String, instead of a String[] to support properties replacement in blueprint

Parameters:

repositories -

getMaximumIndexersPerMachine

public int getMaximumIndexersPerMachine()

setMaximumIndexersPerMachine

public void setMaximumIndexersPerMachine(int maximumIndexersPerMachine)

If we do not specify the directory to use for caches, then create a directory per process up to this maximum number

getCacheDirName

public String getCacheDirName()

setCacheDirName

public void setCacheDirName(String cacheDirName)

getCacheDirectory

public File getCacheDirectory()

setCacheDirectory

public void setCacheDirectory(File cacheDirectory)

search

public List<ArtifactDTO> search(String groupId,
                                String artifactId,
                                String version,
                                String packaging,
                                String classifier,
                                String className)
                         throws IOException

Description copied from interface: MavenIndexerFacadeMXBean

Returns the latest version of each artifact that matches any of the given strings like groupId or groupId and artifactId etc

Specified by:

search in interface MavenIndexerFacadeMXBean

Throws:

IOException

searchFlat

public List<ArtifactDTO> searchFlat(String groupId,
                                    String artifactId,
                                    String version,
                                    String packaging,
                                    String classifier,
                                    String className)
                             throws IOException

Description copied from interface: MavenIndexerFacadeMXBean

Returns all versions and artifacts that match the given query; such as to find all versions of a given groupId and artifactId.

Specified by:

searchFlat in interface MavenIndexerFacadeMXBean

Throws:

IOException

searchClasses

public List<ArtifactDTO> searchClasses(String classNameSearchText)
                                throws IOException

Attempts to search for the artifact with the given class name.

Note that the central repository does not index class names

Specified by:

searchClasses in interface MavenIndexerFacadeMXBean

Throws:

IOException

searchText

public List<ArtifactDTO> searchText(String searchText)
                             throws IOException

Attempts to search the maven repositories given some text to search for

Specified by:

searchText in interface MavenIndexerFacadeMXBean

Throws:

IOException

searchTextAndPackaging

public List<ArtifactDTO> searchTextAndPackaging(String searchText,
                                                String packaging,
                                                String classifier)
                                         throws IOException

Description copied from interface: MavenIndexerFacadeMXBean

Searches for all artifacts for the given text with the optional packaging/classifier filter, returning the latest matching artifact version

Specified by:

searchTextAndPackaging in interface MavenIndexerFacadeMXBean

Throws:

IOException

searchGrouped

public List<ArtifactDTO> searchGrouped(org.apache.lucene.search.Query query)
                                throws IOException

Throws:

IOException

searchGrouped

public List<ArtifactDTO> searchGrouped(org.apache.lucene.search.Query query,
                                       org.apache.maven.index.search.grouping.GAGrouping grouping)
                                throws IOException

Throws:

IOException

searchFlat

public List<ArtifactDTO> searchFlat(org.apache.lucene.search.BooleanQuery q)
                             throws IOException

Throws:

IOException

groupIdComplete

public List<String> groupIdComplete(String groupId,
                                    String packaging,
                                    String classifier)
                             throws IOException

Description copied from interface: MavenIndexerFacadeMXBean

Helper method to complete the possible group IDs for a given partial group ID and possible packaging and/or classifier

Specified by:

groupIdComplete in interface MavenIndexerFacadeMXBean

Throws:

IOException

artifactIdComplete

public List<String> artifactIdComplete(String groupId,
                                       String artifactId,
                                       String packaging,
                                       String classifier)
                                throws IOException

Description copied from interface: MavenIndexerFacadeMXBean

Helper method to complete the possible artifact IDs for a given group ID, partial artifact ID and possible packaging and/or classifier

Specified by:

artifactIdComplete in interface MavenIndexerFacadeMXBean

Throws:

IOException

versionComplete

public List<String> versionComplete(String groupId,
                                    String artifactId,
                                    String version,
                                    String packaging,
                                    String classifier)
                             throws IOException

Description copied from interface: MavenIndexerFacadeMXBean

Helper method to complete the possible versions for a given group ID, artifact, partial version and possible packaging and/or classifier

Specified by:

versionComplete in interface MavenIndexerFacadeMXBean

Throws:

IOException

createQuery

protected org.apache.lucene.search.BooleanQuery createQuery(String groupId,
                                                            String artifactId,
                                                            String version,
                                                            String packaging,
                                                            String classifier,
                                                            String className)

createTextSearchQuery

protected org.apache.lucene.search.BooleanQuery createTextSearchQuery(String searchText)

getDefaultObjectName

protected String getDefaultObjectName()

Specified by:

getDefaultObjectName in class io.hawt.util.MBeanSupport

endWithStarIfNotBlank

protected String endWithStarIfNotBlank(String text)

If the string is not blank then return a trimmed version of it ending in *

createArtifactDTO

protected ArtifactDTO createArtifactDTO(org.apache.maven.index.ArtifactInfo ai)