com.redhat.rhn.frontend.xmlrpc.configchannel

Class ConfigChannelHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.configchannel.ConfigChannelHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class ConfigChannelHandler
extends BaseHandler

ConfigHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
ConfigChannelHandler()

Method Summary

Modifier and Type	Method and Description
int	channelExists(User loggedInUser, java.lang.String channelLabel) Check for the existence of the config channel provided.
ConfigChannel	create(User loggedInUser, java.lang.String label, java.lang.String name, java.lang.String description) Creates a new global config channel based on the values provided..
ConfigRevision	createOrUpdatePath(User loggedInUser, java.lang.String channelLabel, java.lang.String path, boolean isDir, java.util.Map<java.lang.String,java.lang.Object> data) Creates a NEW path(file/directory) with the given path or updates an existing path with the given contents in a given channel.
ConfigRevision	createOrUpdateSymlink(User loggedInUser, java.lang.String channelLabel, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> data) Creates a NEW symbolic link with the given path or updates an existing path with the given target_path in a given channel.
int	deleteChannels(User loggedInUser, java.util.List<java.lang.String> channelLabels) Deletes a list of global channels..
int	deleteFileRevisions(User loggedInUser, java.lang.String configChannelLabel, java.lang.String filePath, java.util.List<java.lang.Integer> revisions) Delete specified revisions of a given configuration file
int	deleteFiles(User loggedInUser, java.lang.String channelLabel, java.util.List<java.lang.String> paths) Removes a list of paths from a global channel..
int	deployAllSystems(User loggedInUser, java.lang.String channelLabel) Schedule a configuration deployment for all systems in a config channel immediately
int	deployAllSystems(User loggedInUser, java.lang.String channelLabel, java.util.Date date) Schedule a configuration deployment for all systems in a config channel
int	deployAllSystems(User loggedInUser, java.lang.String channelLabel, java.lang.String filePath)
int	deployAllSystems(User loggedInUser, java.lang.String channelLabel, java.lang.String filePath, java.util.Date date)
ConfigChannel	getDetails(User loggedInUser, java.lang.Integer configChannelId) Return a struct of config channel details.
ConfigChannel	getDetails(User loggedInUser, java.lang.String configChannelLabel) Return a struct of config channel details.
EncodedConfigRevision	getEncodedFileRevision(User loggedInUser, java.lang.String configChannelLabel, java.lang.String filePath, java.lang.Integer revision) Get base64 encoded revision for specified config file
ConfigRevision	getFileRevision(User loggedInUser, java.lang.String configChannelLabel, java.lang.String filePath, java.lang.Integer revision) Get revision for specified config file
java.util.List	getFileRevisions(User loggedInUser, java.lang.String configChannelLabel, java.lang.String filePath) Get list of revisions for specified config file
java.util.List<ConfigFileDto>	listFiles(User loggedInUser, java.lang.String channelLabel) List files in a given channel
java.util.List<ConfigChannelDto>	listGlobals(User loggedInUser) List all the global channels accessible to the logged-in user
java.util.List<ConfigSystemDto>	listSubscribedSystems(User loggedInUser, java.lang.String channelLabel) List the systems subscribed to a configuration channel
java.util.List<ConfigChannel>	lookupChannelInfo(User loggedInUser, java.util.List<java.lang.String> labels) Lists details on a list channels given their channel labels.
java.util.List<ConfigRevision>	lookupFileInfo(User loggedInUser, java.lang.String channelLabel, java.util.List<java.lang.String> paths) Given a list of paths and a channel the method returns details about the latest revisions of the paths.
ConfigRevision	lookupFileInfo(User loggedInUser, java.lang.String channelLabel, java.lang.String path, java.lang.Integer revision) Given a path and revision number, return the revision
java.lang.Integer	scheduleFileComparisons(User loggedInUser, java.lang.String channelLabel, java.lang.String path, java.util.List<java.lang.Integer> serverIds) Schedule a comparison of the latest revision of a file against the version deployed on a list of systems.
ConfigChannel	update(User loggedInUser, java.lang.String label, java.lang.String name, java.lang.String description) Updates a global config channel based on the values provided..

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

