com.redhat.rhn.frontend.xmlrpc.activationkey

Class ActivationKeyHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.activationkey.ActivationKeyHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ActivationKeyHandler
extends BaseHandler

ActivationKeyHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ActivationKeyHandler()

Method Summary

Modifier and Type	Method and Description
int	addChildChannels(User loggedInUser, java.lang.String key, java.util.List childChannelLabels) Add a child channel to an activation key.
int	addConfigChannels(User loggedInUser, java.util.List<java.lang.String> keys, java.util.List<java.lang.String> configChannelLabels, boolean addToTop) Given a list of activation keys and configuration channels, this method inserts the configuration channels to either the top or the bottom (whichever you specify) of an activation key's configuration channels list.
int	addEntitlements(User loggedInUser, java.lang.String key, java.util.List entitlements) Add entitlements to an activation key.
int	addPackageNames(User loggedInUser, java.lang.String key, java.util.List packageNames) Deprecated. being replaced by addPackages(string sessionKey, string key, array[packages])
int	addPackages(User loggedInUser, java.lang.String key, java.util.List<java.util.Map<java.lang.String,java.lang.String>> packages) Add packages to an activation key.
int	addServerGroups(User loggedInUser, java.lang.String key, java.util.List serverGroupIds) Add server groups to an activation key.
int	checkConfigDeployment(User loggedInUser, java.lang.String key) Check configuration file deployment status for the activation key specified.
java.lang.String	clone(User loggedInUser, java.lang.String key, java.lang.String cloneDescription) Clones activation key
java.lang.String	create(User loggedInUser, java.lang.String key, java.lang.String description, java.lang.String baseChannelLabel, java.lang.Integer usageLimit, java.util.List entitlements, java.lang.Boolean universalDefault) Creates a new activation key.
java.lang.String	create(User loggedInUser, java.lang.String key, java.lang.String description, java.lang.String baseChannelLabel, java.util.List entitlements, java.lang.Boolean universalDefault) Creates a new activation key with unlimited usage..
int	delete(User loggedInUser, java.lang.String key) Deletes an activation key.
int	disableConfigDeployment(User loggedInUser, java.lang.String key) Disable configuration file deployment for the specified activation key
int	enableConfigDeployment(User loggedInUser, java.lang.String key) Enable configuration file deployment for the specified activation key
ActivationKey	getDetails(User loggedInUser, java.lang.String key) Return a struct of activation key details.
java.lang.Object[]	listActivatedSystems(User loggedInUser, java.lang.String key) Return a list of systems activated with the activation key provided.
java.util.List<ActivationKey>	listActivationKeys(User loggedInUser) Return a list of activation key structs that are visible to the requesting user.
java.util.List	listConfigChannels(User loggedInUser, java.lang.String key) Returns a list of config channel structs that are associated to a given activation key.
int	removeChildChannels(User loggedInUser, java.lang.String key, java.util.List childChannelLabels) Remove a child channel from an activation key.
int	removeConfigChannels(User loggedInUser, java.util.List<java.lang.String> keys, java.util.List<java.lang.String> configChannelLabels) removes selected channels from list of config channels provided for a given list of activation keys.
int	removeEntitlements(User loggedInUser, java.lang.String key, java.util.List entitlements) Remove entitlements from an activation key.
int	removePackageNames(User loggedInUser, java.lang.String key, java.util.List packageNames) Deprecated. being replaced by removePackages(string sessionKey, string key, array[packages])
int	removePackages(User loggedInUser, java.lang.String key, java.util.List<java.util.Map<java.lang.String,java.lang.String>> packages) Remove packages from an activation key.
int	removeServerGroups(User loggedInUser, java.lang.String key, java.util.List serverGroupIds) Remove server groups from an activation key.
int	setConfigChannels(User loggedInUser, java.util.List<java.lang.String> keys, java.util.List<java.lang.String> configChannelLabels) replaces the existing set of config channels for a given activation key.
int	setDetails(User loggedInUser, java.lang.String key, java.util.Map details) Set activation key 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

ActivationKeyHandler

public ActivationKeyHandler()

Method Detail

create

public java.lang.String create(User loggedInUser,
                               java.lang.String key,
                               java.lang.String description,
                               java.lang.String baseChannelLabel,
                               java.lang.Integer usageLimit,
                               java.util.List entitlements,
                               java.lang.Boolean universalDefault)
                        throws FaultException

Creates a new activation key.

Parameters:

loggedInUser - The current user

key - Key for the activation key, or empty string to have one autogenerated.

description - A note or description.

baseChannelLabel - label of this key's base channel.

usageLimit - Usage limit for this key.

entitlements - List of string entitlement labels for the activation key.

