com.redhat.rhn.manager.rhnset

Class RhnSetDecl

java.lang.Object

com.redhat.rhn.manager.rhnset.RhnSetDecl

public class RhnSetDecl
extends java.lang.Object

The declaration of an RhnSet. This combines the name of the set with the security information needed to ensure that users only put items into the set they actually have permission to see. All sets must be declared as constants in this class; to load a set, you can simply say RhnSetDecl.SYSTEMS.get(user).

To create a new set, you need to first define the needed cleanup as a constant in SetCleanup and then declare the set with a new constant in this class.

Field Summary

Fields

Modifier and Type	Field and Description
static RhnSetDecl	ACTION_CHAINS
static RhnSetDecl	ACTIONS_ARCHIVED
static RhnSetDecl	ACTIONS_COMPLETED
static RhnSetDecl	ACTIONS_FAILED
static RhnSetDecl	ACTIONS_PENDING
static RhnSetDecl	ACTIONS_UNSCHEDULE
static RhnSetDecl	ACTIVATION_KEYS
static RhnSetDecl	CHANNEL_MANAGEMENT_PERMS
static RhnSetDecl	CHANNEL_SUBSCRIPTION_PERMS
static RhnSetDecl	CHANNELS_FOR_ERRATA
static RhnSetDecl	CONFIG_CHANNEL_DEPLOY_REVISIONS
static RhnSetDecl	CONFIG_CHANNEL_DEPLOY_SYSTEMS
static RhnSetDecl	CONFIG_CHANNELS
static RhnSetDecl	CONFIG_CHANNELS_RANKING
static RhnSetDecl	CONFIG_CHANNELS_TO_UNSUBSCRIBE
static RhnSetDecl	CONFIG_ENABLE_SYSTEMS
static RhnSetDecl	CONFIG_FILE_DEPLOY_SYSTEMS
static RhnSetDecl	CONFIG_FILE_NAMES
static RhnSetDecl	CONFIG_FILES
static RhnSetDecl	CONFIG_IMPORT_FILE_NAMES
static RhnSetDecl	CONFIG_REVISIONS
static RhnSetDecl	CONFIG_SYSTEMS
static RhnSetDecl	CONFIG_TARGET_SYSTEMS
static RhnSetDecl	DELETABLE_PACKAGE_LIST
static RhnSetDecl	DUPLICATE_SYSTEMS
static RhnSetDecl	ERRATA
static RhnSetDecl	ERRATA_CLONE
static RhnSetDecl	ERRATA_PACKAGES_TO_SYNC
static RhnSetDecl	ERRATA_TO_ADD
static RhnSetDecl	ERRATA_TO_DELETE
static RhnSetDecl	ERRATA_TO_DELETE_BULK
static RhnSetDecl	ERRATA_TO_REMOVE
static RhnSetDecl	ERRATA_TO_SYNC
static RhnSetDecl	FILE_LISTS
static RhnSetDecl	GPGSSL_KEYS
static RhnSetDecl	ISS_LOCAL_ORGS
static RhnSetDecl	ISS_MASTERS
static RhnSetDecl	ISS_SLAVES
static RhnSetDecl	KICKSTART_ACTIVATION_KEYS
static RhnSetDecl	KICSKTART_IPRANGES
static RhnSetDecl	METHODS_IN_ORG
static RhnSetDecl	MULTIORG_TRUST_LIST
static RhnSetDecl	ORG_LIST
static RhnSetDecl	PACKAGE_ANSWER_FILE_LIST
static RhnSetDecl	PACKAGE_DOWNLOADABLE_LIST
static RhnSetDecl	PACKAGE_INSTALLABLE_LIST
static RhnSetDecl	PACKAGE_PROFILES
static RhnSetDecl	PACKAGE_UPGRADABLE_LIST
static RhnSetDecl	PACKAGES_FOR_MERGE
static RhnSetDecl	PACKAGES_FOR_SYSTEM_SYNC
static RhnSetDecl	PACKAGES_REMOVABLE
static RhnSetDecl	PACKAGES_TO_ADD
static RhnSetDecl	PACKAGES_TO_INSTALL
static RhnSetDecl	PACKAGES_TO_PUSH
static RhnSetDecl	PACKAGES_TO_REMOVE
static RhnSetDecl	PACKAGES_TO_SYNC_CHANNEL
static RhnSetDecl	PACKAGES_UPGRADABLE
static RhnSetDecl	PACKAGES_VERIFY
static RhnSetDecl	PENDING_ACTIONS_TO_DELETE
static RhnSetDecl	REMOVABLE_SNAPSHOT_TAG_LIST
static RhnSetDecl	REMOVE_SYSTEM_FROM_GROUPS
static RhnSetDecl	REMOVE_SYSTEMS_LIST
static RhnSetDecl	REMOVEABLE_SYSTEM_LIST
static RhnSetDecl	SCHEDULE_ACTION_LIST
static RhnSetDecl	SNAPSHOT_TAGS_TO_DELETE
static RhnSetDecl	SSCD_REMOVABLE_PACKAGE_LIST
static RhnSetDecl	SSCD_VERIFY_PACKAGE_LIST
static RhnSetDecl	SSM_CHANNEL_LIST
static RhnSetDecl	SSM_CHANNEL_SUBSCRIBE
static RhnSetDecl	SSM_CHANNEL_UNSUBSCRIBE
static RhnSetDecl	SSM_GROUP_LIST
static RhnSetDecl	SSM_REMOVE_PACKAGES_LIST
static RhnSetDecl	SSM_SYSTEMS_REBOOT
static RhnSetDecl	SSM_SYSTEMS_SET_LOCK
static RhnSetDecl	SSM_UPGRADE_PACKAGES_LIST
static RhnSetDecl	SSM_VERIFY_PACKAGES_LIST
static RhnSetDecl	SYSTEM_ENTITLEMENTS
static RhnSetDecl	SYSTEM_GROUPS
static RhnSetDecl	SYSTEM_NOTES
static RhnSetDecl	SYSTEMS
static RhnSetDecl	SYSTEMS_AFFECTED
static RhnSetDecl	SYSTEMS_AFFECTED_BY_ERRATA
static RhnSetDecl	SYSTEMS_FAILED
static RhnSetDecl	TARGET_GROUPS_FOR_SYSTEM
static RhnSetDecl	TARGET_SYSTEMS
static RhnSetDecl	TARGET_SYSTEMS_FOR_CHANNEL
static RhnSetDecl	TEST
static RhnSetDecl	USERS
static RhnSetDecl	VIRTUAL_SYSTEMS
static RhnSetDecl	XCCDF_TESTRESULTS

