com.redhat.rhn.frontend.xmlrpc.api

Class ApiHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.api.ApiHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ApiHandler
extends BaseHandler

ApiHandler Corresponds to API.pm in old perl code.

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ApiHandler()

Method Summary

Modifier and Type	Method and Description
java.util.Map	getApiCallList(User loggedInUser) Lists all available api calls grouped by namespace
java.util.Map	getApiNamespaceCallList(User loggedInUser, java.lang.String namespace) Lists all available api calls for the specified namespace
java.util.Map	getApiNamespaces(User loggedInUser) Lists available API namespaces
java.lang.String	getVersion() Returns the api version.
java.lang.String	systemVersion() Returns the server version.

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

ApiHandler

public ApiHandler()

Method Detail

systemVersion

public java.lang.String systemVersion()

Returns the server version.

Returns:

Returns the server version.

getVersion

public java.lang.String getVersion()

Returns the api version. Called as: api.get_version

Returns:

the api version.

getApiNamespaces

public java.util.Map getApiNamespaces(User loggedInUser)

Lists available API namespaces

Parameters:

loggedInUser - The current user

Returns:

map of API namespaces

getApiCallList

public java.util.Map getApiCallList(User loggedInUser)

Lists all available api calls grouped by namespace

Parameters:

loggedInUser - The current user

Returns:

a map containing list of api calls for every namespace

getApiNamespaceCallList

public java.util.Map getApiNamespaceCallList(User loggedInUser,
                                             java.lang.String namespace)
                                      throws java.lang.ClassNotFoundException

Lists all available api calls for the specified namespace

Parameters:

loggedInUser - The current user

namespace - namespace of interest

Returns:

a map containing list of api calls for every namespace

Throws:

java.lang.ClassNotFoundException - if namespace isn't valid