com.redhat.rhn.frontend.xmlrpc.system.config

Class ServerConfigHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.system.config.ServerConfigHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ServerConfigHandler
extends BaseHandler

ServerConfigChannelHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ServerConfigHandler()

Method Summary

Modifier and Type	Method and Description
int	addChannels(User loggedInUser, java.util.List<java.lang.Number> serverIds, java.util.List<java.lang.String> configChannelLabels, boolean addToTop) Given a list of servers and configuration channels, this method inserts the configuration channels to either the top or the bottom (whichever you specify) of a system's subscribed configuration channels list.
ConfigRevision	createOrUpdatePath(User loggedInUser, java.lang.Integer sid, java.lang.String path, boolean isDir, java.util.Map<java.lang.String,java.lang.Object> data, boolean commitToLocal) Creates a NEW path(file/directory) with the given path or updates an existing path with the given contents in a given server.
ConfigRevision	createOrUpdateSymlink(User loggedInUser, java.lang.Integer sid, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> data, boolean commitToLocal) Creates a NEW symbolic link with the given path or updates an existing path with the given target_path in a given server.
int	deleteFiles(User loggedInUser, java.lang.Integer sid, java.util.List<java.lang.String> paths, boolean deleteFromLocal) Removes a list of paths from a local or sandbox channel of a server..
int	deployAll(User loggedInUser, java.util.List<java.lang.Number> serverIds, java.util.Date date) Schedules a deploy action for all the configuration files of a given list of servers.
java.util.List<ConfigChannel>	listChannels(User loggedInUser, java.lang.Integer sid) List all the global channels associated to a system in the order of their ranking.
java.util.List<ConfigFileNameDto>	listFiles(User loggedInUser, java.lang.Integer sid, boolean listLocal) List files in a given server
java.util.List<ConfigRevision>	lookupFileInfo(User loggedInUser, java.lang.Integer sid, java.util.List<java.lang.String> paths, boolean searchLocal) Given a list of paths and a server the method returns details about the latest revisions of the paths.
int	removeChannels(User loggedInUser, java.util.List<java.lang.Number> serverIds, java.util.List<java.lang.String> configChannelLabels) removes selected channels from list of config channels provided for a given list of servers.
int	setChannels(User loggedInUser, java.util.List<java.lang.Number> serverIds, java.util.List<java.lang.String> configChannelLabels) replaces the existing set of config channels for a given list of servers.

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

ServerConfigHandler

public ServerConfigHandler()

Method Detail

listFiles

public java.util.List<ConfigFileNameDto> listFiles(User loggedInUser,
                                                   java.lang.Integer sid,
                                                   boolean listLocal)

List files in a given server

Parameters:

loggedInUser - The current user

sid - the server id

listLocal - true if a list of paths in local override is desired false if list of paths in sandbox channel is desired

Returns:

a list of dto's holding this info.

createOrUpdatePath

public ConfigRevision createOrUpdatePath(User loggedInUser,
                                         java.lang.Integer sid,
                                         java.lang.String path,
                                         boolean isDir,
                                         java.util.Map<java.lang.String,java.lang.Object> data,
                                         boolean commitToLocal)

Creates a NEW path(file/directory) with the given path or updates an existing path with the given contents in a given server.

Parameters:

loggedInUser - The current user

sid - the server id.

path - the path of the given text file.

isDir - true if this is a directory path, false if its to be a file path

data - a map containing properties pertaining to the given path.. for directory paths - 'data' will hold values for -> owner, group, permissions for file paths - 'data' will hold values for-> contents, owner, group, permissions, macro-start-delimiter, macro-end-delimiter

commitToLocal - true if we want to commit the file to the server's local channel false if we want to commit it to sandbox.

Returns:

returns the new created or updated config revision..

Since:

10.2

createOrUpdateSymlink

public ConfigRevision createOrUpdateSymlink(User loggedInUser,
                                            java.lang.Integer sid,
                                            java.lang.String path,
                                            java.util.Map<java.lang.String,java.lang.Object> data,
                                            boolean commitToLocal)

