com.redhat.rhn.manager.channel

Class ChannelManager

java.lang.Object

com.redhat.rhn.manager.BaseManager

com.redhat.rhn.manager.channel.ChannelManager

public class ChannelManager
extends BaseManager

ChannelManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	QRY_ROLE_MANAGE
static java.lang.String	QRY_ROLE_SUBSCRIBE
static java.lang.String	RHEL_PRODUCT_NAME
static java.util.Set<java.lang.String>	RHEL4_EUS_VERSIONS
static java.lang.String	RHEL7_EUS_VERSION
static java.lang.String	RHN_VIRT_HOST_PACKAGE_NAME Package name of rhn-virtualization-host
static java.lang.String	TOOLS_CHANNEL_PACKAGE_NAME Key used to identify the rhn-tools channel.
static java.lang.String	VIRT_CHANNEL_PACKAGE_NAME Key used to identify the rhel-arch-server-vt-5 channel.
static java.lang.String	VT_OS_PRODUCT OS name for the virt child channel.

Method Summary

Modifier and Type	Method and Description
static void	addManageRole(User user, Channel channel) Adds the mange role for the passed in user for the passed in channel.
static void	addPackages(Channel chan, java.util.List<java.lang.Long> packageIds, User user) Adds packages to a channel
static void	addSubscribeRole(User user, Channel channel) Adds the subscribe role for the passed in user for the passed in channel.
static java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	allChannelsTree(User user) Returns the list of all channels the user can see.
static DataResult<ChannelTreeNode>	allChannelTree(User user, ListControl lc) Returns a list of ChannelTreeNodes containing all channels the user can see
static DataResult<SystemsPerChannelDto>	baseChannelsInSet(User user) Returns the list of all base-channels represented in the System Set.
static DataResult<ChannelTreeNode>	channelFamilyTree(User user, java.lang.Long familyId, ListControl lc) Returns a list of channels and their parents who are in a particular channel family/entitlement
static DataResult	channelsForContentSource(java.lang.Long csid, PageControl pc)
static java.util.List<java.lang.String>	channelsForUser(User user) channelsForUser returns a list containing the names of the channels that this user has permissions to.
static DataResult<ChannelOverview>	channelsOwnedByOrg(java.lang.Long orgId, PageControl pc) Returns a dataresult containing the channels in an org.
static DataResult<ChildChannelDto>	childrenAvailableToSet(User user) Returns the list of all child-channels in the user's System Set
static int	cloneChannelPackages(java.lang.Long fromCid, java.lang.Long toCid) Clone all channel packages from one channel to another
static int	cloneOriginalChannelPackages(java.lang.Long fromCid, java.lang.Long toCid) Clone the original channel packages from one channel to another
static java.util.List<java.util.Map<java.lang.String,java.lang.String>>	compatibleChildChannelArches(java.lang.String parentArchLabel)
static void	deleteChannel(User user, java.lang.String label) Deletes a software channel
static java.util.Map<java.lang.Long,ChannelActionDAO>	filterChildSubscriptions(java.lang.String setLabel, java.util.List<Channel> subChans, java.util.List<Channel> unsubChans, User user) Takes a list of child channels and a set label and returns a Map with system ids as the key and a set ChannelActionDAO's as the value
static java.util.List<Channel>	findAllBaseChannelsForOrg(User u) List base channels (including Red Hat channels) for a given org.
static java.util.List<java.lang.Long>	findChildChannelsWithPackage(Org org, java.lang.Long parent, java.lang.String packageName, boolean expectOne) Finds the id of a child channel with the given parent channel id that contains a package with the given name.
static java.util.List<java.lang.Long>	findChildChannelsWithPackage(java.lang.String packageName, Org org) Finds the ids of all child channels that contain a package with the given name.
static java.lang.Long	findChildChannelWithPackage(Org org, java.lang.Long parent, java.lang.String packageName) Finds the id of a child channel with the given parent channel id that contains a package with the given name.
static java.util.Map<Channel,Channel>	findCompatibleChildren(Channel oldBaseChannel, Channel newBaseChannel, User user) Given an old and a new base channel, return a map of old child channels to new child channels with the same product name.
static DataResult<ErrataOverview>	findCustomErrataForTarget(Channel targetChannel, boolean packageAssoc) find available errata from custom base channels and their child channels for a particular channel
static DataResult<ErrataOverview>	findErrataForTarget(Channel targetChannel, boolean packageAssoc) Finds non-custom errata for a target channel
static DataResult<ErrataOverview>	findErrataFromRhnSetForTarget(Channel targetChannel, boolean packageAssoc, User user) Finds errata associated with channels in the "channels_for_errata" rhnSet that apply to a custom channel
static java.util.List<ChannelArch>	getChannelArchitectures() Returns list of ChannelArches
static java.util.List<Channel>	getChannelsAccessibleByOrg(java.lang.Long orgid) Get the list of Channels accessible by an org
static DataResult<ChannelTreeNode>	getChannelsForSsm(User user, ListControl lc) Returns all channels that are applicable to the systems currently selected in the SSM.
static java.util.List<ClonedChannel>	getChannelsWithClonableErrata(Org org) Get the list of Channels with clonable Errata
static java.util.Set<ChannelVersion>	getChannelVersions(Channel channel) Examines each DistChannelMap associated with the given channel to build the master set of all supported channel version constants.
static java.lang.Long	getLatestPackageEqual(java.lang.Long channelId, java.lang.String packageName) Get the id of latest packages equal in the passed in Channel and name
static java.lang.Long	getLatestPackageEqualInTree(java.lang.Long channelId, java.lang.String packageName) Get the id of latest packages located in the channel tree where channelId is a parent
static java.util.List<java.lang.String>	getLatestSyncLogFiles(Channel c) get the latest log file for spacewalk-repo-sync
static Channel	getOriginalChannel(Channel channel) For a given Channel, determine the original Channel.
static Channel	getProxyChannelByVersion(java.lang.String version, Server server) Returns list of proxy channel names for a given version
static java.lang.String	getRepoLastBuild(Channel channel) get the last build date on repodata per channel
static java.util.List<java.lang.String>	getSyncdChannelArches() Returns a distinct list of ChannelArch labels for all synch'd and custom channels in the satellite.
static Channel	getToolsChannel(Channel baseChannel, User user) Search for the tools channel beneath the specified base channel.
static java.lang.Long	guessServerBase(User usr, java.lang.Long sid) For the specified server, make a best-guess effort at what its base-channel SHOULD be
static Channel	guessServerBase(User usr, Server s) For the specified server, make a best-guess effort at what its base-channel SHOULD be
static boolean	isChannelLabelInProgress(java.lang.String channel) Check the status of the cache repo data
static boolean	isGloballySubscribable(User user, java.lang.String chanLabel) Returns true if the given channel is globally subscribable for the given org.
static java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	latestPackagesInChannel(Channel channel) Returns list of latest packages in channel
static DataResult<PackageListItem>	latestPackagesInChannel(java.lang.Long channelId) Returns the latest packages in the channel.
static java.lang.Long	likelyParentId(Channel original, Org org) Return the channel id of the "most likely" parent if we're cloning this channel.
static java.util.List<PackageDto>	listAllPackages(Channel channel) Returns list of packages in channel
static java.util.List<PackageDto>	listAllPackages(Channel channel, java.util.Date startDate, java.util.Date endDate) Returns list of packages in channel
static java.util.List<PackageDto>	listAllPackages(Channel channel, java.lang.String startDate, java.lang.String endDate) Returns list of packages in channel
static java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listAllPackagesByDate(Channel channel, java.lang.String startDate, java.lang.String endDate) Deprecated. The only thing to use this is ChannelSoftwareHandler.listAllPackagesByDate which is itself depricated
static java.util.List<EssentialChannelDto>	listBaseChannelsForSystem(User usr, Server s) Given a system, find all the base channels available to the specified user that the system may be re-subscribed to.
static java.util.List<EssentialChannelDto>	listBaseEusChannelsByVersionReleaseAndChannelArch(User user, ReleaseChannelMap rcm) Lookup the EUS base channels suitable for the given version, release, and channel arch.
static java.util.List<EssentialChannelDto>	listBaseEusChannelsByVersionReleaseAndServerArch(User user, java.lang.String version, PackageEvr pevr, java.lang.String serverArch) Lookup the EUS base channels suitable for the given version, release, and server arch.
static java.util.List<java.lang.Long>	listChannelManagerIdsForChannel(Org org, Channel channel) returns channel manager ids within the given org for a given channel
static java.util.List<java.lang.Long>	listChannelSubscriberIdsForChannel(Org org, Channel channel) returns channel subscriber ids within the given org for a given channel
static java.util.List<EssentialChannelDto>	listCompatibleBaseChannelsForChannel(User u, Channel inChan) Given a base-channel, find all the base channels available to the specified user that a system with the specified channel may be re-subscribed to.
static java.util.List<java.lang.String>	listCompatiblePackageArches(java.lang.String[] channelArchLabels) Returns a list of compatible packages arches for the given ChannelArch labels.
static DataResult<EssentialChannelDto>	listCustomBaseChannelsForServer(Server server) List base channels offered for the given server
static DataResult<ErrataOverview>	listErrata(Channel channel, java.util.Date start, java.util.Date end, boolean lastModified, User user) List the errata applicable to a channel between start and end date
static DataResult<java.util.Map<java.lang.String,java.lang.Object>>	listErrataByType(Channel channel, java.lang.String type) List the errata of a particular type that are applicable to a channel.
static DataResult<java.util.Map<java.lang.String,java.lang.Object>>	listErrataForDates(Channel channel, java.lang.String start, java.lang.String end) Deprecated. Use appropriate listErrata
static java.util.List<ErrataOverview>	listErrataNeedingResync(Channel c, User user) List errata that is within a channel that needs to be resynced This is determined by the packages in the channel
static java.util.List<PackageDto>	listErrataPackages(Channel chan, Errata errata) List packages that are contained in an errata and in a channel
static java.util.List<PackageOverview>	listErrataPackagesForResync(Channel c, User user) List errata packages that need to be resynced
static java.util.List<PackageOverview>	listErrataPackagesForResync(Channel c, User user, java.lang.String setLabel) List errata packages that need to be resynced
static DataResult<ErrataOverview>	listErrataSimple(java.lang.Long channelId) List the errata applicable to a channel (used for repomd generation)
static java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listLatestPackagesEqual(java.lang.Long channelId, java.lang.String packageName) List the latest packages equal in the passed in Channel and name
static java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	listLatestPackagesLike(java.lang.Long channelId, java.lang.String packageName) List the latest packages in a channel *like* the given package name.
static Channel	lookupByIdAndUser(java.lang.Long cid, User userIn) Returns a Channel object with the given id and user
static Channel	lookupByLabel(Org org, java.lang.String label) Returns the Channel whose label matches the given label.
static Channel	lookupByLabelAndUser(java.lang.String label, User userIn) Returns a Channel object with the given label and user
static ReleaseChannelMap	lookupDefaultReleaseChannelMapForChannel(Channel channel) Lookup the default release channel map for the given channel.
static DistChannelMap	lookupDistChannelMapByPnReleaseArch(Org org, java.lang.String productName, java.lang.String release, ChannelArch channelArch) Lookup the dist channel map for the given os, release, and channel arch.
static EssentialChannelDto	lookupLatestEusChannelForRhelVersion(User user, java.lang.String rhelVersion, java.lang.Long channelArchId) Lookup the latest EUS base channel for the given version and server arch.
static java.lang.Long	lookupOriginalId(Channel channel) Returns an id of the original channel
static DataResult<ChannelTreeNode>	myChannelTree(User user, ListControl lc) Returns a list of ChannelTreeNodes that have orgId null or has a parent with org_id null
static java.lang.String	normalizeRhelReleaseForMapping(java.lang.String rhelVersion, java.lang.String originalRelease) Convert redhat-release release values to those that are stored in the rhnReleaseChannelMap table.
static DataResult<ChannelTreeNode>	ownedChannelsTree(User user) Returns a list of channels owned by the user.
static DataResult<ChannelTreeNode>	popularChannelTree(User user, java.lang.Long serverCount, ListControl lc) Returns a list of ChannelTreeNodes that have orgId null or has a prarent with org_id null
static void	queueChannelChange(java.lang.String channelLabel, java.lang.String client, java.lang.String reason)
static void	refreshWithNewestPackages(Channel channel, java.lang.String label) Refreshes the channel with the "newest" packages.
static void	refreshWithNewestPackages(java.lang.Long channelId, java.lang.String label) Refreshes the channel with the "newest" packages.
static DataResult<java.lang.Long>	relevantPackages(java.lang.Long channelId, Errata e) Returns the package ids for packages relevant to a channel for a published errata
static void	removeErrata(Channel chan, java.util.Set<java.lang.Long> errataIds, User user) Remove a set of erratas from a channel and remove associated packages
static void	removeManageRole(User user, Channel channel) Removes the manage role from the passed in user for the passed in channel.
static void	removePackages(Channel chan, java.util.List<java.lang.Long> packageIds, User user) Remove packages from a channel very quickly
static void	removeSubscribeRole(User user, Channel channel) Removes the subscribe role from the passed in user for the passed in channel.
static DataResult<ChannelTreeNode>	retiredChannelTree(User user, ListControl lc) Returns a list of ChannelTreeNodes containing end-of-life retired channels the user can see
static DataResult<ChannelTreeNode>	sharedChannelTree(User user, ListControl lc) Returns a list of ChannelTreeNodes containing shared channels the user can see
static java.util.Set<java.lang.Long>	subscribableChannelIdsForUser(User user) returns a list of channel ids that the user can subscribe to
static Channel	subscribeToChildChannelByOSProduct(User user, Server current, java.lang.String osProductName) Subscribe a Server to the first child channel of its base channel supplies OS level functionality based on the "osProductName" passed in.
static Channel	subscribeToChildChannelWithPackageName(User user, Server current, java.lang.String packageName) Subscribe a Server to the first child channel of its base channel that contains the packagename passed in.
static DataResult<ChannelTreeNode>	trustChannelConsume(Org org, Org trustOrg, User user, ListControl lc) Returns a list of ChannelTreeNodes containing all channels the trusted org is consuming from a specific org
static void	unscheduleEventualRepoSync(Channel channel, User user) Unschedule eventual repo sync schedule
static java.util.List<Channel>	userAccessibleChildChannels(java.lang.Long orgid, java.lang.Long cid) Returns the list of Channel ids which the given orgid has access to.
static DataResult<ChannelTreeNode>	vendorChannelTree(User user, ListControl lc) Returns a list of ChannelTreeNodes that have orgId null or has a parent with org_id null
static boolean	verifyChannelAdmin(User user, java.lang.Long cid) Verify that a user is a channel admin
static boolean	verifyChannelManage(User user, java.lang.Long cid) Makes sure the passed in user has manage permissions to the channel with the given id.
static boolean	verifyChannelSubscribe(User user, java.lang.Long cid) Makes sure the passed in user has subscribe permissions to the channel with the given id.

