com.redhat.rhn.frontend.xmlrpc.system.custominfo

Class CustomInfoHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.system.custominfo.CustomInfoHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class CustomInfoHandler
extends BaseHandler

CustomInfoHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
CustomInfoHandler()

Method Summary

Modifier and Type	Method and Description
int	createKey(User loggedInUser, java.lang.String keyLabel, java.lang.String keyDescription) Create a new custom key
int	deleteKey(User loggedInUser, java.lang.String keyLabel) Delete an existing custom key
java.lang.Object[]	listAllKeys(User loggedInUser) List the custom information keys defined for the user's organization.
int	updateKey(User loggedInUser, java.lang.String keyLabel, java.lang.String keyDescription) Update description of a custom key

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

CustomInfoHandler

public CustomInfoHandler()

Method Detail

createKey

public int createKey(User loggedInUser,
                     java.lang.String keyLabel,
                     java.lang.String keyDescription)
              throws FaultException

Create a new custom key

Parameters:

loggedInUser - The current user

keyLabel - string

keyDescription - string

Returns:

1 on success, 0 on failure

Throws:

FaultException - A FaultException is thrown if: - Either the label or description is not provided - Any error occurs

updateKey

public int updateKey(User loggedInUser,
                     java.lang.String keyLabel,
                     java.lang.String keyDescription)
              throws FaultException

Update description of a custom key

Parameters:

loggedInUser - The current user

keyLabel - string

keyDescription - string

Returns:

1 on success, 0 on failure

Throws:

FaultException - A FaultException is thrown if a key doesn't exist or an iinvalid description is provided

deleteKey

public int deleteKey(User loggedInUser,
                     java.lang.String keyLabel)
              throws FaultException

Delete an existing custom key

Parameters:

loggedInUser - The current user

keyLabel - string

Returns:

1 on success, exception thrown otherwise

Throws:

FaultException - A FaultException is thrown if: - Either the label or description is not provided - Any error occurs

listAllKeys

public java.lang.Object[] listAllKeys(User loggedInUser)
                               throws FaultException

List the custom information keys defined for the user's organization.

Parameters:

loggedInUser - The current user

Returns:

list of inactive systems

Throws:

FaultException - A FaultException is thrown on error.