ConfigChannelHandler

public ConfigChannelHandler()

Method Detail

create

public ConfigChannel create(User loggedInUser,
                            java.lang.String label,
                            java.lang.String name,
                            java.lang.String description)

Creates a new global config channel based on the values provided..

Parameters:

loggedInUser - The current user

label - label of the config channel

name - name of the config channel

description - description of the config channel

Returns:

the newly created config channel

deleteFileRevisions

public int deleteFileRevisions(User loggedInUser,
                               java.lang.String configChannelLabel,
                               java.lang.String filePath,
                               java.util.List<java.lang.Integer> revisions)

Delete specified revisions of a given configuration file

Parameters:

loggedInUser - The current user

configChannelLabel - Config channel label.

filePath - The configuration file path.

revisions - List of configuration file revisions to delete.

Returns:

1 if deletion succeeds, errors out otherwise.

getFileRevisions

public java.util.List getFileRevisions(User loggedInUser,
                                       java.lang.String configChannelLabel,
                                       java.lang.String filePath)

Get list of revisions for specified config file

Parameters:

loggedInUser - The current user

configChannelLabel - Config channel label.

filePath - The configuration file path.

Returns:

List of revisions of the configuration file, errors out otherwise.

getFileRevision

public ConfigRevision getFileRevision(User loggedInUser,
                                      java.lang.String configChannelLabel,
                                      java.lang.String filePath,
                                      java.lang.Integer revision)

Get revision for specified config file

Parameters:

loggedInUser - The current user

configChannelLabel - Config channel label.

filePath - The configuration file path.

revision - The configuration file revision.

Returns:

Revisions of the configuration file, errors out otherwise.

getEncodedFileRevision

public EncodedConfigRevision getEncodedFileRevision(User loggedInUser,
                                                    java.lang.String configChannelLabel,
                                                    java.lang.String filePath,
                                                    java.lang.Integer revision)

Get base64 encoded revision for specified config file

Parameters:

loggedInUser - The current user

configChannelLabel - Config channel label.

filePath - The configuration file path.

revision - The configuration file revision.

Returns:

Revisions of the configuration file, errors out otherwise.

getDetails

public ConfigChannel getDetails(User loggedInUser,
                                java.lang.String configChannelLabel)

Return a struct of config channel details.

Parameters:

loggedInUser - The current user

configChannelLabel - Config channel label.

Returns:

the Config channel details

getDetails

public ConfigChannel getDetails(User loggedInUser,
                                java.lang.Integer configChannelId)

Return a struct of config channel details.

Parameters:

loggedInUser - The current user

configChannelId - Config channel ID.

Returns:

the Config channel details

update

public ConfigChannel update(User loggedInUser,
                            java.lang.String label,
                            java.lang.String name,
                            java.lang.String description)

Updates a global config channel based on the values provided..

Parameters:

loggedInUser - The current user

label - label of the config channel

name - name of the config channel

description - description of the config channel

Returns:

the newly created config channel

lookupChannelInfo

public java.util.List<ConfigChannel> lookupChannelInfo(User loggedInUser,
                                                       java.util.List<java.lang.String> labels)

Lists details on a list channels given their channel labels.

Parameters:

loggedInUser - The current user

labels - the list of channel labels to lookup on

Returns:

a list of config channels.

listGlobals

public java.util.List<ConfigChannelDto> listGlobals(User loggedInUser)

List all the global channels accessible to the logged-in user

Parameters:

loggedInUser - The current user

Returns:

a list of accessible global config channels

createOrUpdatePath

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

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

Parameters:

loggedInUser - The current user

channelLabel - the label of the config channel.

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

Returns:

returns the new created or updated config revision..

Since:

10.2

createOrUpdateSymlink

public ConfigRevision createOrUpdateSymlink(User loggedInUser,
                                            java.lang.String channelLabel,
                                            java.lang.String path,
                                            java.util.Map<java.lang.String,java.lang.Object> data)

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

Parameters:

loggedInUser - The current user

channelLabel - the label of the config channel.

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

Returns:

returns the new created or updated config revision..

Since:

10.2

lookupFileInfo