Method Summary

Modifier and Type	Method and Description
void	clear(User u) Clear the set for user u
RhnSet	create(User u) Create a new, empty set
RhnSetDecl	createCustom(java.lang.Object... suffix) Creates new Declaration based on the selections for this set.
static RhnSetDecl	find(java.lang.String label) Retrieves the set declaration associated to the given label
static RhnSetDecl	findOrCreate(java.lang.String label, SetCleanup cleanup) Deprecated. Do not use this method.
static java.lang.String	generateCustomSetName(RhnSetDecl base, java.lang.Object... suffix) Generates a new set name based on an existing set and one or more variables.
RhnSet	get(User u) Load the set for user u.
java.lang.String	getLabel() The label of the set
RhnSet	lookup(User u) Look the set for user u up from the database.
static RhnSetDecl	setForChannelErrata(Channel chan) get the set for Channel Errata cloning
static RhnSetDecl	setForChannelPackages(Channel chan) get the set for Channel package pushing
static RhnSetDecl	setForSystemCrashes(Server serv) get the set for system software crashes

Methods inherited from class java.lang.Object

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

Field Detail

ACTIONS_COMPLETED

public static final RhnSetDecl ACTIONS_COMPLETED

ACTIONS_FAILED

public static final RhnSetDecl ACTIONS_FAILED

ACTIONS_ARCHIVED

public static final RhnSetDecl ACTIONS_ARCHIVED

ACTIONS_PENDING

public static final RhnSetDecl ACTIONS_PENDING