Methods inherited from class com.redhat.rhn.manager.BaseManager

makeDataResult, makeDataResult, makeDataResult, makeDataResult, makeDataResultNoPagination, makeDataResultNoPagination, processListControl, processPageControl

Methods inherited from class java.lang.Object

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

Field Detail

QRY_ROLE_MANAGE

public static final java.lang.String QRY_ROLE_MANAGE

See Also:

Constant Field Values

QRY_ROLE_SUBSCRIBE

public static final java.lang.String QRY_ROLE_SUBSCRIBE

See Also:

Constant Field Values

RHEL4_EUS_VERSIONS

public static final java.util.Set<java.lang.String> RHEL4_EUS_VERSIONS

RHEL7_EUS_VERSION

public static final java.lang.String RHEL7_EUS_VERSION

See Also:

Constant Field Values

RHEL_PRODUCT_NAME

public static final java.lang.String RHEL_PRODUCT_NAME

See Also:

Constant Field Values

TOOLS_CHANNEL_PACKAGE_NAME

public static final java.lang.String TOOLS_CHANNEL_PACKAGE_NAME

Key used to identify the rhn-tools channel. Used in searches to find the channel

VIRT_CHANNEL_PACKAGE_NAME

public static final java.lang.String VIRT_CHANNEL_PACKAGE_NAME

