com.redhat.rhn.domain.server

Class ServerFactory

java.lang.Object

com.redhat.rhn.common.hibernate.HibernateFactory

com.redhat.rhn.domain.server.ServerFactory

public class ServerFactory
extends HibernateFactory

ServerFactory - the singleton class used to fetch and store com.redhat.rhn.domain.server.Server objects from the database.

Method Summary

Modifier and Type	Method and Description
static void	addServerToGroup(Server serverIn, ServerGroup serverGroupIn) Adds a Server to a group.
static void	addTagToSnapshot(java.lang.Long snpId, java.lang.Long orgId, java.lang.String tagName) Adds tag to the snapshot
static void	bulkAddTagToSnapshot(java.lang.String tagName, java.lang.String setLabel, User user) Adds tag to snapshot for systems in set
static java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	compatibleWithServer(User user, Server server) Returns a list of Servers which are compatible with the given server.
static Server	createServer() Create a new Server from scratch
static void	delete(Server server) Deletes a server
static void	deleteSnapshot(ServerSnapshot snap) Delete a snapshot
static void	deleteSnapshots(Org org, java.util.Date startDate, java.util.Date endDate) Delete snapshots across servers in the org.
static void	deleteSnapshots(Org org, Server server, java.util.Date startDate, java.util.Date endDate) Delete snapshots associated with a server.
static void	deproxify(Server server) Remove proxy info object associated to the server.
protected static CustomDataValue	getCustomDataValue(CustomDataKey key, Server server) Looks up the CustomDataValue given CustomDataKey and Server objects.
protected org.apache.log4j.Logger	getLogger() Get the Logger for the derived class so log messages show up on the correct class
static java.util.List<HistoryEvent>	getServerHistory(Server server) gets a server's history sorted by creation time.
static java.util.List<SnapshotTag>	getSnapshotTags(ServerSnapshot snap) get tags for a given snapshot
static java.util.List<User>	listAdministrators(Server server) Returns the admins of a given server This includes
static java.util.List<Server>	listConfigDiffEnabledSystems() Returns a global multi org spanning list of servers that are config-diff enabled.
static java.util.List<Server>	listConfigEnabledSystems() Returns a global multi org spanning list of servers that are config enabled.
static java.util.List<java.lang.Long>	listLinuxSystems(java.util.Collection<java.lang.Long> systemIds) Filter out a list of systemIds with ones that are linux systems (i.e.
static java.util.List<SoftwareCrashDto>	listServerSoftwareCrashes(Server server) Lists software crashes for a server
static java.util.List<ServerSnapshot>	listSnapshots(Org org, Server server, java.util.Date startDate, java.util.Date endDate) List snapshots associated with a server.
static java.util.List<Server>	listSystemsInSsm(User user) Returns a list of Server objects currently selected in the System Set Manager.
static Server	lookupByCert(ClientCertificate clientcert) Lookup a Server with the ClientCertificate.
static Server	lookupById(java.lang.Long id) Lookup a Server by their id
static Server	lookupByIdAndOrg(java.lang.Long id, Org orgIn) Lookup a Server by their id
static java.util.List<Server>	lookupByIds(java.util.List<java.lang.Long> ids) Lookup Servers by their ids
static java.util.List<Server>	lookupByIdsAndUser(java.util.List<java.lang.Long> serverIds, User user) Looks up server objects from the given list of server IDs.
static CPUArch	lookupCPUArchByName(java.lang.String name) Lookup a CPUArch by its name
static java.util.List<CustomDataValue>	lookupCustomDataValues(CustomDataKey key) Lookup all CustomDataValues associated with the CustomDataKey.
static ServerSnapshot	lookupLatestForServer(Server server) Looks up a latest snapshot for a sever
static java.util.List<Server>	lookupProxiesByOrg(User user) List all proxies for a given org
static ServerArch	lookupServerArchByLabel(java.lang.String label) Lookup a ServerArch by its label
static ServerGroupType	lookupServerGroupTypeByLabel(java.lang.String label) Lookup a ServerGroupType by its label
static java.util.List	lookupServersWithCustomKey(java.lang.Long userId, java.lang.Long cikid) Lookup all the systems with the specified CustomDataKey.
static ServerSnapshot	lookupSnapshotById(java.lang.Integer id) Looks up a server snapshot by it's id
static SnapshotTag	lookupSnapshotTagbyId(java.lang.Long tagId)
static SnapshotTag	lookupSnapshotTagbyName(java.lang.String tagName) Looks up snapshot tag by tag name
static java.util.List<Device>	lookupStorageDevicesByServer(Server s) Lookup all storage Devices associated with the server.
static void	removeCustomDataValue(Server server, CustomDataKey key) Remove the custom data value associated with the custom data key provided for the given server.
static void	removeCustomDataValues(Server server) Remove the custom data values associated with a server.
static void	removeCustomKey(CustomDataKey keyIn) Remove a custom data key.
static void	removeServerFromGroup(java.lang.Long sid, java.lang.Long sgid) Removes a Server from a group
static void	removeTagFromSnapshot(java.lang.Long serverId, SnapshotTag tag) Removes tag from system snapshot
static void	save(Server serverIn) Insert or Update a Server.
static void	saveCustomKey(CustomDataKey keyIn) Save a custom data key
static void	saveSnapshot(ServerSnapshot snapshotIn) Save a server snapshot
static Server	unsubscribeFromAllChannels(User user, Server server) Clear out all subscriptions for a particular server

Methods inherited from class com.redhat.rhn.common.hibernate.HibernateFactory

addConfigurator, blobToByteArray, byteArrayToBlob, closeSession, closeSessionFactory, commitTransaction, createSessionFactory, createSessionFactory, executeCallableMode, executeSelectMode, getBlobContents, getByteArrayContents, getObject, getSession, initialize, inTransaction, isClosed, isInitialized, listObjectsByNamedQuery, listObjectsByNamedQuery, listObjectsByNamedQuery, lockObject, lookupObjectByNamedQuery, lookupObjectByNamedQuery, reload, removeObject, rollbackTransaction, saveObject, saveObject, stringToByteArray

Methods inherited from class java.lang.Object

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

Method Detail

getCustomDataValue

protected static CustomDataValue getCustomDataValue(CustomDataKey key,
                                                    Server server)

Looks up the CustomDataValue given CustomDataKey and Server objects.

Parameters:

key - The Key for the value you would like to lookup

server - The Server in question

Returns:

Returns the CustomDataValue object if found, null if not.

removeCustomDataValues

public static void removeCustomDataValues(Server server)

Remove the custom data values associated with a server.

Parameters:

server - The server

removeCustomDataValue

public static void removeCustomDataValue(Server server,
                                         CustomDataKey key)

Remove the custom data value associated with the custom data key provided for the given server.

Parameters:

server - The server

key - The custom data key

lookupCustomDataValues

public static java.util.List<CustomDataValue> lookupCustomDataValues(CustomDataKey key)

Lookup all CustomDataValues associated with the CustomDataKey.

Parameters:

key - The Key for the values you would like to lookup

Returns:

List of custom data values.

lookupServersWithCustomKey

public static java.util.List lookupServersWithCustomKey(java.lang.Long userId,
                                                        java.lang.Long cikid)

Lookup all the systems with the specified CustomDataKey.

Parameters:

userId - The User ID of the user doing the query

cikid - The ID of the Key for the values you would like to lookup

Returns:

List of systems

lookupStorageDevicesByServer

public static java.util.List<Device> lookupStorageDevicesByServer(Server s)

Lookup all storage Devices associated with the server.

Parameters:

s - The server for the values you would like to lookup

Returns:

List of devices

getLogger

protected org.apache.log4j.Logger getLogger()

Get the Logger for the derived class so log messages show up on the correct class

Specified by:

getLogger in class HibernateFactory

Returns:

Logger for this class.

createServer

public static Server createServer()

Create a new Server from scratch

Returns:

the Server created

addServerToGroup

public static void addServerToGroup(Server serverIn,
                                    ServerGroup serverGroupIn)

Adds a Server to a group.

Parameters:

serverIn - The server to add

serverGroupIn - The group to add the server to

removeServerFromGroup

public static void removeServerFromGroup(java.lang.Long sid,
                                         java.lang.Long sgid)

Removes a Server from a group

Parameters:

sid - The server id to remove

sgid - The group id to remove the server from

lookupByCert

public static Server lookupByCert(ClientCertificate clientcert)
                           throws InvalidCertificateException

Lookup a Server with the ClientCertificate.

Parameters:

clientcert - ClientCertificate for the server wanted.

Returns:

the Server found if certificate is valid, null otherwise.

Throws:

InvalidCertificateException - thrown if certificate is invalid.

lookupByIdAndOrg

public static Server lookupByIdAndOrg(java.lang.Long id,
                                      Org orgIn)

Lookup a Server by their id

Parameters:

id - the id to search for

orgIn - Org who owns the server

Returns:

the Server found (null if not or not member if orgIn)

lookupByIdsAndUser

public static java.util.List<Server> lookupByIdsAndUser(java.util.List<java.lang.Long> serverIds,
                                                        User user)

Looks up server objects from the given list of server IDs. If more than 1000 servers are present in the list we'll split it into chunks as this can cause problems on Oracle.

Parameters:

serverIds - List of server IDs.

user - who wants to lookup the Server

Returns:

list of server objects

lookupById

public static Server lookupById(java.lang.Long id)

Lookup a Server by their id

Parameters:

id - the id to search for

Returns:

the Server found

lookupByIds

public static java.util.List<Server> lookupByIds(java.util.List<java.lang.Long> ids)

Lookup Servers by their ids

Parameters:

ids - the ids to search for

Returns:

the Servers found

lookupServerGroupTypeByLabel

public static ServerGroupType lookupServerGroupTypeByLabel(java.lang.String label)

Lookup a ServerGroupType by its label

Parameters:

label - The label to search for

Returns:

The ServerGroupType

save

public static void save(Server serverIn)

Insert or Update a Server.

Parameters:

serverIn - Server to be stored in database.

saveCustomKey

public static void saveCustomKey(CustomDataKey keyIn)

Save a custom data key

Parameters:

keyIn - the key to save

removeCustomKey

public static void removeCustomKey(CustomDataKey keyIn)

Remove a custom data key. This will also remove all systems' values for the key.

Parameters:

keyIn - the key to remove

deproxify

public static void deproxify(Server server)

Remove proxy info object associated to the server.

Parameters:

server - the server to deProxify

delete

public static void delete(Server server)

Deletes a server

Parameters:

server - The server to delete

lookupServerArchByLabel

public static ServerArch lookupServerArchByLabel(java.lang.String label)

Lookup a ServerArch by its label

Parameters:

label - The label to search for

Returns:

The ServerArch

lookupCPUArchByName

public static CPUArch lookupCPUArchByName(java.lang.String name)

Lookup a CPUArch by its name

Parameters:

name - The name to search for

Returns:

The CPUArch

compatibleWithServer

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

Returns a list of Servers which are compatible with the given server.

Parameters:

user - User owner

server - Server whose profiles we want.

Returns:

a list of Servers which are compatible with the given server.

listAdministrators

public static java.util.List<User> listAdministrators(Server server)

Returns the admins of a given server This includes

Parameters:

server - the server to find the admins of

Returns:

list of User objects that can administer the system

getServerHistory

public static java.util.List<HistoryEvent> getServerHistory(Server server)

gets a server's history sorted by creation time. This includes items from the rhnServerHistory and rhnAction* tables

Parameters:

server - the server who's history you want

Returns:

A list of ServerHistoryEvents

lookupProxiesByOrg

public static java.util.List<Server> lookupProxiesByOrg(User user)

List all proxies for a given org

Parameters:

user - the user, who's accessible proxies will be returned.

Returns:

a list of Proxy Server objects

unsubscribeFromAllChannels

public static Server unsubscribeFromAllChannels(User user,
                                                Server server)

Clear out all subscriptions for a particular server

Parameters:

user - User doing the un-subscription

server - Server that is unsubscribing

Returns:

new Server object showing all the new channel info.

listSystemsInSsm

public static java.util.List<Server> listSystemsInSsm(User user)

Returns a list of Server objects currently selected in the System Set Manager. This list will not contain servers that are proxies.

Parameters:

user - User requesting.

Returns:

List of servers.

listConfigEnabledSystems

public static java.util.List<Server> listConfigEnabledSystems()

Returns a global multi org spanning list of servers that are config enabled. Basically used by taskomatic.

Returns:

a list of config enabled systems

listConfigDiffEnabledSystems

public static java.util.List<Server> listConfigDiffEnabledSystems()

Returns a global multi org spanning list of servers that are config-diff enabled. Basically used by taskomatic.

Returns:

a list of config-diff enabled systems

listSnapshots

public static java.util.List<ServerSnapshot> listSnapshots(Org org,
                                                           Server server,
                                                           java.util.Date startDate,
                                                           java.util.Date endDate)

List snapshots associated with a server. A user may optionally provide a start and end date to narrow the snapshots that will be listed. For example, - If user provides startDate only, all snapshots created either on or after the date provided will be returned - If user provides startDate and endDate, all snapshots created on or between the dates provided will be returned - If the user doesn't provide a startDate and endDate, all snapshots associated with the server will be returned.

Parameters:

org - the org doing the request. Required.

server - the server to check for. Required.

startDate - the start date. Optional, unless endDate is provided.

endDate - the end date. Optional.

Returns:

list of ServerSnapshot objects

lookupSnapshotById

public static ServerSnapshot lookupSnapshotById(java.lang.Integer id)

Looks up a server snapshot by it's id

Parameters:

id - the snap id

Returns:

the server snapshot

lookupLatestForServer

public static ServerSnapshot lookupLatestForServer(Server server)

Looks up a latest snapshot for a sever

Parameters:

server - server

Returns:

the server snapshot

saveSnapshot

public static void saveSnapshot(ServerSnapshot snapshotIn)

Save a server snapshot

Parameters:

snapshotIn - snapshot to save

deleteSnapshot

public static void deleteSnapshot(ServerSnapshot snap)

Delete a snapshot

Parameters:

snap - the snapshot to delete

deleteSnapshots

public static void deleteSnapshots(Org org,
                                   java.util.Date startDate,
                                   java.util.Date endDate)

Delete snapshots across servers in the org. A user may optionally provide a start and end date to narrow the snapshots that will be removed. For example, - If user provides startDate only, all snapshots created either on or after the date provided will be removed - If user provides startDate and endDate, all snapshots created on or between the dates provided will be removed - If the user doesn't provide a startDate and endDate, all snapshots associated with the server will be removed.

Parameters:

org - the org doing the request. Required.

startDate - the start date. Optional, unless endDate is provided.

endDate - the end date. Optional.

deleteSnapshots

public static void deleteSnapshots(Org org,
                                   Server server,
                                   java.util.Date startDate,
                                   java.util.Date endDate)

Delete snapshots associated with a server. A user may optionally provide a start and end date to narrow the snapshots that will be removed. For example, - If user provides startDate only, all snapshots created either on or after the date provided will be removed - If user provides startDate and endDate, all snapshots created on or between the dates provided will be removed - If the user doesn't provide a startDate and endDate, all snapshots associated with the server will be removed.

Parameters:

org - the org doing the request. Required.

server - the server to check for. Required.

startDate - the start date. Optional, unless endDate is provided.

endDate - the end date. Optional.

getSnapshotTags

public static java.util.List<SnapshotTag> getSnapshotTags(ServerSnapshot snap)

get tags for a given snapshot

Parameters:

snap - the snapshot to get tags for

Returns:

list of tags

listLinuxSystems

public static java.util.List<java.lang.Long> listLinuxSystems(java.util.Collection<java.lang.Long> systemIds)

Filter out a list of systemIds with ones that are linux systems (i.e. not solaris systems)

Parameters:

systemIds - list of system ids

Returns:

list of system ids that are linux systems

addTagToSnapshot

public static void addTagToSnapshot(java.lang.Long snpId,
                                    java.lang.Long orgId,
                                    java.lang.String tagName)

Adds tag to the snapshot

Parameters:

snpId - snapshot id

orgId - org id

tagName - name of the tag

bulkAddTagToSnapshot

public static void bulkAddTagToSnapshot(java.lang.String tagName,
                                        java.lang.String setLabel,
                                        User user)

Adds tag to snapshot for systems in set

Parameters:

tagName - Name of the tag

setLabel - set to find systems in

user - User making the request

removeTagFromSnapshot

public static void removeTagFromSnapshot(java.lang.Long serverId,
                                         SnapshotTag tag)

Removes tag from system snapshot

Parameters:

serverId - server id

tag - snapshot tag

lookupSnapshotTagbyName

public static SnapshotTag lookupSnapshotTagbyName(java.lang.String tagName)

Looks up snapshot tag by tag name

Parameters:

tagName - name of the tag

Returns:

snapshot tag

lookupSnapshotTagbyId

public static SnapshotTag lookupSnapshotTagbyId(java.lang.Long tagId)

Parameters:

tagId - snapshot tag ID

Returns:

snapshot Tag

listServerSoftwareCrashes

public static java.util.List<SoftwareCrashDto> listServerSoftwareCrashes(Server server)

Lists software crashes for a server

Parameters:

server - of interest

Returns:

crash list