ACTIONS_UNSCHEDULE

public static final RhnSetDecl ACTIONS_UNSCHEDULE

ACTION_CHAINS

public static final RhnSetDecl ACTION_CHAINS

CHANNELS_FOR_ERRATA

public static final RhnSetDecl CHANNELS_FOR_ERRATA

ERRATA

public static final RhnSetDecl ERRATA

ERRATA_CLONE

public static final RhnSetDecl ERRATA_CLONE

ERRATA_TO_DELETE

public static final RhnSetDecl ERRATA_TO_DELETE

ERRATA_TO_DELETE_BULK

public static final RhnSetDecl ERRATA_TO_DELETE_BULK

ERRATA_TO_SYNC

public static final RhnSetDecl ERRATA_TO_SYNC

ERRATA_PACKAGES_TO_SYNC

public static final RhnSetDecl ERRATA_PACKAGES_TO_SYNC

FILE_LISTS

public static final RhnSetDecl FILE_LISTS

PACKAGES_FOR_SYSTEM_SYNC

public static final RhnSetDecl PACKAGES_FOR_SYSTEM_SYNC

PACKAGES_REMOVABLE

public static final RhnSetDecl PACKAGES_REMOVABLE

PACKAGES_TO_ADD

public static final RhnSetDecl PACKAGES_TO_ADD

PACKAGES_TO_PUSH

public static final RhnSetDecl PACKAGES_TO_PUSH

PACKAGES_TO_INSTALL

public static final RhnSetDecl PACKAGES_TO_INSTALL

PACKAGES_TO_REMOVE

public static final RhnSetDecl PACKAGES_TO_REMOVE

PACKAGES_UPGRADABLE

public static final RhnSetDecl PACKAGES_UPGRADABLE

PACKAGES_VERIFY

public static final RhnSetDecl PACKAGES_VERIFY

PACKAGES_TO_SYNC_CHANNEL

public static final RhnSetDecl PACKAGES_TO_SYNC_CHANNEL

SYSTEMS

public static final RhnSetDecl SYSTEMS

DUPLICATE_SYSTEMS

public static final RhnSetDecl DUPLICATE_SYSTEMS

SYSTEMS_AFFECTED

public static final RhnSetDecl SYSTEMS_AFFECTED

SYSTEM_ENTITLEMENTS

public static final RhnSetDecl SYSTEM_ENTITLEMENTS

SYSTEMS_FAILED

public static final RhnSetDecl SYSTEMS_FAILED

SYSTEM_GROUPS

public static final RhnSetDecl SYSTEM_GROUPS

TEST

public static final RhnSetDecl TEST

USERS

public static final RhnSetDecl USERS

METHODS_IN_ORG

public static final RhnSetDecl METHODS_IN_ORG

KICSKTART_IPRANGES

public static final RhnSetDecl KICSKTART_IPRANGES

ACTIVATION_KEYS

public static final RhnSetDecl ACTIVATION_KEYS

KICKSTART_ACTIVATION_KEYS

public static final RhnSetDecl KICKSTART_ACTIVATION_KEYS

GPGSSL_KEYS

public static final RhnSetDecl GPGSSL_KEYS

PACKAGE_PROFILES

public static final RhnSetDecl PACKAGE_PROFILES

CONFIG_SYSTEMS

public static final RhnSetDecl CONFIG_SYSTEMS

CONFIG_TARGET_SYSTEMS

public static final RhnSetDecl CONFIG_TARGET_SYSTEMS

CONFIG_ENABLE_SYSTEMS

public static final RhnSetDecl CONFIG_ENABLE_SYSTEMS

CONFIG_CHANNELS

public static final RhnSetDecl CONFIG_CHANNELS

CONFIG_CHANNELS_RANKING

public static final RhnSetDecl CONFIG_CHANNELS_RANKING

CONFIG_CHANNELS_TO_UNSUBSCRIBE

public static final RhnSetDecl CONFIG_CHANNELS_TO_UNSUBSCRIBE

CONFIG_FILES

public static final RhnSetDecl CONFIG_FILES

CONFIG_FILE_NAMES

