com.redhat.rhn.frontend.xmlrpc.packages

Class PackagesHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.packages.PackagesHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class PackagesHandler
extends BaseHandler

PackagesHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
PackagesHandler()

Method Summary

Modifier and Type	Method and Description
java.util.List<Package>	findByNvrea(User loggedInUser, java.lang.String name, java.lang.String version, java.lang.String release, java.lang.String epoch, java.lang.String archLabel) Lookup the details for packages with the given name, version, release, architecture label, and (optionally) epoch.
java.util.Map	getDetails(User loggedInUser, java.lang.Integer pid) Get Details - Retrieves the details for a given package
byte[]	getPackage(User loggedInUser, java.lang.Integer pid) download a binary package
java.lang.String	getPackageUrl(User loggedInUser, java.lang.Integer pid) get a package's download url
java.lang.String	listChangelog(User loggedInUser, java.lang.Integer pid) Gets the change log for a given package
java.lang.Object[]	listDependencies(User loggedInUser, java.lang.Integer pid) List dependencies for a given package.
java.lang.Object[]	listFiles(User loggedInUser, java.lang.Integer pid) Get a list of files associated with a package
java.lang.Object[]	listProvidingChannels(User loggedInUser, java.lang.Integer pid) List of Channels that provide a given package
java.lang.Object[]	listProvidingErrata(User loggedInUser, java.lang.Integer pid) List of Errata that provide the given package.
java.lang.Object[]	listSourcePackages(User loggedInUser) List all source packages
int	removePackage(User loggedInUser, java.lang.Integer pid) Removes a package from the system based on package id
int	removeSourcePackage(User loggedInUser, java.lang.Integer psid) Removes a source package based on source package id

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

PackagesHandler

public PackagesHandler()

Method Detail

getDetails

public java.util.Map getDetails(User loggedInUser,
                                java.lang.Integer pid)
                         throws FaultException

Get Details - Retrieves the details for a given package

Parameters:

loggedInUser - The current user

pid - The id of the package you're looking for

Returns:

Returns a Map containing the details of the package

Throws:

FaultException - A FaultException is thrown if the errata corresponding to pid cannot be found.

listProvidingChannels

public java.lang.Object[] listProvidingChannels(User loggedInUser,
                                                java.lang.Integer pid)
                                         throws FaultException

List of Channels that provide a given package

Parameters:

loggedInUser - The current user

pid - The id of the package in question

Returns:

Returns an array of maps representing a channel

Throws:

FaultException - A FaultException is thrown if the errata corresponding to pid cannot be found.

listProvidingErrata

public java.lang.Object[] listProvidingErrata(User loggedInUser,
                                              java.lang.Integer pid)
                                       throws FaultException

List of Errata that provide the given package.

Parameters:

loggedInUser - The current user

pid - The id of the package in question

Returns:

Returns an array of maps representing an erratum

Throws:

FaultException - A FaultException is thrown if the errata corresponding to pid cannot be found.

listFiles

public java.lang.Object[] listFiles(User loggedInUser,
                                    java.lang.Integer pid)
                             throws FaultException

Get a list of files associated with a package

Parameters:

loggedInUser - The current user

pid - The id of the package you're looking for

Returns:

Returns an Array of maps representing a file

Throws:

FaultException - A FaultException is thrown if the errata corresponding to pid cannot be found.

listChangelog

public java.lang.String listChangelog(User loggedInUser,
                                      java.lang.Integer pid)
                               throws FaultException

Gets the change log for a given package

Parameters:

loggedInUser - The current user

pid - The id of the package you're looking for

Returns:

Returns a string with the changelog

Throws:

FaultException - A FaultException is thrown if the errata corresponding to pid cannot be found.

listDependencies

public java.lang.Object[] listDependencies(User loggedInUser,
                                           java.lang.Integer pid)
                                    throws FaultException

List dependencies for a given package.

Parameters:

loggedInUser - The current user

pid - The package id for the package in question

Returns:

Returns an array of maps representing a dependency

Throws:

FaultException - A FaultException is thrown if the errata corresponding to pid cannot be found.

removePackage

public int removePackage(User loggedInUser,
                         java.lang.Integer pid)
                  throws FaultException

Removes a package from the system based on package id

Parameters:

loggedInUser - The current user

pid - package id

Returns:

1 on success.

Throws:

FaultException - something bad happens

removeSourcePackage

public int removeSourcePackage(User loggedInUser,
                               java.lang.Integer psid)
                        throws FaultException

Removes a source package based on source package id

Parameters:

loggedInUser - The current user

psid - package source id

Returns:

1 on success.

Throws:

FaultException - something bad happens

listSourcePackages

public java.lang.Object[] listSourcePackages(User loggedInUser)
                                      throws FaultException

List all source packages

Parameters:

loggedInUser - The current user

Returns:

Returns an array of source packages

Throws:

FaultException - A FaultException is thrown when user does not have permissions.

findByNvrea

public java.util.List<Package> findByNvrea(User loggedInUser,
                                           java.lang.String name,
                                           java.lang.String version,
                                           java.lang.String release,
                                           java.lang.String epoch,
                                           java.lang.String archLabel)

Lookup the details for packages with the given name, version, release, architecture label, and (optionally) epoch.

Parameters:

loggedInUser - The current user

name - - name of the package to search for

version - - version of the package to search for

release - release of the package to search for

epoch - if set to something other than an empty string (""), strict matching will be used and the epoch string must be correct. If set to an empty string, if the epoch is null or there is only one NEVRA combination, it will be returned. (Empty string is recommended.)

archLabel - the arch to search for

Returns:

the Package object requested

getPackageUrl

public java.lang.String getPackageUrl(User loggedInUser,
                                      java.lang.Integer pid)

get a package's download url

Parameters:

loggedInUser - The current user

pid - the package id

Returns:

the url

getPackage

public byte[] getPackage(User loggedInUser,
                         java.lang.Integer pid)
                  throws java.io.IOException

download a binary package

Parameters:

loggedInUser - The current user

pid - the package id

Returns:

a byte array of the package

Throws:

java.io.IOException - if there is an exception