com.redhat.rhn.frontend.xmlrpc.system

Class XmlRpcSystemHelper

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.system.XmlRpcSystemHelper

public class XmlRpcSystemHelper
extends java.lang.Object

XmlRpcSystemHelper Helper methods specific to the xml-rpc stack. This class should not be used outside of the xml-rpc domain as it throws Xml-Rpc specific FaultExceptions.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	format(Server server) Basically creates a Minimalist representation of a server object..
static XmlRpcSystemHelper	getInstance()
Server	lookupServer(User user, java.lang.Number sid) Helper method to lookup a server from an sid, and throws a FaultException if the server cannot be found.
java.util.List<Server>	lookupServers(User user, java.util.List<? extends java.lang.Number> serverIds) Helper method to lookup a bunch of servers from a list of server ids, and throws a FaultException if the server cannot be found.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static XmlRpcSystemHelper getInstance()

Returns:

Returns the running instance of this helper class

lookupServer

public Server lookupServer(User user,
                           java.lang.Number sid)
                    throws NoSuchSystemException

Helper method to lookup a server from an sid, and throws a FaultException if the server cannot be found.

Parameters:

user - The user looking up the server

sid - The id of the server we're looking for

Returns:

Returns the server corresponding to sid

Throws:

NoSuchSystemException - A NoSuchSystemException is thrown if the server corresponding to sid cannot be found.

lookupServers

public java.util.List<Server> lookupServers(User user,
                                            java.util.List<? extends java.lang.Number> serverIds)
                                     throws NoSuchSystemException

Helper method to lookup a bunch of servers from a list of server ids, and throws a FaultException if the server cannot be found.

Parameters:

user - The user looking up the server

serverIds - The ids of the servers we're looking for

Returns:

Returns a list of server corresponding to provided server id

Throws:

NoSuchSystemException - A NoSuchSystemException is thrown if the server corresponding to sid cannot be found.

format

public java.util.Map<java.lang.String,java.lang.Object> format(Server server)

Basically creates a Minimalist representation of a server object.. This is what will be retuned in most cases when some one requests a server..

Parameters:

server - server to format

Returns:

a Map with just enough info to get details on a server