public java.util.List<ConfigRevision> lookupFileInfo(User loggedInUser,
                                                     java.lang.String channelLabel,
                                                     java.util.List<java.lang.String> paths)

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

Parameters:

loggedInUser - The current user

channelLabel - the channel label

paths - a list of paths to examine.

Returns:

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

Since:

10.2

lookupFileInfo

public ConfigRevision lookupFileInfo(User loggedInUser,
                                     java.lang.String channelLabel,
                                     java.lang.String path,
                                     java.lang.Integer revision)

Given a path and revision number, return the revision

Parameters:

loggedInUser - The current user

channelLabel - the channel label

path - path to examine.

revision - the revision to fetch

Returns:

the specified config revision of the requested path.

Since:

10.12

listFiles

public java.util.List<ConfigFileDto> listFiles(User loggedInUser,
                                               java.lang.String channelLabel)

List files in a given channel

Parameters:

loggedInUser - The current user

channelLabel - the label of the config channel

Returns:

a list of dto's holding this info.

deleteChannels

public int deleteChannels(User loggedInUser,
                          java.util.List<java.lang.String> channelLabels)

Deletes a list of global channels.. Need to be a config admin to do this operation.

Parameters:

loggedInUser - The current user key

channelLabels - the the list of global channels.

Returns:

1 if successful with the operation errors out otherwise.

deleteFiles

public int deleteFiles(User loggedInUser,
                       java.lang.String channelLabel,
                       java.util.List<java.lang.String> paths)

Removes a list of paths from a global channel..

Parameters:

loggedInUser - The current user

channelLabel - the channel to remove the files from..

paths - the list of paths to delete.

Returns:

1 if successful with the operation errors out otherwise.

scheduleFileComparisons

public java.lang.Integer scheduleFileComparisons(User loggedInUser,
                                                 java.lang.String channelLabel,
                                                 java.lang.String path,
                                                 java.util.List<java.lang.Integer> serverIds)

Schedule a comparison of the latest revision of a file against the version deployed on a list of systems.

Parameters:

loggedInUser - The current user

channelLabel - label of the config channel

path - the path of file to be compared

serverIds - the list of server ids that the comparison will be performed on

Returns:

the id of the action scheduled

channelExists

public int channelExists(User loggedInUser,
                         java.lang.String channelLabel)

Check for the existence of the config channel provided.

Parameters:

loggedInUser - The current user

channelLabel - the channel to check for.

Returns:

1 if exists, 0 otherwise.

deployAllSystems

public int deployAllSystems(User loggedInUser,
                            java.lang.String channelLabel)

Schedule a configuration deployment for all systems in a config channel immediately

Parameters:

loggedInUser - The current user

channelLabel - the channel to remove the files from..

Returns:

1 if successful with the operation errors out otherwise.

deployAllSystems

public int deployAllSystems(User loggedInUser,
                            java.lang.String channelLabel,
                            java.util.Date date)

Schedule a configuration deployment for all systems in a config channel

Parameters:

loggedInUser - The current user

channelLabel - the channel to remove the files from..

date - the date to schedule

Returns:

1 if successful with the operation errors out otherwise.

deployAllSystems

public int deployAllSystems(User loggedInUser,
                            java.lang.String channelLabel,
                            java.lang.String filePath)

Parameters:

loggedInUser - The current user

channelLabel - the channel to deploy the files from..

filePath - config file path

Returns:

1 if successful with the operation errors out otherwise.

deployAllSystems

public int deployAllSystems(User loggedInUser,
                            java.lang.String channelLabel,
                            java.lang.String filePath,
                            java.util.Date date)

Parameters:

loggedInUser - The current user

channelLabel - the channel to deploy the files from..

filePath - config file path

date - the date to schedule

Returns:

1 if successful with the operation errors out otherwise.

listSubscribedSystems

public java.util.List<ConfigSystemDto> listSubscribedSystems(User loggedInUser,
                                                             java.lang.String channelLabel)

List the systems subscribed to a configuration channel

Parameters:

loggedInUser - The current user

channelLabel - the label of the config channel

Returns:

a list of dto's holding this info.