Key used to identify the rhel-arch-server-vt-5 channel. Used in searches to find the channel

RHN_VIRT_HOST_PACKAGE_NAME

public static final java.lang.String RHN_VIRT_HOST_PACKAGE_NAME

Package name of rhn-virtualization-host

VT_OS_PRODUCT

public static final java.lang.String VT_OS_PRODUCT

OS name for the virt child channel. rhnDistChannelMap.OS field.

Method Detail

refreshWithNewestPackages

public static void refreshWithNewestPackages(Channel channel,
                                             java.lang.String label)

Refreshes the channel with the "newest" packages. Newest isn't just the latest versions, an errata could have obsoleted a package in which case this would have removed said package from the channel.

Parameters:

channel - channel to be refreshed

label - the label

refreshWithNewestPackages

public static void refreshWithNewestPackages(java.lang.Long channelId,
                                             java.lang.String label)

Refreshes the channel with the "newest" packages. Newest isn't just the latest versions, an errata could have obsoleted a package in which case this would have removed said package from the channel.

Parameters:

channelId - identifies the channel to be refreshed

label - the label

vendorChannelTree

public static DataResult<ChannelTreeNode> vendorChannelTree(User user,
                                                            ListControl lc)

Returns a list of ChannelTreeNodes that have orgId null or has a parent with org_id null

Parameters:

user - who we are requesting channels for

lc - ListControl to use

Returns:

list of ChannelTreeNode's

popularChannelTree

public static DataResult<ChannelTreeNode> popularChannelTree(User user,
                                                             java.lang.Long serverCount,
                                                             ListControl lc)

Returns a list of ChannelTreeNodes that have orgId null or has a prarent with org_id null

Parameters:

user - who we are requesting Red Hat channels for

serverCount - the number of systems registered to that channel for it to be popular

lc - ListControl to use

Returns:

list of ChannelTreeNode's

myChannelTree

public static DataResult<ChannelTreeNode> myChannelTree(User user,
                                                        ListControl lc)

Returns a list of ChannelTreeNodes that have orgId null or has a parent with org_id null

