com.redhat.rhn.frontend.xmlrpc.packages.search

Class PackagesSearchHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.packages.search.PackagesSearchHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class PackagesSearchHandler
extends BaseHandler

PackagesSearchHandler

Field Summary

Fields inherited from class com.redhat.rhn.frontend.xmlrpc.BaseHandler

VALID

Constructor Summary

Constructors

Constructor and Description
PackagesSearchHandler()

Method Summary

Modifier and Type	Method and Description
java.util.List<PackageOverview>	advanced(java.lang.String sessionKey, java.lang.String luceneQuery) Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax.
java.util.List<PackageOverview>	advancedWithActKey(java.lang.String sessionKey, java.lang.String luceneQuery, java.lang.String actKey) Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax, additionally this method will limit results to those which are associated with a given activation key.
java.util.List<PackageOverview>	advancedWithChannel(java.lang.String sessionKey, java.lang.String luceneQuery, java.lang.String channelLabel) Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax, additionally this method will limit results to those which are in the passed in channel label. Lucene Query Parser syntax is defined at lucene.apache.org: http://lucene.apache.org/java/3_5_0/queryparsersyntax.html Fields searchable for Packages: name, epoch, version, release, arch, description, summary Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"
java.util.List<PackageOverview>	name(java.lang.String sessionKey, java.lang.String name) Searches the lucene package indexes based on package name
java.util.List<PackageOverview>	nameAndDescription(java.lang.String sessionKey, java.lang.String query) Searches the lucene package indexes based on package name or description
java.util.List<PackageOverview>	nameAndSummary(java.lang.String sessionKey, java.lang.String query) Searches the lucene package indexes based on package name or summary
protected java.util.List<PackageOverview>	performSearch(java.lang.String sessionKey, java.lang.String query, java.lang.String mode)

Methods inherited from class com.redhat.rhn.frontend.xmlrpc.BaseHandler

ensureConfigAdmin, ensureOrgAdmin, ensureOrgOrConfigAdmin, ensureSatAdmin, ensureSystemGroupAdmin, ensureUserRole, getLoggedInUser, invoke, providesAuthentication, setEntityAttribute, validateClientCertificate, validateEntitlements, validateMap, verifyOrgExists

Methods inherited from class java.lang.Object

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

Constructor Detail

PackagesSearchHandler

public PackagesSearchHandler()

Method Detail

name

public java.util.List<PackageOverview> name(java.lang.String sessionKey,
                                            java.lang.String name)
                                     throws FaultException

Searches the lucene package indexes based on package name

Parameters:

sessionKey - The sessionKey for the logged in used

name - - package name to search for

Returns:

the package objects requested

Throws:

FaultException - A FaultException is thrown on error.

nameAndDescription

public java.util.List<PackageOverview> nameAndDescription(java.lang.String sessionKey,
                                                          java.lang.String query)
                                                   throws FaultException

Searches the lucene package indexes based on package name or description

Parameters:

sessionKey - The sessionKey for the logged in used

query - -text to match in package name and description

Returns:

the package objects requested

Throws:

FaultException - A FaultException is thrown on error.

nameAndSummary

public java.util.List<PackageOverview> nameAndSummary(java.lang.String sessionKey,
                                                      java.lang.String query)
                                               throws FaultException

Searches the lucene package indexes based on package name or summary

Parameters:

sessionKey - The sessionKey for the logged in used

query - -text to match in package name and summary

Returns:

the package objects requested

Throws:

FaultException - A FaultException is thrown on error.

advanced

public java.util.List<PackageOverview> advanced(java.lang.String sessionKey,
                                                java.lang.String luceneQuery)
                                         throws FaultException

Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax. Lucene Query Parser syntax is defined at lucene.apache.org: http://lucene.apache.org/java/3_5_0/queryparsersyntax.html Fields searchable for Packages: name, epoch, version, release, arch, description, summary Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"

Parameters:

sessionKey - The sessionKey for the logged in used

luceneQuery - - a search query written in the form of Lucene QueryParser Syntax,

Returns:

the package objects requested

Throws:

FaultException - A FaultException is thrown on error.

advancedWithChannel

public java.util.List<PackageOverview> advancedWithChannel(java.lang.String sessionKey,
                                                           java.lang.String luceneQuery,
                                                           java.lang.String channelLabel)
                                                    throws FaultException

Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax, additionally this method will limit results to those which are in the passed in channel label.
Lucene Query Parser syntax is defined at lucene.apache.org: http://lucene.apache.org/java/3_5_0/queryparsersyntax.html Fields searchable for Packages: name, epoch, version, release, arch, description, summary
Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"

Parameters:

sessionKey - The sessionKey for the logged in used

luceneQuery - - a search query written in the form of Lucene QueryParser Syntax

channelLabel - - channel label

Returns:

the package objects requested

Throws:

FaultException - A FaultException is thrown on error.

advancedWithActKey

public java.util.List<PackageOverview> advancedWithActKey(java.lang.String sessionKey,
                                                          java.lang.String luceneQuery,
                                                          java.lang.String actKey)
                                                   throws FaultException

Advanced method to search lucene indexes with a passed in query written in Lucene Query Parser syntax, additionally this method will limit results to those which are associated with a given activation key. Lucene Query Parser syntax is defined at lucene.apache.org: http://lucene.apache.org/java/3_5_0/queryparsersyntax.html Fields searchable for Packages: name, epoch, version, release, arch, description, summary Lucene Query Example: "name:kernel AND version:2.6.18 AND -description:devel"

Parameters:

sessionKey - The sessionKey for the logged in used

luceneQuery - - a search query written in the form of Lucene QueryParser Syntax

actKey - - activation key

Returns:

the package objects requested

Throws:

FaultException - A FaultException is thrown on error.

performSearch

protected java.util.List<PackageOverview> performSearch(java.lang.String sessionKey,
                                                        java.lang.String query,
                                                        java.lang.String mode)
                                                 throws FaultException

Throws:

FaultException