com.redhat.rhn.domain.token

Class ActivationKey

java.lang.Object

com.redhat.rhn.domain.BaseDomainHelper

com.redhat.rhn.domain.token.ActivationKey

public class ActivationKey
extends BaseDomainHelper

ActivationKey

Constructor Summary

Constructors

Constructor and Description
ActivationKey()

Method Summary

Modifier and Type	Method and Description
void	addChannel(Channel channelIn) Add a Channel to this ActivationKey
void	addEntitlement(ServerGroupType entitlementIn)
void	addPackage(PackageName packageNameIn, PackageArch packageArchIn) Add a package to this ActivationKey using PackageName only
void	addServerGroup(ManagedServerGroup serverGroupIn) Add a ServerGroup to this ActivationKey
void	clearChannels() Clear all channels associated with this token.
void	clearConfigChannels() Clear all config channel associated with this activation key.
void	clearPackages() Clear all packages associated with this activation key.
Channel	getBaseChannel() Return the base channel or null if none exists
java.util.Set<Channel>	getChannels() Get the Set of Channels associated with this ActivationKey
java.util.List<ConfigChannel>	getConfigChannelsFor(User user) Returns the config channels associated to this activation key Throws a LookupException if the user does NOT have permissson to access/deal with these channels.
User	getCreator()
boolean	getDeployConfigs()
java.util.Set<ServerGroupType>	getEntitlements()
java.lang.Long	getId()
java.lang.String	getKey()
KickstartSession	getKickstartSession()
java.lang.String	getNote()
Org	getOrg()
java.util.Set<TokenPackage>	getPackages() Get the Set of TokenPackage objects associated with this ActivationKey
Server	getServer()
java.util.Set<ServerGroup>	getServerGroups() Get the Set of ServerGroup objects associated with this ActivationKey
Token	getToken()
java.lang.Long	getUsageLimit()
boolean	isDisabled()
boolean	isUniversalDefault() Returns true if this token is the org default.
static java.lang.String	makePrefix(Org org) Makes the Activation key prefix that will get added to the base key
void	removeChannel(Channel channelIn) Remove a Channel from this ActivationKey
void	removeEntitlement(ServerGroupType entitlementIn)
void	removePackage(PackageName packageNameIn, PackageArch packageArchIn) Remove packages from the ActivationKey that match the PackageName and PackageArch given.
void	removeServerGroup(ServerGroup serverGroupIn) Remove a ServerGroup from this ActivationKey
static java.lang.String	sanitize(Org org, java.lang.String key) Helper method to return a santized activation key name
void	setBaseChannel(Channel chan) sets the base channel..
void	setChannels(java.util.Set channelsIn) Set the Set of Channels associated with this ActivationKey
void	setCreator(User user)
void	setDeployConfigs(boolean b)
void	setDisabled(java.lang.Boolean disabled)
void	setEntitlements(java.util.Set entitlementsIn)
void	setId(java.lang.Long id)
void	setKey(java.lang.String keyIn)
void	setKickstartSession(KickstartSession kickstartSessionIn)
void	setNote(java.lang.String note)
void	setOrg(Org org)
void	setPackages(java.util.Set<TokenPackage> packagesIn) set the Set of TokenPackage objects associated with this ActivationKey
void	setServer(Server server)
void	setServerGroups(java.util.Set<ServerGroup> serverGroupsIn) Set the Set of ServerGroup objects associated with this ActivationKey
protected void	setToken(Token tokenIn)
void	setUniversalDefault(boolean def) Sets the universal default.
void	setUsageLimit(java.lang.Long limit)
java.lang.String	toString()

Methods inherited from class com.redhat.rhn.domain.BaseDomainHelper

getCreated, getModified, setCreated, setModified

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivationKey

public ActivationKey()

Method Detail

getKey

public java.lang.String getKey()

Returns:

Returns the key.

setKey

public void setKey(java.lang.String keyIn)

Parameters:

keyIn - The key to set.

getKickstartSession

public KickstartSession getKickstartSession()

Returns:

Returns the kickstartSession.

setKickstartSession

public void setKickstartSession(KickstartSession kickstartSessionIn)

Parameters:

kickstartSessionIn - The kickstartSession to set.

getToken

public Token getToken()

Returns:

Returns the token.

setToken

protected void setToken(Token tokenIn)

Parameters:

tokenIn - The token to set.

toString

public java.lang.String toString()

Overrides:

toString in class BaseDomainHelper

setId

public void setId(java.lang.Long id)

Parameters:

id - The id to set

getId

public java.lang.Long getId()

Returns:

Returns the token's id

setCreator

public void setCreator(User user)

Parameters:

user - The user to set

getCreator

public User getCreator()

Returns:

Returns the tokens user

setOrg

public void setOrg(Org org)

Parameters:

org - The org to set

getOrg

public Org getOrg()

Returns:

Returns the org

setServer

public void setServer(Server server)

Parameters:

server - The server to set

getServer

public Server getServer()

Returns:

Returns the server

setNote

public void setNote(java.lang.String note)