Parameters:

user - who we are requesting Red Hat channels for

lc - ListControl to use

Returns:

list of ChannelTreeNode's

trustChannelConsume

public static DataResult<ChannelTreeNode> trustChannelConsume(Org org,
                                                              Org trustOrg,
                                                              User user,
                                                              ListControl lc)

Returns a list of ChannelTreeNodes containing all channels the trusted org is consuming from a specific org

Parameters:

org - Org that is sharing the channels

trustOrg - org that is consuming the shared channels

user - User of the sharing Org

lc - ListControl to use

Returns:

list of ChannelTreeNode's

allChannelTree

public static DataResult<ChannelTreeNode> allChannelTree(User user,
                                                         ListControl lc)

Returns a list of ChannelTreeNodes containing all channels the user can see

Parameters:

user - who we are requesting channels for

lc - ListControl to use

Returns:

list of ChannelTreeNode's

ownedChannelsTree

public static DataResult<ChannelTreeNode> ownedChannelsTree(User user)

Returns a list of channels owned by the user.

Parameters:

user - cannot be null

Returns:

list of maps containing the channel data

sharedChannelTree

public static DataResult<ChannelTreeNode> sharedChannelTree(User user,
                                                            ListControl lc)

Returns a list of ChannelTreeNodes containing shared channels the user can see

Parameters:

user - who we are requesting channels for

lc - ListControl to use

Returns:

list of ChannelTreeNode's

retiredChannelTree

public static DataResult<ChannelTreeNode> retiredChannelTree(User user,
                                                             ListControl lc)

Returns a list of ChannelTreeNodes containing end-of-life retired channels the user can see

Parameters:

user - who we are requesting channels for

lc - ListControl to use

Returns:

list of ChannelTreeNode's

channelFamilyTree

public static DataResult<ChannelTreeNode> channelFamilyTree(User user,
                                                            java.lang.Long familyId,
                                                            ListControl lc)

Returns a list of channels and their parents who are in a particular channel family/entitlement

Parameters:

user - who we are requesting channels for

familyId - Id of the family we want a tree for

lc - ListControl to use

Returns:

list of ChannelTreeNode's representing the channel family

channelsOwnedByOrg

public static DataResult<ChannelOverview> channelsOwnedByOrg(java.lang.Long orgId,
                                                             PageControl pc)

Returns a dataresult containing the channels in an org.

Parameters:

orgId - The org in question

pc - page control for the user

Returns:

Returns a data result containing ChannelOverview dtos

relevantPackages

public static DataResult<java.lang.Long> relevantPackages(java.lang.Long channelId,
                                                          Errata e)

Returns the package ids for packages relevant to a channel for a published errata

Parameters:

channelId - The id for the channel in question

e - the errata in question

Returns:

Returns the ids for relevant packages

lookupByIdAndUser

public static Channel lookupByIdAndUser(java.lang.Long cid,
                                        User userIn)

Returns a Channel object with the given id and user

Parameters:

cid - The id for the channel you want

userIn - The User looking for the channel

Returns:

Returns the channel with the given id

lookupByLabelAndUser

public static Channel lookupByLabelAndUser(java.lang.String label,
                                           User userIn)

Returns a Channel object with the given label and user

Parameters:

label - The label for the channel you want

userIn - The User looking for the channel

Returns:

Returns the channel with the given id

subscribableChannelIdsForUser

public static java.util.Set<java.lang.Long> subscribableChannelIdsForUser(User user)

returns a list of channel ids that the user can subscribe to

Parameters:

user - User to check

Returns:

List of all channel ids that are subscribable for this user

channelsForUser

public static java.util.List<java.lang.String> channelsForUser(User user)

channelsForUser returns a list containing the names of the channels that this user has permissions to. If the user doesn't have permissions to any channels, this method returns an empty list.

Parameters:

user - The user in question

Returns:

Returns the list of names of channels this user has permission to, an empty list otherwise.

userAccessibleChildChannels

public static java.util.List<Channel> userAccessibleChildChannels(java.lang.Long orgid,
                                                                  java.lang.Long cid)

Returns the list of Channel ids which the given orgid has access to.

Parameters:

orgid - Org id

cid - Base Channel id.

Returns:

the list of Channel ids which the given orgid has access to.

getChannelsWithClonableErrata

public static java.util.List<ClonedChannel> getChannelsWithClonableErrata(Org org)

Get the list of Channels with clonable Errata

Parameters:

org - org we want to search against

Returns:

List of com.redhat.rhn.domain.Channel objects

getChannelsAccessibleByOrg

public static java.util.List<Channel> getChannelsAccessibleByOrg(java.lang.Long orgid)

Get the list of Channels accessible by an org

Parameters:

orgid - The id of the org

Returns:

List of accessible channels

getProxyChannelByVersion

public static Channel getProxyChannelByVersion(java.lang.String version,
                                               Server server)

Returns list of proxy channel names for a given version

Parameters:

version - proxy version

server - Server

Returns:

list of proxy channel names for a given version

allChannelsTree

public static java.util.List<java.util.Map<java.lang.String,java.lang.Object>> allChannelsTree(User user)

Returns the list of all channels the user can see.

Parameters:

user - User whose channels are sought.

Returns:

the list of all channels the user can see as a DataResult

getChannelArchitectures

public static java.util.List<ChannelArch> getChannelArchitectures()

Returns list of ChannelArches

Returns:

list of ChannelArches

See Also:

ChannelArch

deleteChannel

public static void deleteChannel(User user,
                                 java.lang.String label)
                          throws InvalidChannelRoleException,
                                 NoSuchChannelException

Deletes a software channel

Parameters:

user - User with access to delete the channel.

label - Channel label

Throws:

InvalidChannelRoleException - thrown if User does not have access to delete channel.

NoSuchChannelException - thrown if no channel exists with the given label

unscheduleEventualRepoSync

public static void unscheduleEventualRepoSync(Channel channel,
                                              User user)

Unschedule eventual repo sync schedule

Parameters:

channel - relevant channel

user - executive

verifyChannelAdmin

public static boolean verifyChannelAdmin(User user,
                                         java.lang.Long cid)
                                  throws InvalidChannelRoleException

Verify that a user is a channel admin

