com.redhat.rhn.frontend.xmlrpc.errata

Class ErrataHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.errata.ErrataHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ErrataHandler
extends BaseHandler

ErrataHandler - provides methods to access errata information.

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ErrataHandler()

Method Summary

Modifier and Type	Method and Description
int	addPackages(User loggedInUser, java.lang.String advisoryName, java.util.List<java.lang.Integer> packageIds) Add a set of packages to an erratum
java.lang.Object[]	applicableToChannels(User loggedInUser, java.lang.String advisoryName) Returns a list of channels (represented by a map) that the given erratum is applicable to.
java.util.Map<java.lang.Long,java.lang.String>	bugzillaFixes(User loggedInUser, java.lang.String advisoryName) Get the Bugzilla fixes for a given errata
java.lang.Object[]	clone(User loggedInUser, java.lang.String channelLabel, java.util.List advisoryNames) Clones a list of errata into a specified channel
java.lang.Object[]	cloneAsOriginal(User loggedInUser, java.lang.String channelLabel, java.util.List<java.lang.String> advisoryNames) Clones a list of errata into a specified cloned channel according the original erratas
int	cloneAsOriginalAsync(User loggedInUser, java.lang.String channelLabel, java.util.List<java.lang.String> advisoryNames) Asynchronously clones a list of errata into a specified cloned channel according the original erratas
int	cloneAsync(User loggedInUser, java.lang.String channelLabel, java.util.List advisoryNames) Asynchronously clones a list of errata into a specified channel
Errata	create(User loggedInUser, java.util.Map<java.lang.String,java.lang.Object> errataInfo, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> bugs, java.util.List<java.lang.String> keywords, java.util.List<java.lang.Integer> packageIds, boolean publish, java.util.List<java.lang.String> channelLabels) creates an errata
java.lang.Integer	delete(User loggedInUser, java.lang.String advisoryName) Delete an erratum.
java.util.List<Errata>	findByCve(User loggedInUser, java.lang.String cveName) Lookup the details for errata associated with the given CVE.
java.util.Map<java.lang.String,java.lang.Object>	getDetails(User loggedInUser, java.lang.String advisoryName) GetDetails - Retrieves the details for a given errata.
java.lang.Object[]	listAffectedSystems(User loggedInUser, java.lang.String advisoryName) ListAffectedSystems
java.util.List	listByDate(User loggedInUser, java.lang.String channelLabel) Deprecated. being replaced by channel.software.listErrata(User LoggedInUser, string channelLabel)
java.util.List	listCves(User loggedInUser, java.lang.String advisoryName) Returns a list of CVEs for a given erratum
java.lang.Object[]	listKeywords(User loggedInUser, java.lang.String advisoryName) Get the keywords for a given erratum
java.util.List<java.util.Map>	listPackages(User loggedInUser, java.lang.String advisoryName) List the packages for a given erratum
java.lang.Object[]	listUnpublishedErrata(User loggedInUser) Returns a list of unpublished errata for the logged-in user's Org.
Errata	publish(User loggedInUser, java.lang.String advisory, java.util.List<java.lang.String> channelLabels) Publishes an existing (unpublished) errata to a set of channels
Errata	publishAsOriginal(User loggedInUser, java.lang.String advisory, java.util.List<java.lang.String> channelLabels) Publishes an existing (unpublished) cloned errata to a set of cloned channels according to its original erratum
int	removePackages(User loggedInUser, java.lang.String advisoryName, java.util.List<java.lang.Integer> packageIds) Remove a set of packages from an erratum
java.lang.Integer	setDetails(User loggedInUser, java.lang.String advisoryName, java.util.Map<java.lang.String,java.lang.Object> details) Set erratum details.

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

ErrataHandler

public ErrataHandler()

Method Detail

getDetails

public java.util.Map<java.lang.String,java.lang.Object> getDetails(User loggedInUser,
                                                                   java.lang.String advisoryName)
                                                            throws FaultException

GetDetails - Retrieves the details for a given errata.

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the errata

Returns:

Returns a map containing the details of the errata

Throws:

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

setDetails

public java.lang.Integer setDetails(User loggedInUser,
                                    java.lang.String advisoryName,
                                    java.util.Map<java.lang.String,java.lang.Object> details)

Set erratum details.

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the errata

details - Map of (optional) erratum details to be set.

Returns:

1 on success, exception thrown otherwise.

listAffectedSystems