universalDefault - Whether or not this key should be set as the default for the user's organization.

Returns:

Key of the newly created activation key.

Throws:

FaultException - A FaultException is thrown if the loggedInUser doesn't have permissions to create new activation keys.

clone

public java.lang.String clone(User loggedInUser,
                              java.lang.String key,
                              java.lang.String cloneDescription)
                       throws FaultException

Clones activation key

Parameters:

loggedInUser - The current user

key - Actication Key to be cloned

cloneDescription - Description for the new activation key.

Returns:

Key of the newly created activation key.

Throws:

FaultException - A FaultException is thrown if the loggedInUser doesn't have permissions to create new activation keys.

create

public java.lang.String create(User loggedInUser,
                               java.lang.String key,
                               java.lang.String description,
                               java.lang.String baseChannelLabel,
                               java.util.List entitlements,
                               java.lang.Boolean universalDefault)
                        throws FaultException

Creates a new activation key with unlimited usage..

Parameters:

loggedInUser - The current user

key - Key for the activation key, or empty string to have one autogenerated.

description - A note or description.

baseChannelLabel - label of this key's base channel.

entitlements - List of string entitlement labels for the activation key.

universalDefault - Whether or not this key should be set as the default for the user's organization.

Returns:

Key of the newly created activation key.

Throws:

FaultException - A FaultException is thrown if the loggedInUser doesn't have permissions to create new activation keys.

delete

public int delete(User loggedInUser,
                  java.lang.String key)

Deletes an activation key.

Parameters:

loggedInUser - The current user

key - Key for the activation key, or empty string to have one autogenerated.

Returns:

Key of the newly created activation key.

Throws:

java.lang.IllegalArgumentException - if the loggedInUser doesn't have permissions to create new activation keys.

setDetails

public int setDetails(User loggedInUser,
                      java.lang.String key,
                      java.util.Map details)
               throws FaultException

Set activation key details.

Parameters:

loggedInUser - The current user

key - The activation key to be modified

details - Map of new details. (contents optional)

Returns:

1 if edit was successful, exception thrown otherwise.

Throws:

FaultException - Thrown if the user does not have the activation key admin role, if the base channel given does not exist, or if it actually is not a base channel.

getDetails

public ActivationKey getDetails(User loggedInUser,
                                java.lang.String key)

Return a struct of activation key details.

Parameters:

loggedInUser - The current user

key - The activation key to be modified

Returns:

Map representation of the activation key

Since:

10.2

addEntitlements

public int addEntitlements(User loggedInUser,
                           java.lang.String key,
                           java.util.List entitlements)

Add entitlements to an activation key. Currently only virtualization_host add-on entitlement is permitted.

Parameters:

loggedInUser - The current user

key - The activation key to act upon.

entitlements - List of string entitlement labels to be added.

Returns:

1 on success, exception thrown otherwise.

removeEntitlements

public int removeEntitlements(User loggedInUser,
                              java.lang.String key,
                              java.util.List entitlements)

Remove entitlements from an activation key. Currently only virtualization_host add-on entitlement is permitted.

Parameters:

loggedInUser - The current user

key - The activation key to act upon.

entitlements - List of string entitlement labels to be removed.

Returns:

1 on success, exception thrown otherwise.

addChildChannels

public int addChildChannels(User loggedInUser,
                            java.lang.String key,
                            java.util.List childChannelLabels)

Add a child channel to an activation key.

Parameters:

loggedInUser - The current user

key - The activation key to act upon

childChannelLabels - List of child channel labels to be added to this activation key

Returns:

1 on success, exception thrown otherwise

removeChildChannels

public int removeChildChannels(User loggedInUser,
                               java.lang.String key,
                               java.util.List childChannelLabels)

Remove a child channel from an activation key.

Parameters:

loggedInUser - The current user

key - The activation key to act upon

childChannelLabels - List of child channel labels to be removed from this activation key

Returns:

1 on success, exception thrown otherwise

addServerGroups

public int addServerGroups(User loggedInUser,
                           java.lang.String key,
                           java.util.List serverGroupIds)

Add server groups to an activation key.

Parameters:

loggedInUser - The current user

key - The activation key to act upon.

serverGroupIds - List of server group IDs to be added to this activation key.

Returns:

1 on success, exception thrown otherwise.

removeServerGroups

public int removeServerGroups(User loggedInUser,
                              java.lang.String key,
                              java.util.List serverGroupIds)

Remove server groups from an activation key.

Parameters:

loggedInUser - The current user

key - The activation key to act upon

serverGroupIds - List of server group IDs to be removed from this activation key

Returns:

1 on success, exception thrown otherwise

addPackageNames

@Deprecated
public int addPackageNames(User loggedInUser,
                                       java.lang.String key,
                                       java.util.List packageNames)