public static final RhnSetDecl CONFIG_FILE_NAMES

ORG_LIST

public static final RhnSetDecl ORG_LIST

CONFIG_IMPORT_FILE_NAMES

public static final RhnSetDecl CONFIG_IMPORT_FILE_NAMES

CONFIG_REVISIONS

public static final RhnSetDecl CONFIG_REVISIONS

CONFIG_FILE_DEPLOY_SYSTEMS

public static final RhnSetDecl CONFIG_FILE_DEPLOY_SYSTEMS

CONFIG_CHANNEL_DEPLOY_REVISIONS

public static final RhnSetDecl CONFIG_CHANNEL_DEPLOY_REVISIONS

CONFIG_CHANNEL_DEPLOY_SYSTEMS

public static final RhnSetDecl CONFIG_CHANNEL_DEPLOY_SYSTEMS

SSM_GROUP_LIST

public static final RhnSetDecl SSM_GROUP_LIST

SSM_CHANNEL_LIST

public static final RhnSetDecl SSM_CHANNEL_LIST

SSM_REMOVE_PACKAGES_LIST

public static final RhnSetDecl SSM_REMOVE_PACKAGES_LIST

SSM_UPGRADE_PACKAGES_LIST

public static final RhnSetDecl SSM_UPGRADE_PACKAGES_LIST

SSM_VERIFY_PACKAGES_LIST

public static final RhnSetDecl SSM_VERIFY_PACKAGES_LIST

VIRTUAL_SYSTEMS

public static final RhnSetDecl VIRTUAL_SYSTEMS

REMOVE_SYSTEMS_LIST

public static final RhnSetDecl REMOVE_SYSTEMS_LIST

CHANNEL_SUBSCRIPTION_PERMS

public static final RhnSetDecl CHANNEL_SUBSCRIPTION_PERMS

TARGET_SYSTEMS_FOR_CHANNEL

public static final RhnSetDecl TARGET_SYSTEMS_FOR_CHANNEL

PACKAGE_DOWNLOADABLE_LIST

public static final RhnSetDecl PACKAGE_DOWNLOADABLE_LIST

ERRATA_TO_REMOVE

public static final RhnSetDecl ERRATA_TO_REMOVE

ERRATA_TO_ADD

public static final RhnSetDecl ERRATA_TO_ADD

PACKAGES_FOR_MERGE

public static final RhnSetDecl PACKAGES_FOR_MERGE

CHANNEL_MANAGEMENT_PERMS

public static final RhnSetDecl CHANNEL_MANAGEMENT_PERMS

TARGET_SYSTEMS

public static final RhnSetDecl TARGET_SYSTEMS

DELETABLE_PACKAGE_LIST

public static final RhnSetDecl DELETABLE_PACKAGE_LIST

REMOVEABLE_SYSTEM_LIST

public static final RhnSetDecl REMOVEABLE_SYSTEM_LIST

PACKAGE_INSTALLABLE_LIST

public static final RhnSetDecl PACKAGE_INSTALLABLE_LIST

PACKAGE_ANSWER_FILE_LIST

public static final RhnSetDecl PACKAGE_ANSWER_FILE_LIST

PACKAGE_UPGRADABLE_LIST

public static final RhnSetDecl PACKAGE_UPGRADABLE_LIST

REMOVE_SYSTEM_FROM_GROUPS

public static final RhnSetDecl REMOVE_SYSTEM_FROM_GROUPS

TARGET_GROUPS_FOR_SYSTEM

public static final RhnSetDecl TARGET_GROUPS_FOR_SYSTEM

SCHEDULE_ACTION_LIST

public static final RhnSetDecl SCHEDULE_ACTION_LIST

REMOVABLE_SNAPSHOT_TAG_LIST

public static final RhnSetDecl REMOVABLE_SNAPSHOT_TAG_LIST

SYSTEMS_AFFECTED_BY_ERRATA

public static final RhnSetDecl SYSTEMS_AFFECTED_BY_ERRATA

SSCD_VERIFY_PACKAGE_LIST

public static final RhnSetDecl SSCD_VERIFY_PACKAGE_LIST