Parameters:

note - The note to set

getNote

public java.lang.String getNote()

Returns:

Returns the tokens note

setDeployConfigs

public void setDeployConfigs(boolean b)

Parameters:

b - Deploy configs

getDeployConfigs

public boolean getDeployConfigs()

Returns:

Returns deploy configs

setDisabled

public void setDisabled(java.lang.Boolean disabled)

Parameters:

disabled - The disabled to set

isDisabled

public boolean isDisabled()

Returns:

Is this token disabled?

setUsageLimit

public void setUsageLimit(java.lang.Long limit)

Parameters:

limit - The usage limit to set

getUsageLimit

public java.lang.Long getUsageLimit()

Returns:

The usage limit for this token

setEntitlements

public void setEntitlements(java.util.Set entitlementsIn)

Parameters:

entitlementsIn - The entitlements to set

getEntitlements

public java.util.Set<ServerGroupType> getEntitlements()

Returns:

Returns the set of entitlements for this activation key

addEntitlement

public void addEntitlement(ServerGroupType entitlementIn)

Parameters:

entitlementIn - The entitlement to add to the tokens entitlements set.

removeEntitlement

public void removeEntitlement(ServerGroupType entitlementIn)

Parameters:

entitlementIn - The entitlement to remove from the tokens entitlements set.

addChannel

public void addChannel(Channel channelIn)

Add a Channel to this ActivationKey

Parameters:

channelIn - to add

removeChannel

public void removeChannel(Channel channelIn)

Remove a Channel from this ActivationKey

Parameters:

channelIn - to remove

clearChannels

public void clearChannels()

Clear all channels associated with this token.

getChannels

public java.util.Set<Channel> getChannels()

Get the Set of Channels associated with this ActivationKey

Returns:

Set of Channel objects.

setChannels

public void setChannels(java.util.Set channelsIn)

Set the Set of Channels associated with this ActivationKey

Parameters:

channelsIn - Channel set

addServerGroup

public void addServerGroup(ManagedServerGroup serverGroupIn)

Add a ServerGroup to this ActivationKey

Parameters:

serverGroupIn - to add

removeServerGroup

public void removeServerGroup(ServerGroup serverGroupIn)

Remove a ServerGroup from this ActivationKey

Parameters:

serverGroupIn - to remove

getServerGroups

public java.util.Set<ServerGroup> getServerGroups()

Get the Set of ServerGroup objects associated with this ActivationKey

Returns:

Set of ServerGroup objects.

setServerGroups

public void setServerGroups(java.util.Set<ServerGroup> serverGroupsIn)

Set the Set of ServerGroup objects associated with this ActivationKey

Parameters:

serverGroupsIn - Servers Groups set

addPackage

public void addPackage(PackageName packageNameIn,
                       PackageArch packageArchIn)

Add a package to this ActivationKey using PackageName only

Parameters:

packageNameIn - PackageName of package to add

packageArchIn - PackageArch of package to add

removePackage

public void removePackage(PackageName packageNameIn,
                          PackageArch packageArchIn)

Remove packages from the ActivationKey that match the PackageName and PackageArch given.

Parameters:

packageNameIn - PackageName of package to remove

packageArchIn - PackageArch of package to remove

getPackages

public java.util.Set<TokenPackage> getPackages()

Get the Set of TokenPackage objects associated with this ActivationKey

Returns:

Set of TokenPackage objects.

setPackages

public void setPackages(java.util.Set<TokenPackage> packagesIn)

set the Set of TokenPackage objects associated with this ActivationKey

Parameters:

packagesIn - Set of TokenPackage objects.

clearPackages

public void clearPackages()

Clear all packages associated with this activation key.

clearConfigChannels

public void clearConfigChannels()

Clear all config channel associated with this activation key.

getConfigChannelsFor

public java.util.List<ConfigChannel> getConfigChannelsFor(User user)

Returns the config channels associated to this activation key Throws a LookupException if the user does NOT have permissson to access/deal with these channels.

Parameters:

user - the user needed to ensure credentials

Returns:

the config channels associated to this activation key

setBaseChannel

public void setBaseChannel(Channel chan)

sets the base channel.. clears child channels if it has to

Parameters:

chan - the base channel associated to this activation key.

getBaseChannel

public Channel getBaseChannel()

Return the base channel or null if none exists

Returns:

the base channel.

setUniversalDefault

public void setUniversalDefault(boolean def)

Sets the universal default.

Parameters:

def - the universal default

isUniversalDefault

public boolean isUniversalDefault()

Returns true if this token is the org default.

Returns:

tru if its the org defaul false otherwise

makePrefix

public static java.lang.String makePrefix(Org org)

Makes the Activation key prefix that will get added to the base key

Parameters:

org - the org of the activation key

Returns:

the key prefix.

sanitize

public static java.lang.String sanitize(Org org,
                                        java.lang.String key)

Helper method to return a santized activation key name

Parameters:

org - the org information to make the prefix

key - the activation key to be sanitized

Returns:

the sanitized + formatted key