Deprecated. being replaced by addPackages(string sessionKey, string key, array[packages])

Add packages to an activation key using package name only.

Parameters:

loggedInUser - The current user

key - The activation key to act upon

packageNames - List of package names to be added to this activation key

Returns:

1 on success, exception thrown otherwise.

Since:

10.2

removePackageNames

@Deprecated
public int removePackageNames(User loggedInUser,
                                          java.lang.String key,
                                          java.util.List packageNames)

Deprecated. being replaced by removePackages(string sessionKey, string key, array[packages])

Remove package names from an activation key.

Parameters:

loggedInUser - The current user

key - The activation key to act upon

packageNames - List of package names to be removed from this activation key

Returns:

1 on success, exception thrown otherwise

Since:

10.2

addPackages

public int addPackages(User loggedInUser,
                       java.lang.String key,
                       java.util.List<java.util.Map<java.lang.String,java.lang.String>> packages)

Add packages to an activation key.

Parameters:

loggedInUser - The current user

key - The activation key to act upon

packages - List of packages to be added to this activation key

Returns:

1 on success, exception thrown otherwise.

removePackages

public int removePackages(User loggedInUser,
                          java.lang.String key,
                          java.util.List<java.util.Map<java.lang.String,java.lang.String>> packages)

Remove packages from an activation key.

Parameters:

loggedInUser - The current user

key - The activation key to act upon

packages - List of packages to be removed from this activation key

Returns:

1 on success, exception thrown otherwise

listActivationKeys

public java.util.List<ActivationKey> listActivationKeys(User loggedInUser)

Return a list of activation key structs that are visible to the requesting user.

Parameters:

loggedInUser - The current user

Returns:

List of map representations of activation keys

Since:

10.2

listActivatedSystems

public java.lang.Object[] listActivatedSystems(User loggedInUser,
                                               java.lang.String key)

Return a list of systems activated with the activation key provided.

Parameters:

loggedInUser - The current user

key - The activation key

Returns:

List of map representations of systems.

listConfigChannels

public java.util.List listConfigChannels(User loggedInUser,
                                         java.lang.String key)

Returns a list of config channel structs that are associated to a given activation key.

Parameters:

loggedInUser - The current user

key - the activation key

Returns:

list of config channel strutcs

setConfigChannels

public int setConfigChannels(User loggedInUser,
                             java.util.List<java.lang.String> keys,
                             java.util.List<java.lang.String> configChannelLabels)

replaces the existing set of config channels for a given activation key. Note: it ranks these channels according to the array order of configChannelIds method parameter

Parameters:

loggedInUser - The current user

keys - a lsit of activation keys.

configChannelLabels - sets channels labels

Returns:

1 on success 0 on failure

addConfigChannels

public int addConfigChannels(User loggedInUser,
                             java.util.List<java.lang.String> keys,
                             java.util.List<java.lang.String> configChannelLabels,
                             boolean addToTop)

Given a list of activation keys and configuration channels, this method inserts the configuration channels to either the top or the bottom (whichever you specify) of an activation key's configuration channels list. The ordering of the configuration channels provided in the add list is maintained while adding. If one of the configuration channels in the 'add' list already exists in an activation key, the configuration channel will be re-ranked to the appropriate place.

Parameters:

loggedInUser - The current user

keys - the list of activation keys.

configChannelLabels - set of configuration channels labels

addToTop - if true inserts the configuration channels list to the top of the configuration channels list of a server

Returns:

1 on success 0 on failure

removeConfigChannels

public int removeConfigChannels(User loggedInUser,
                                java.util.List<java.lang.String> keys,
                                java.util.List<java.lang.String> configChannelLabels)

removes selected channels from list of config channels provided for a given list of activation keys.

Parameters:

loggedInUser - The current user

keys - the list of activation key values.

configChannelLabels - sets channels labels

Returns:

1 on success 0 on failure

enableConfigDeployment

public int enableConfigDeployment(User loggedInUser,
                                  java.lang.String key)

Enable configuration file deployment for the specified activation key

Parameters:

loggedInUser - The current user

key - the activation key

Returns:

1 on success, 0 on failure

disableConfigDeployment

public int disableConfigDeployment(User loggedInUser,
                                   java.lang.String key)

Disable configuration file deployment for the specified activation key

Parameters:

loggedInUser - The current user

key - the activation key

Returns:

1 on success, 0 on failure

checkConfigDeployment

public int checkConfigDeployment(User loggedInUser,
                                 java.lang.String key)

Check configuration file deployment status for the activation key specified.

Parameters:

loggedInUser - The current user

key - the activation key

Returns:

1 if enabled, 0 if disabled, exception thrown otherwise