Creates a NEW symbolic link with the given path or updates an existing path with the given target_path in a given server.

Parameters:

loggedInUser - The current user

sid - the server id.

path - the path of the given text file.

data - a map containing properties pertaining to the given path.. 'data' will hold values for -> target_paths, selinux_ctx

commitToLocal - true if we want to commit the file to the server's local channel false if we want to commit it to sandbox.

Returns:

returns the new created or updated config revision..

Since:

10.2

lookupFileInfo

public java.util.List<ConfigRevision> lookupFileInfo(User loggedInUser,
                                                     java.lang.Integer sid,
                                                     java.util.List<java.lang.String> paths,
                                                     boolean searchLocal)

Given a list of paths and a server the method returns details about the latest revisions of the paths.

Parameters:

loggedInUser - The current user

sid - the server id

paths - a list of paths to examine.

searchLocal - true look at local overrides, false to look at sandbox overrides

Returns:

a list containing the latest config revisions of the requested paths.

Since:

10.2

deleteFiles

public int deleteFiles(User loggedInUser,
                       java.lang.Integer sid,
                       java.util.List<java.lang.String> paths,
                       boolean deleteFromLocal)

Removes a list of paths from a local or sandbox channel of a server..

Parameters:

loggedInUser - The current user

sid - the server id to remove the files from..

paths - the list of paths to delete.

deleteFromLocal - true if we want to delete form local channel false if we want to delete from sandbox..

Returns:

1 if successful with the operation errors out otherwise.

deployAll

public int deployAll(User loggedInUser,
                     java.util.List<java.lang.Number> serverIds,
                     java.util.Date date)

Schedules a deploy action for all the configuration files of a given list of servers.

Parameters:

loggedInUser - The current user

serverIds - list of IDs of the server to schedule the deploy action

date - date of the deploy action..

Returns:

1 on success, raises exceptions otherwise.

listChannels

public java.util.List<ConfigChannel> listChannels(User loggedInUser,
                                                  java.lang.Integer sid)

List all the global channels associated to a system in the order of their ranking.

Parameters:

loggedInUser - The current user

sid - a system id

Returns:

a list of global config channels associated to the given system in the order of their ranking..

addChannels

public int addChannels(User loggedInUser,
                       java.util.List<java.lang.Number> serverIds,
                       java.util.List<java.lang.String> configChannelLabels,
                       boolean addToTop)

Given a list of servers and configuration channels, this method inserts the configuration channels to either the top or the bottom (whichever you specify) of a system's subscribed configuration channels list. The ordering of the configuration channels provided in the add list is maintained while adding. If one of the configuration channels in the 'add' list has been previously subscribed by a server, the subscribed channel will be re-ranked to the appropriate place.

Parameters:

loggedInUser - The current user

serverIds - a list of ids of servers to add the configuration channels to.

configChannelLabels - set of configuration channels labels

addToTop - if true inserts the configuration channels list to the top of the configuration channels list of a server

Returns:

1 on success 0 on failure

setChannels

public int setChannels(User loggedInUser,
                       java.util.List<java.lang.Number> serverIds,
                       java.util.List<java.lang.String> configChannelLabels)

replaces the existing set of config channels for a given list of servers. Note: it ranks these channels according to the array order of configChannelLabels method parameter

Parameters:

loggedInUser - The current user

serverIds - a list of ids of servers to change the config files for..

configChannelLabels - sets channels labels

Returns:

1 on success 0 on failure

removeChannels

public int removeChannels(User loggedInUser,
                          java.util.List<java.lang.Number> serverIds,
                          java.util.List<java.lang.String> configChannelLabels)

removes selected channels from list of config channels provided for a given list of servers.

Parameters:

loggedInUser - The current user

serverIds - the list of server ids.

configChannelLabels - sets channels labels

Returns:

1 on success 0 on failure