Parameters:

user - the user to verify

cid - the channel id to verify

Returns:

true if the user is an admin of this channel

Throws:

InvalidChannelRoleException - if the user does not have perms

addSubscribeRole

public static void addSubscribeRole(User user,
                                    Channel channel)

Adds the subscribe role for the passed in user for the passed in channel.

Parameters:

user - The user in question.

channel - The channel in question.

removeSubscribeRole

public static void removeSubscribeRole(User user,
                                       Channel channel)

Removes the subscribe role from the passed in user for the passed in channel.

Parameters:

user - The user in question.

channel - The channel in question.

addManageRole

public static void addManageRole(User user,
                                 Channel channel)

Adds the mange role for the passed in user for the passed in channel.

Parameters:

user - The user in question.

channel - The channel in question.

removeManageRole

public static void removeManageRole(User user,
                                    Channel channel)

Removes the manage role from the passed in user for the passed in channel.

Parameters:

user - The user in question.

channel - The channel in question.

verifyChannelSubscribe

public static boolean verifyChannelSubscribe(User user,
                                             java.lang.Long cid)

Makes sure the passed in user has subscribe permissions to the channel with the given id.

Parameters:

user - The user in question

cid - The id for the channel in question

Returns:

Returns true if the user has permission, false otherwise

verifyChannelManage

public static boolean verifyChannelManage(User user,
                                          java.lang.Long cid)

Makes sure the passed in user has manage permissions to the channel with the given id.

Parameters:

user - The user in question

cid - The id for the channel in question

Returns:

Returns true if the user has permission, false otherwise

isGloballySubscribable

public static boolean isGloballySubscribable(User user,
                                             java.lang.String chanLabel)

Returns true if the given channel is globally subscribable for the given org.

Parameters:

user - User

chanLabel - label of Channel to validate

Returns:

true if the given channel is globally subscribable for the

lookupByLabel

public static Channel lookupByLabel(Org org,
                                    java.lang.String label)

Returns the Channel whose label matches the given label.

Parameters:

org - The org of the user looking up the channel

label - Channel label sought.

Returns:

the Channel whose label matches the given label.

latestPackagesInChannel

public static DataResult<PackageListItem> latestPackagesInChannel(java.lang.Long channelId)

Returns the latest packages in the channel. This call will return more details about the channel than the API specific call latestPackagesInChannel(com.redhat.rhn.domain.channel.Channel).

Parameters:

channelId - identifies the channel

Returns:

list of packages in this channel

latestPackagesInChannel

public static java.util.List<java.util.Map<java.lang.String,java.lang.Object>> latestPackagesInChannel(Channel channel)

Returns list of latest packages in channel

Parameters:

channel - channel whose packages are sought

Returns:

list of latest packages in channel

listErrata

public static DataResult<ErrataOverview> listErrata(Channel channel,
                                                    java.util.Date start,
                                                    java.util.Date end,
                                                    boolean lastModified,
                                                    User user)

List the errata applicable to a channel between start and end date

Parameters:

channel - channel whose errata are sought

start - start date

end - end date

user - the user doing the list

lastModified - use query selecting by last_modified timestamp or not

Returns:

the errata applicable to a channel

listErrataSimple

public static DataResult<ErrataOverview> listErrataSimple(java.lang.Long channelId)

List the errata applicable to a channel (used for repomd generation)

Parameters:

channelId - channel whose errata are sought

Returns:

the errata applicable to a channel

listErrataForDates

@Deprecated
public static DataResult<java.util.Map<java.lang.String,java.lang.Object>> listErrataForDates(Channel channel,
                                                                                                          java.lang.String start,
                                                                                                          java.lang.String end)

Deprecated. Use appropriate listErrata

List the errata applicable to a channel between start and end date

Parameters:

channel - channel whose errata are sought

start - start date

end - end date

Returns:

the errata applicable to a channel

listErrataByType

public static DataResult<java.util.Map<java.lang.String,java.lang.Object>> listErrataByType(Channel channel,
                                                                                            java.lang.String type)

List the errata of a particular type that are applicable to a channel.

Parameters:

channel - channel whose errata are sought

type - type of errata

Returns:

the errata applicable to a channel

listAllPackages

public static java.util.List<PackageDto> listAllPackages(Channel channel,
                                                         java.lang.String startDate,
                                                         java.lang.String endDate)

Returns list of packages in channel

Parameters:

channel - channel whose packages are sought

startDate - package start date

endDate - package end date

Returns:

list of packages in channel

listAllPackages

public static java.util.List<PackageDto> listAllPackages(Channel channel)

Returns list of packages in channel

Parameters:

channel - channel whose packages are sought

Returns:

list of packages in channel

listAllPackages

public static java.util.List<PackageDto> listAllPackages(Channel channel,
                                                         java.util.Date startDate,
                                                         java.util.Date endDate)

Returns list of packages in channel

Parameters:

channel - channel whose packages are sought

startDate - package start date

endDate - package end date

Returns:

list of packages in channel

listAllPackagesByDate

@Deprecated
public static java.util.List<java.util.Map<java.lang.String,java.lang.Object>> listAllPackagesByDate(Channel channel,
                                                                                                                 java.lang.String startDate,
                                                                                                                 java.lang.String endDate)

Deprecated. The only thing to use this is ChannelSoftwareHandler.listAllPackagesByDate which is itself depricated

Returns list of packages in channel

Parameters:

channel - channel whose packages are sought

startDate - package start date

endDate - package end date

Returns:

list of packages in channel

getLatestPackageEqual

public static java.lang.Long getLatestPackageEqual(java.lang.Long channelId,
                                                   java.lang.String packageName)

Get the id of latest packages equal in the passed in Channel and name

Parameters:

channelId - to lookup package against

packageName - to check

Returns:

List containing Maps of "CP.package_id, CP.name_id, CP.evr_id"

getLatestPackageEqualInTree

public static java.lang.Long getLatestPackageEqualInTree(java.lang.Long channelId,
                                                         java.lang.String packageName)

Get the id of latest packages located in the channel tree where channelId is a parent

Parameters:

channelId - to lookup package against

packageName - to check

Returns:

package id of the newest package with a matching name

listLatestPackagesEqual

