com.redhat.rhn.frontend.xmlrpc

Class BaseHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

Direct Known Subclasses:

ActionChainHandler, ActivationKeyHandler, ApiHandler, AuthHandler, ChannelAccessHandler, ChannelHandler, ChannelOrgHandler, ChannelSoftwareHandler, ConfigChannelHandler, CrashHandler, CryptoKeysHandler, CustomInfoHandler, DistChannelHandler, ErrataHandler, FilePreservationListHandler, KeysHandler, KickstartHandler, KickstartTreeHandler, MasterHandler, OrgHandler, OrgTrustHandler, PackagesHandler, PackagesProviderHandler, PackagesSearchHandler, PreferencesLocaleHandler, ProfileHandler, ProxyHandler, RegistrationHandler, SatelliteHandler, ScheduleHandler, ServerConfigHandler, ServerGroupHandler, SlaveHandler, SnapshotHandler, SnippetHandler, SoftwareHandler, SystemDetailsHandler, SystemHandler, SystemScapHandler, SystemSearchHandler, TaskomaticHandler, TestHandler, UnitTestHandler, UserExternalHandler, UserHandler

public class BaseHandler
extends java.lang.Object
implements redstone.xmlrpc.XmlRpcInvocationHandler

A basic xmlrpc handler class. Uses reflection + an arbitrary algorithm to call the appropriate method on a subclass. So, an xmlrpc call to 'registration.privacy_message' might call RegistrationHandler.privacyMessage

Field Summary

Fields

Modifier and Type	Field and Description
static int	VALID

Constructor Summary

Constructors

Constructor and Description
BaseHandler()

Method Summary

Modifier and Type	Method and Description
static void	ensureConfigAdmin(User user) Private helper method to make sure a user has config admin role.
static void	ensureOrgAdmin(User user) Private helper method to make sure a user has org admin role.
static void	ensureOrgOrConfigAdmin(User user) Public helper method to make sure a user has either an org admin or a config admin role If not, this will throw a generic Permission exception.
static void	ensureSatAdmin(User user) Private helper method to make sure a user has sat admin role.
static void	ensureSystemGroupAdmin(User user) Private helper method to make sure a user has system group admin role.
static void	ensureUserRole(User user, Role role) Private helper method to make sure a user the given role..
static User	getLoggedInUser(java.lang.String sessionKey) Gets the currently logged in user.
java.lang.Object	invoke(java.lang.String methodCalled, java.util.List params) called by BaseHandler.doPost, contains the code that determines what method to call of a subclassed-object
protected boolean	providesAuthentication()
protected void	setEntityAttribute(java.lang.String attrName, java.lang.Object entity, java.lang.Object value) Take an attributeName and value, and apply them to an Object.
protected Server	validateClientCertificate(java.lang.String clientCert)
protected void	validateEntitlements(java.util.List<Entitlement> entitlements) Validate that specified entitlement names correspond to real entitlements that can be changed via API (in other words, they are not permanent).
protected void	validateMap(java.util.Set<java.lang.String> validKeys, java.util.Map map) Validate that the keys provided in the map provided by the user are valid.
protected Org	verifyOrgExists(java.lang.Number orgId) Ensure the org exists

Methods inherited from class java.lang.Object

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

Field Detail

VALID

public static final int VALID

See Also:

Constant Field Values

Constructor Detail

BaseHandler

public BaseHandler()

Method Detail

providesAuthentication

protected boolean providesAuthentication()

invoke

public java.lang.Object invoke(java.lang.String methodCalled,
                               java.util.List params)
                        throws redstone.xmlrpc.XmlRpcFault

called by BaseHandler.doPost, contains the code that determines what method to call of a subclassed-object

Specified by:

invoke in interface redstone.xmlrpc.XmlRpcInvocationHandler

Parameters:

methodCalled - the xmlrpc function called, like 'registration.privacy_statement'

params - a Vector of the parameters to methodCalled

Returns:

the results of the method of the subclass

Throws:

redstone.xmlrpc.XmlRpcFault - if some error occurs

getLoggedInUser

public static User getLoggedInUser(java.lang.String sessionKey)

Gets the currently logged in user. This is all done through the sessionkey we send the user in AuthHandler.login.

Parameters:

sessionKey - The key containing the session id that we can use to load the session.

Returns:

Returns the user logged into the session corresponding to the given sessionkey.

ensureOrgAdmin

public static void ensureOrgAdmin(User user)
                           throws PermissionCheckFailureException

Private helper method to make sure a user has org admin role. If not, this will throw a generic Permission exception.

Parameters:

user - The user to check

Throws:

PermissionCheckFailureException - if user is not an org admin

ensureSatAdmin

public static void ensureSatAdmin(User user)
                           throws PermissionCheckFailureException

Private helper method to make sure a user has sat admin role. If not, this will throw a generic Permission exception.

Parameters:

user - The user to check

Throws:

PermissionCheckFailureException - if user is not an sat admin

ensureSystemGroupAdmin

public static void ensureSystemGroupAdmin(User user)
                                   throws PermissionCheckFailureException

Private helper method to make sure a user has system group admin role. If not, this will throw a generic Permission exception.

Parameters:

user - The user to check

Throws:

PermissionCheckFailureException - if user is not a system group admin

ensureConfigAdmin

public static void ensureConfigAdmin(User user)
                              throws PermissionCheckFailureException

Private helper method to make sure a user has config admin role. If not, this will throw a generic Permission exception.

Parameters:

user - The user to check

Throws:

PermissionCheckFailureException - if user is not a config admin.

ensureOrgOrConfigAdmin

public static void ensureOrgOrConfigAdmin(User user)
                                   throws PermissionCheckFailureException

Public helper method to make sure a user has either an org admin or a config admin role If not, this will throw a generic Permission exception.

Parameters:

user - The user to check

Throws:

PermissionCheckFailureException - if user is neither org nor config admin.

ensureUserRole

public static void ensureUserRole(User user,
                                  Role role)
                           throws PermissionCheckFailureException

Private helper method to make sure a user the given role.. If not, this will throw a generic Permission exception.

Parameters:

user - The user to check

role - the role to check

Throws:

PermissionCheckFailureException - if user does not have the given role

verifyOrgExists

protected Org verifyOrgExists(java.lang.Number orgId)

Ensure the org exists

Parameters:

orgId - the org id to check

Returns:

the org

validateEntitlements

protected void validateEntitlements(java.util.List<Entitlement> entitlements)

Validate that specified entitlement names correspond to real entitlements that can be changed via API (in other words, they are not permanent).

Parameters:

entitlements - List of string entitlement labels to be validated.

validateMap

protected void validateMap(java.util.Set<java.lang.String> validKeys,
                           java.util.Map map)

Validate that the keys provided in the map provided by the user are valid.

Parameters:

validKeys - Set of keys that are valid for this request

map - The map to validate

setEntityAttribute

protected void setEntityAttribute(java.lang.String attrName,
                                  java.lang.Object entity,
                                  java.lang.Object value)

Take an attributeName and value, and apply them to an Object. Takes advantage of introspection and bean-stds to decide what call to make

Parameters:

attrName - Attribute to set - assumes entity.set<Attrname>(value) exists

entity - The Object we are updating

value - The new value to pass to set<AttrName>

validateClientCertificate

protected Server validateClientCertificate(java.lang.String clientCert)