public java.lang.Object[] listAffectedSystems(User loggedInUser,
                                              java.lang.String advisoryName)
                                       throws FaultException

ListAffectedSystems

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the errata

Returns:

Returns an object array containing the system ids and system name

Throws:

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

bugzillaFixes

public java.util.Map<java.lang.Long,java.lang.String> bugzillaFixes(User loggedInUser,
                                                                    java.lang.String advisoryName)
                                                             throws FaultException

Get the Bugzilla fixes for a given errata

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the errata

Returns:

Returns a map containing the Bugzilla id and summary for each bug

Throws:

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

listKeywords

public java.lang.Object[] listKeywords(User loggedInUser,
                                       java.lang.String advisoryName)
                                throws FaultException

Get the keywords for a given erratum

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the erratum

Returns:

Returns an array of keywords for the erratum

Throws:

FaultException - A FaultException is thrown if the errata corresponding to the given advisoryName cannot be fo

applicableToChannels

public java.lang.Object[] applicableToChannels(User loggedInUser,
                                               java.lang.String advisoryName)
                                        throws FaultException

Returns a list of channels (represented by a map) that the given erratum is applicable to.

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the erratum

Returns:

Returns an array of channels for the erratum

Throws:

FaultException - A FaultException is thrown if the errata corresponding to the given advisoryName cannot be found

listUnpublishedErrata

public java.lang.Object[] listUnpublishedErrata(User loggedInUser)

Returns a list of unpublished errata for the logged-in user's Org.

Parameters:

loggedInUser - The current user

Returns:

Returns an array of errata

listCves

public java.util.List listCves(User loggedInUser,
                               java.lang.String advisoryName)
                        throws FaultException

Returns a list of CVEs for a given erratum

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the erratum

Returns:

Returns a list of CVEs

Throws:

FaultException - A FaultException is thrown if the errata corresponding to the given advisoryName cannot be found throws FaultException {

listPackages

public java.util.List<java.util.Map> listPackages(User loggedInUser,
                                                  java.lang.String advisoryName)
                                           throws FaultException

List the packages for a given erratum

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the erratum

Returns:

Returns an Array of maps representing a package

Throws:

FaultException - A FaultException is thrown if the errata corresponding to the given advisoryName cannot be found

addPackages

public int addPackages(User loggedInUser,
                       java.lang.String advisoryName,
                       java.util.List<java.lang.Integer> packageIds)
                throws FaultException

Add a set of packages to an erratum

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the erratum

packageIds - The ids for packages to remove

Returns:

Returns int - representing the number of packages added, exception otherwise

Throws:

FaultException - A FaultException is thrown if the errata corresponding to the given advisoryName cannot be found

removePackages

public int removePackages(User loggedInUser,
                          java.lang.String advisoryName,
                          java.util.List<java.lang.Integer> packageIds)
                   throws FaultException

Remove a set of packages from an erratum

Parameters:

loggedInUser - The current user

advisoryName - The advisory name of the erratum

packageIds - The ids for packages to remove

Returns:

Returns int - representing the number of packages removed, exception otherwise

Throws:

FaultException - A FaultException is thrown if the errata corresponding to the given advisoryName cannot be found

clone

public java.lang.Object[] clone(User loggedInUser,
                                java.lang.String channelLabel,
                                java.util.List advisoryNames)
                         throws InvalidChannelRoleException

Clones a list of errata into a specified channel

Parameters:

loggedInUser - The current user

channelLabel - the channel's label that we are cloning into

advisoryNames - an array of String objects containing the advisory name of every errata you want to clone

Returns:

Returns an array of Errata objects, which get serialized into XMLRPC

Throws:

InvalidChannelRoleException - if the user perms are incorrect

cloneAsync

public int cloneAsync(User loggedInUser,
                      java.lang.String channelLabel,
                      java.util.List advisoryNames)
               throws InvalidChannelRoleException

Asynchronously clones a list of errata into a specified channel

Parameters:

loggedInUser - The current user

channelLabel - the channel's label that we are cloning into

advisoryNames - an array of String objects containing the advisory name of every errata you want to clone

Returns:

1 on success, exception thrown otherwise.

Throws:

InvalidChannelRoleException - if the user perms are incorrect

cloneAsOriginal

public java.lang.Object[] cloneAsOriginal(User loggedInUser,
                                          java.lang.String channelLabel,
                                          java.util.List<java.lang.String> advisoryNames)
                                   throws InvalidChannelRoleException

Clones a list of errata into a specified cloned channel according the original erratas

Parameters:

loggedInUser - The current user

channelLabel - the cloned channel's label that we are cloning into

advisoryNames - an array of String objects containing the advisory name of every errata you want to clone

Returns:

Returns an array of Errata objects, which get serialized into XMLRPC

Throws:

InvalidChannelRoleException - if the user perms are incorrect

cloneAsOriginalAsync

public int cloneAsOriginalAsync(User loggedInUser,
                                java.lang.String channelLabel,
                                java.util.List<java.lang.String> advisoryNames)
                         throws InvalidChannelRoleException

Asynchronously clones a list of errata into a specified cloned channel according the original erratas

Parameters:

loggedInUser - The current user

channelLabel - the cloned channel's label that we are cloning into

advisoryNames - an array of String objects containing the advisory name of every errata you want to clone

Returns:

1 on success, exception thrown otherwise.

Throws:

InvalidChannelRoleException - if the user perms are incorrect

create

public Errata create(User loggedInUser,
                     java.util.Map<java.lang.String,java.lang.Object> errataInfo,
                     java.util.List<java.util.Map<java.lang.String,java.lang.Object>> bugs,
                     java.util.List<java.lang.String> keywords,
                     java.util.List<java.lang.Integer> packageIds,
                     boolean publish,
                     java.util.List<java.lang.String> channelLabels)
              throws InvalidChannelRoleException

creates an errata

Parameters:

loggedInUser - The current user

errataInfo - map containing the following values: String "synopsis" short synopsis of the errata String "advisory_name" advisory name of the errata Integer "advisory_release" release number of the errata String "advisory_type" the type of advisory for the errata (Must be one of the following: "Security Advisory", "Product Enhancement Advisory", or "Bug Fix Advisory" String "product" the product the errata affects String "errataFrom" the author of the errata String "topic" the topic of the errata String "description" the description of the errata String "solution" the solution of the errata String "references" references of the errata to be created String "notes" notes on the errata String "severity" is name of given security advisory severity (Must be one of the following: 'Low', 'Moderate', 'Important', 'Critical' or 'Unspecified')

bugs - a List of maps consisting of 'id' Integers and 'summary' strings

keywords - a List of keywords for the errata

packageIds - a List of package Id packageId Integers

publish - should the errata be published

channelLabels - an array of channel labels to publish to if the errata is to be published

Returns:

The errata created (whether published or unpublished)

Throws:

InvalidChannelRoleException - if the user perms are incorrect

delete

public java.lang.Integer delete(User loggedInUser,
                                java.lang.String advisoryName)
                         throws FaultException

Delete an erratum.

Parameters:

loggedInUser - The current user

advisoryName - The advisory Name of the erratum to delete

Returns:

1 on success, exception thrown otherwise.

Throws:

FaultException - if unknown or invalid erratum is provided.

publish

public Errata publish(User loggedInUser,
                      java.lang.String advisory,
                      java.util.List<java.lang.String> channelLabels)
               throws InvalidChannelRoleException

Publishes an existing (unpublished) errata to a set of channels

Parameters:

loggedInUser - The current user

advisory - The advisory Name of the errata to publish

channelLabels - List of channels to publish the errata to

Returns:

the published errata

Throws:

InvalidChannelRoleException - if the user perms are incorrect

publishAsOriginal

public Errata publishAsOriginal(User loggedInUser,
                                java.lang.String advisory,
                                java.util.List<java.lang.String> channelLabels)
                         throws InvalidChannelRoleException

Publishes an existing (unpublished) cloned errata to a set of cloned channels according to its original erratum

Parameters:

loggedInUser - The current user

advisory - The advisory Name of the errata to publish

channelLabels - List of channels to publish the errata to

Returns:

the published errata

Throws:

InvalidChannelRoleException - if the user perms are incorrect

listByDate

@Deprecated
public java.util.List listByDate(User loggedInUser,
                                             java.lang.String channelLabel)

Deprecated. being replaced by channel.software.listErrata(User LoggedInUser, string channelLabel)

list errata by date

Parameters:

loggedInUser - The current user

channelLabel - channel associated with the errata you are interested in.

Returns:

List of Errata objects

findByCve

public java.util.List<Errata> findByCve(User loggedInUser,
                                        java.lang.String cveName)

Lookup the details for errata associated with the given CVE.

Parameters:

loggedInUser - The current user

cveName - name of the CVE

Returns:

List of Errata objects