public static java.util.List<java.util.Map<java.lang.String,java.lang.Object>> listLatestPackagesEqual(java.lang.Long channelId,
                                                                                                       java.lang.String packageName)

List the latest packages equal in the passed in Channel and name

Parameters:

channelId - to lookup package against

packageName - to check

Returns:

List containing Maps of "CP.package_id, CP.name_id, CP.evr_id"

listLatestPackagesLike

public static java.util.List<java.util.Map<java.lang.String,java.lang.Object>> listLatestPackagesLike(java.lang.Long channelId,
                                                                                                      java.lang.String packageName)

List the latest packages in a channel *like* the given package name.

Parameters:

channelId - to lookup package against

packageName - to check

Returns:

List containing Maps of "CP.package_id, CP.name_id, CP.evr_id"

findChildChannelWithPackage

public static java.lang.Long findChildChannelWithPackage(Org org,
                                                         java.lang.Long parent,
                                                         java.lang.String packageName)

Finds the id of a child channel with the given parent channel id that contains a package with the given name. Will only find one child channel even if there are many that qualify.

Parameters:

org - Organization of the current user.

parent - The id of the parent channel

packageName - The exact name of the package sought for.

Returns:

The id of a single child channel found or null if nothing found.

findChildChannelsWithPackage

public static java.util.List<java.lang.Long> findChildChannelsWithPackage(Org org,
                                                                          java.lang.Long parent,
                                                                          java.lang.String packageName,
                                                                          boolean expectOne)

Finds the id of a child channel with the given parent channel id that contains a package with the given name. Returns all child channel unless expectOne is True

Parameters:

org - Organization of the current user.

parent - The id of the parent channel

packageName - The exact name of the package sought for.

expectOne - if true, throws exception, if more child channels are returned

Returns:

List of child channel ids

findChildChannelsWithPackage

public static java.util.List<java.lang.Long> findChildChannelsWithPackage(java.lang.String packageName,
                                                                          Org org)

Finds the ids of all child channels that contain a package with the given name. Will only all the child channels.

Parameters:

packageName - The exact name of the package sought for.

org - the org this is in

Returns:

The list of ids

subscribeToChildChannelWithPackageName

public static Channel subscribeToChildChannelWithPackageName(User user,
                                                             Server current,
                                                             java.lang.String packageName)

Subscribe a Server to the first child channel of its base channel that contains the packagename passed in. Returns false if it can't be subscribed.

Parameters:

user - requesting the subscription

current - System to be subbed

packageName - to use to lookup the channel with.

Returns:

Channel we subscribed to, null if not.

subscribeToChildChannelByOSProduct

public static Channel subscribeToChildChannelByOSProduct(User user,
                                                         Server current,
                                                         java.lang.String osProductName)

Subscribe a Server to the first child channel of its base channel supplies OS level functionality based on the "osProductName" passed in. In DB terms it is looking for a child channel that has an entry in rhnDistChannel map with an OS field matching the osProductName.

Parameters:

user - requesting the subscription

current - System to be subbed

osProductName - to use to lookup the channel with.

Returns:

Channel we subscribed to, null if not.

guessServerBase

public static Channel guessServerBase(User usr,
                                      Server s)

For the specified server, make a best-guess effort at what its base-channel SHOULD be

Parameters:

usr - User asking the question

s - Server of interest

Returns:

Channel that could serve as a base-channel for the Server

guessServerBase

public static java.lang.Long guessServerBase(User usr,
                                             java.lang.Long sid)

For the specified server, make a best-guess effort at what its base-channel SHOULD be

Parameters:

usr - User asking the question

sid - Server id of interest

Returns:

Channel id

normalizeRhelReleaseForMapping

public static java.lang.String normalizeRhelReleaseForMapping(java.lang.String rhelVersion,
                                                              java.lang.String originalRelease)

Convert redhat-release release values to those that are stored in the rhnReleaseChannelMap table. RHEL 4 release samples: 7.6, 8, 9 RHEL 5 release samples: 5.1.0.1, 5.2.0.2, 5.3.0.3 RHEL 6 release samples: 6.7.0.3.el6 RHEL 7 release samples: 7.2-9.el7 7.3-1.el7 7.4-1.el7 RHEL 4 must be treated specially, if the release is X.Y, we only wish to look at the X portion. For RHEL 5 and presumably all future releases, we only look at the W.X.Y portion of W.X.Y.Z. (works only for RHEL5 and 6) For RHEL7, format is W.X-Y.noise, all we need is W.X

Parameters:

rhelVersion - RHEL version we're comparing release for. (5Server, 4AS, 4ES)

originalRelease - Original package release.

Returns:

Release version for rhnReleaseChannelMap.

getToolsChannel

public static Channel getToolsChannel(Channel baseChannel,
                                      User user)

Search for the tools channel beneath the specified base channel. Queries for package names that look like kickstart packages, and assumes that if any are found in this channel is must be the tools channel.

Parameters:

baseChannel - Base channel to search for a tools channel beneath.

user - User performing the search.

Returns:

Tools channel if found, null otherwise.

getChannelVersions

public static java.util.Set<ChannelVersion> getChannelVersions(Channel channel)

Examines each DistChannelMap associated with the given channel to build the master set of all supported channel version constants.

Parameters:

channel - Channel to return the versions for.

Returns:

Set of all supported channel versions.

getChannelsForSsm

public static DataResult<ChannelTreeNode> getChannelsForSsm(User user,
                                                            ListControl lc)

Returns all channels that are applicable to the systems currently selected in the SSM.

Parameters:

user - logged in user

lc - controller for the UI list

Returns:

description of all channels applicable to the systems

childrenAvailableToSet

public static DataResult<ChildChannelDto> childrenAvailableToSet(User user)

Returns the list of all child-channels in the user's System Set

Parameters:

user - User whose channels are sought.

Returns:

the list of all child-channels in that user's System Set

baseChannelsInSet

public static DataResult<SystemsPerChannelDto> baseChannelsInSet(User user)

Returns the list of all base-channels represented in the System Set.

Parameters:

user - User whose System Set is being considered

Returns:

the list of all base-channels in that set.

listBaseChannelsForSystem

public static java.util.List<EssentialChannelDto> listBaseChannelsForSystem(User usr,
                                                                            Server s)

