com.redhat.rhn.frontend.xmlrpc.channel.access

Class ChannelAccessHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.channel.access.ChannelAccessHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ChannelAccessHandler
extends BaseHandler

ChannelAccessHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ChannelAccessHandler()

Method Summary

Modifier and Type	Method and Description
int	disableUserRestrictions(User loggedInUser, java.lang.String channelLabel) Disable user restrictions for the given channel.
int	enableUserRestrictions(User loggedInUser, java.lang.String channelLabel) Enable user restrictions for the given channel.
java.lang.String	getOrgSharing(User loggedInUser, java.lang.String channelLabel) Get organization sharing access control.
int	setOrgSharing(User loggedInUser, java.lang.String channelLabel, java.lang.String access) Set organization sharing access control.

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

ChannelAccessHandler

public ChannelAccessHandler()

Method Detail

enableUserRestrictions

public int enableUserRestrictions(User loggedInUser,
                                  java.lang.String channelLabel)
                           throws FaultException

Enable user restrictions for the given channel. If enabled, only selected users within the organization may subscribe to the channel.

Parameters:

loggedInUser - The current user

channelLabel - The label for the channel to change

Returns:

Returns 1 if successful, exception otherwise

Throws:

FaultException - A FaultException is thrown if: - The sessionkey is invalid - The channel label is invalid - The user doesn't have channel admin permissions

disableUserRestrictions

public int disableUserRestrictions(User loggedInUser,
                                   java.lang.String channelLabel)
                            throws FaultException

Disable user restrictions for the given channel. If disabled, all users within the organization may subscribe to the channel.

Parameters:

loggedInUser - The current user

channelLabel - The label for the channel to change

Returns:

Returns 1 if successful, exception otherwise

Throws:

FaultException - A FaultException is thrown if: - The sessionkey is invalid - The channel label is invalid - The user doesn't have channel admin permissions

setOrgSharing

public int setOrgSharing(User loggedInUser,
                         java.lang.String channelLabel,
                         java.lang.String access)
                  throws FaultException

Set organization sharing access control.

Parameters:

loggedInUser - The current user

channelLabel - The label for the channel to change

access - The access value to set. (Must be one of the following: "public", "private" or "protected")

Returns:

Returns 1 if successful, exception otherwise

Throws:

FaultException - A FaultException is thrown if: - The sessionKey is invalid - The channelLabel is invalid - The access is invalid - The user doesn't have channel admin permissions

getOrgSharing

public java.lang.String getOrgSharing(User loggedInUser,
                                      java.lang.String channelLabel)
                               throws FaultException

Get organization sharing access control.

Parameters:

loggedInUser - The current user

channelLabel - The label for the channel

Returns:

The access value

Throws:

FaultException - A FaultException is thrown if: - The sessionKey is invalid - The channelLabel is invalid - The access is invalid - The user doesn't have channel admin permissions