SSCD_REMOVABLE_PACKAGE_LIST

public static final RhnSetDecl SSCD_REMOVABLE_PACKAGE_LIST

MULTIORG_TRUST_LIST

public static final RhnSetDecl MULTIORG_TRUST_LIST

SSM_CHANNEL_SUBSCRIBE

public static final RhnSetDecl SSM_CHANNEL_SUBSCRIBE

SSM_CHANNEL_UNSUBSCRIBE

public static final RhnSetDecl SSM_CHANNEL_UNSUBSCRIBE

ISS_SLAVES

public static final RhnSetDecl ISS_SLAVES

ISS_MASTERS

public static final RhnSetDecl ISS_MASTERS

ISS_LOCAL_ORGS

public static final RhnSetDecl ISS_LOCAL_ORGS

XCCDF_TESTRESULTS

public static final RhnSetDecl XCCDF_TESTRESULTS

SSM_SYSTEMS_SET_LOCK

public static final RhnSetDecl SSM_SYSTEMS_SET_LOCK

SSM_SYSTEMS_REBOOT

public static final RhnSetDecl SSM_SYSTEMS_REBOOT

PENDING_ACTIONS_TO_DELETE

public static final RhnSetDecl PENDING_ACTIONS_TO_DELETE

SNAPSHOT_TAGS_TO_DELETE

public static final RhnSetDecl SNAPSHOT_TAGS_TO_DELETE

SYSTEM_NOTES

public static final RhnSetDecl SYSTEM_NOTES

Method Detail

clear

public void clear(User u)

Clear the set for user u

Parameters:

u - the user whose set to clear

create

public RhnSet create(User u)

Create a new, empty set

Parameters:

u - the user for whom to create the set

Returns:

the created set

get

public RhnSet get(User u)

Load the set for user u. If the set for this user does not exist yet, a new one is created. In other words, this method will always return a non-null value.

Parameters:

u - the user for whom to get the set

Returns:

the set for user u

getLabel

public java.lang.String getLabel()

The label of the set

Returns:

the label of the set

lookup

public RhnSet lookup(User u)

Look the set for user u up from the database. If the user has no entries in the set, return null

Parameters:

u - the user for whom to look the set up

Returns:

the set or null if the user has nothing in the set

createCustom

public RhnSetDecl createCustom(java.lang.Object... suffix)

Creates new Declaration based on the selections for this set.

Parameters:

suffix - suffix to make this set declaration unique

Returns:

the newly created set declaration.

findOrCreate

@Deprecated
public static RhnSetDecl findOrCreate(java.lang.String label,
                                                  SetCleanup cleanup)

Deprecated. Do not use this method.

DO NOT USE THIS METHOD. IT IS ONLY PROVIDED TO SUPPORT LEGACY USES. Looks up an existing set declaration for the given label. If one exists, cleanup is ignored. Otherwise, a declaration with the given cleanup and label is created.

Parameters:

label - the label for the set

cleanup - the cleanup to use

Returns:

the set declaration

find

public static RhnSetDecl find(java.lang.String label)

Retrieves the set declaration associated to the given label

Parameters:

label - the label for the set

Returns:

the set declaration or null if none exists

setForChannelErrata

public static RhnSetDecl setForChannelErrata(Channel chan)

get the set for Channel Errata cloning

Parameters:

chan - the Channel passed in

Returns:

the Set decl

setForChannelPackages

public static RhnSetDecl setForChannelPackages(Channel chan)

get the set for Channel package pushing

Parameters:

chan - the Channel passed in

Returns:

the Set decl

setForSystemCrashes

public static RhnSetDecl setForSystemCrashes(Server serv)

get the set for system software crashes

Parameters:

serv - server passed in

Returns:

the Set descl

generateCustomSetName

public static java.lang.String generateCustomSetName(RhnSetDecl base,
                                                     java.lang.Object... suffix)

Generates a new set name based on an existing set and one or more variables.

Parameters:

base - the generation will use the label from this set

suffix - used as entropy in the custom name

Returns:

name suitable for an RhnSet that is a derivative of the base set