Given a system, find all the base channels available to the specified user that the system may be re-subscribed to. If the system is currently subscribed to the default RHEL channel for their version (i.e. main RHEL 4), then only the *newest* available EUS channel will be included. If the system is already subscribed to a non-default channel (i.e. EUS or custom), we look up the redhat-release package information on the system and use it's version/release information to search for all *newer* EUS channels. Custom base channels for this organization will always be returned, regardless of the RHEL version.

Parameters:

usr - requesting list

s - Server to check against

Returns:

List of Channel objects that match

listCompatibleBaseChannelsForChannel

public static java.util.List<EssentialChannelDto> listCompatibleBaseChannelsForChannel(User u,
                                                                                       Channel inChan)

Given a base-channel, find all the base channels available to the specified user that a system with the specified channel may be re-subscribed to.

Parameters:

u - User of interest

inChan - Base-channel of interest

Returns:

List of channels that a system subscribed to "c" could be re-subscribed to

lookupDefaultReleaseChannelMapForChannel

public static ReleaseChannelMap lookupDefaultReleaseChannelMapForChannel(Channel channel)

Lookup the default release channel map for the given channel. Returns null if no default is found.

Parameters:

channel - Channel to lookup mapping for

Returns:

Default ReleaseChannelMap

lookupDistChannelMapByPnReleaseArch

public static DistChannelMap lookupDistChannelMapByPnReleaseArch(Org org,
                                                                 java.lang.String productName,
                                                                 java.lang.String release,
                                                                 ChannelArch channelArch)

Lookup the dist channel map for the given os, release, and channel arch. Returns null if none is found.

Parameters:

org - organization

productName - Product name.

release - Version.

channelArch - Channel arch.

Returns:

DistChannelMap, null if none is found

listBaseEusChannelsByVersionReleaseAndServerArch

public static java.util.List<EssentialChannelDto> listBaseEusChannelsByVersionReleaseAndServerArch(User user,
                                                                                                   java.lang.String version,
                                                                                                   PackageEvr pevr,
                                                                                                   java.lang.String serverArch)

Lookup the EUS base channels suitable for the given version, release, and server arch. NOTE: Release not actually used in the database query, must filter manually in application code due to some very specific requirements on how it must be compared. See normalizeRhelReleaseForMapping for more info.

Parameters:

user - User performing the query.

version - RHEL version.

pevr - Package EVR of the package whose release we're checking.

serverArch - RHEL server arch.

Returns:

List of EssentialChannelDto's.

listBaseEusChannelsByVersionReleaseAndChannelArch

public static java.util.List<EssentialChannelDto> listBaseEusChannelsByVersionReleaseAndChannelArch(User user,
                                                                                                    ReleaseChannelMap rcm)

Lookup the EUS base channels suitable for the given version, release, and channel arch. NOTE: Release not actually used in the database query, must filter manually in application code due to some very specific requirements on how it must be compared. See normalizeRhelReleaseForMapping for more info.

Parameters:

user - User performing the query.

rcm - ReleaseChannelMap entry for this Channel

Returns:

List of EssentialChannelDto's.

lookupLatestEusChannelForRhelVersion

public static EssentialChannelDto lookupLatestEusChannelForRhelVersion(User user,
                                                                       java.lang.String rhelVersion,
                                                                       java.lang.Long channelArchId)

Lookup the latest EUS base channel for the given version and server arch. Sorts based on the release column. null will be returned if none found.

Parameters:

user - User performing the query.

rhelVersion - RHEL version.

channelArchId - Channel arch id.

Returns:

EssentialChannelDto, or null if no entry is found.

listCustomBaseChannelsForServer

public static DataResult<EssentialChannelDto> listCustomBaseChannelsForServer(Server server)

List base channels offered for the given server

Parameters:

server - server

Returns:

List of channels.

findAllBaseChannelsForOrg

public static java.util.List<Channel> findAllBaseChannelsForOrg(User u)

List base channels (including Red Hat channels) for a given org.

Parameters:

u - User to list base channels for.

Returns:

List of Channels

findCompatibleChildren

public static java.util.Map<Channel,Channel> findCompatibleChildren(Channel oldBaseChannel,
                                                                    Channel newBaseChannel,
                                                                    User user)

Given an old and a new base channel, return a map of old child channels to new child channels with the same product name. If no match can be found the old child channel is omitted from the map.

Parameters:

oldBaseChannel - the base channel to which we need to find the equivalent child channels

newBaseChannel - the base channel which holds the a child channel with same product name

user - user needed for authentication purposes

Returns:

a map [childChannel1:childChannel2]

getOriginalChannel

public static Channel getOriginalChannel(Channel channel)

For a given Channel, determine the original Channel.

Parameters:

channel - channel

Returns:

original channel

findErrataForTarget

public static DataResult<ErrataOverview> findErrataForTarget(Channel targetChannel,
                                                             boolean packageAssoc)

Finds non-custom errata for a target channel

Parameters:

targetChannel - the channel to search for

packageAssoc - whether to filter packages on what packages are already in the channel

Returns:

List of errata

findErrataFromRhnSetForTarget

public static DataResult<ErrataOverview> findErrataFromRhnSetForTarget(Channel targetChannel,
                                                                       boolean packageAssoc,
                                                                       User user)

Finds errata associated with channels in the "channels_for_errata" rhnSet that apply to a custom channel

Parameters:

targetChannel - the channel to search for

user - the user doing the query

packageAssoc - whether to filter packages on what packages are already in the channel

Returns:

List of Errata

findCustomErrataForTarget

public static DataResult<ErrataOverview> findCustomErrataForTarget(Channel targetChannel,
                                                                   boolean packageAssoc)

find available errata from custom base channels and their child channels for a particular channel

Parameters:

targetChannel - the channel to target

packageAssoc - whether to filter packages on what packages are already in the channel

Returns:

List of errata

listCompatiblePackageArches

public static java.util.List<java.lang.String> listCompatiblePackageArches(java.lang.String[] channelArchLabels)

Returns a list of compatible packages arches for the given ChannelArch labels. It will NOT tell you which package arch goes with which channel arch, for that you need to load the ChannelArch individually. This methods purpose is for searching packages where we don't actually care what package arch goes with what channel arch we only care what package arch we should look for.

Parameters:

channelArchLabels - List of ChannelArch labels.

Returns:

list of compatible package arches.

getSyncdChannelArches

public static java.util.List<java.lang.String> getSyncdChannelArches()

Returns a distinct list of ChannelArch labels for all synch'd and custom channels in the satellite.

Returns:

a distinct list of ChannelArch labels for all synch'd and custom channels in the satellite.

queueChannelChange

public static void queueChannelChange(java.lang.String channelLabel,
                                      java.lang.String client,
                                      java.lang.String reason)

Parameters:

channelLabel - channel label

client - client info

reason - reason for queue

removePackages

public static void removePackages(Channel chan,
                                  java.util.List<java.lang.Long> packageIds,
                                  User user)

Remove packages from a channel very quickly

Parameters:

chan - the channel

packageIds - list of package ids

user - the user doing the removing

addPackages

public static void addPackages(Channel chan,
                               java.util.List<java.lang.Long> packageIds,
                               User user)

Adds packages to a channel

Parameters:

chan - the channel

packageIds - list of package ids

user - the user adding packages

removeErrata

public static void removeErrata(Channel chan,
                                java.util.Set<java.lang.Long> errataIds,
                                User user)

Remove a set of erratas from a channel and remove associated packages

Parameters:

chan - The channel to remove from

errataIds - set of errata ids to remove

user - the user doing the removing

listErrataPackages

public static java.util.List<PackageDto> listErrataPackages(Channel chan,
                                                            Errata errata)

List packages that are contained in an errata and in a channel

Parameters:

chan - The channel

errata - the Errata

Returns:

A list of PackageDto that are in the channel and errata

lookupOriginalId

public static java.lang.Long lookupOriginalId(Channel channel)

Returns an id of the original channel

Parameters:

channel - The cloned channel

Returns:

A original channel id

listErrataNeedingResync

public static java.util.List<ErrataOverview> listErrataNeedingResync(Channel c,
                                                                     User user)

List errata that is within a channel that needs to be resynced This is determined by the packages in the channel

Parameters:

c - the channel

user - the user

Returns:

list of errataOverview objects that need to be resynced

listErrataPackagesForResync

public static java.util.List<PackageOverview> listErrataPackagesForResync(Channel c,
                                                                          User user)

List errata packages that need to be resynced

Parameters:

c - the channel to look for packages in

user - the user doing it

Returns:

the list of PackageOverview objects

listErrataPackagesForResync

public static java.util.List<PackageOverview> listErrataPackagesForResync(Channel c,
                                                                          User user,
                                                                          java.lang.String setLabel)

List errata packages that need to be resynced

Parameters:

c - the channel to look for packages in

user - the user doing it

setLabel - the set of errata to base the package off of

Returns:

the list of PackageOverview objects

isChannelLabelInProgress

public static boolean isChannelLabelInProgress(java.lang.String channel)

Check the status of the cache repo data

Parameters:

channel - the channel to look for status

Returns:

repodata status

getRepoLastBuild

public static java.lang.String getRepoLastBuild(Channel channel)

get the last build date on repodata per channel

Parameters:

channel - the channel to look for repodata build date

Returns:

last repo build date

getLatestSyncLogFiles

public static java.util.List<java.lang.String> getLatestSyncLogFiles(Channel c)

get the latest log file for spacewalk-repo-sync

Parameters:

c - channel

Returns:

the string of the filename (fully qualified)

filterChildSubscriptions

public static java.util.Map<java.lang.Long,ChannelActionDAO> filterChildSubscriptions(java.lang.String setLabel,
                                                                                      java.util.List<Channel> subChans,
                                                                                      java.util.List<Channel> unsubChans,
                                                                                      User user)

Takes a list of child channels and a set label and returns a Map with system ids as the key and a set ChannelActionDAO's as the value

Parameters:

setLabel - the set label of System ids

subChans - the list of channels to subscribe

unsubChans - the list of channels to unsubscribe

user - the user doing the work

Returns:

The aformentioned map

listChannelManagerIdsForChannel

public static java.util.List<java.lang.Long> listChannelManagerIdsForChannel(Org org,
                                                                             Channel channel)

returns channel manager ids within the given org for a given channel

Parameters:

org - given organization

channel - channel

Returns:

list of channel manager ids

listChannelSubscriberIdsForChannel

public static java.util.List<java.lang.Long> listChannelSubscriberIdsForChannel(Org org,
                                                                                Channel channel)

returns channel subscriber ids within the given org for a given channel

Parameters:

org - given organization

channel - channel

Returns:

list of channel subscriber ids

channelsForContentSource

public static DataResult channelsForContentSource(java.lang.Long csid,
                                                  PageControl pc)

Parameters:

csid - content source (repository) ID

pc - pageControl

Returns:

List of channels associated to a content source (repository)

compatibleChildChannelArches

public static java.util.List<java.util.Map<java.lang.String,java.lang.String>> compatibleChildChannelArches(java.lang.String parentArchLabel)

Parameters:

parentArchLabel - The channel arch label of the parent channel

Returns:

List of {'name': channel_arch_name, 'label': channel_arch_label} for compatible child channel arches.

cloneOriginalChannelPackages

public static int cloneOriginalChannelPackages(java.lang.Long fromCid,
                                               java.lang.Long toCid)

Clone the original channel packages from one channel to another

Parameters:

fromCid - The original channel's id

toCid - The cloned channel's id

Returns:

1 if successfull

cloneChannelPackages

public static int cloneChannelPackages(java.lang.Long fromCid,
                                       java.lang.Long toCid)

Clone all channel packages from one channel to another

Parameters:

fromCid - The original channel's id

toCid - The cloned channel's id

Returns:

1 if successfull

likelyParentId

public static java.lang.Long likelyParentId(Channel original,
                                            Org org)

Return the channel id of the "most likely" parent if we're cloning this channel. "Most likely" is determined by: 1) See if the org owns a clone of the original channel's parent 1.a) if multiple choose most recently modified 2) Else return the original channel's parent id Returns null if original is not a child channel

Parameters:

original - Original channel that we are cloning

org - Org to look for clones in

Returns:

channel id of most likely parent