com.redhat.rhn.taskomatic

Class TaskomaticApi

java.lang.Object

com.redhat.rhn.taskomatic.TaskomaticApi

public class TaskomaticApi
extends java.lang.Object

TaskomaticApi

Constructor Summary

Constructors

Constructor and Description
TaskomaticApi()

Method Summary

Modifier and Type	Method and Description
java.util.List	findActiveSchedules(User user) Return list of active schedules
java.util.List	findRunsByBunch(User user, java.lang.String bunchName) Return list of bunch runs
java.lang.String	getRepoSyncSchedule(Channel chan, User user) Get the cron format for a single channel
boolean	isRunning() Returns whether taskomatic is running
java.util.List	listSatBunchSchedules(User user) Return list of available bunches
java.util.Map	lookupBunchByName(User user, java.lang.String bunchName) looks up bunch according to name
java.util.Map	lookupScheduleByBunchAndLabel(User user, java.lang.String bunchName, java.lang.String scheduleLabel) looks up schedule according to label
java.util.Map	lookupScheduleById(User user, java.lang.Long scheduleId) looks up schedule according to id
boolean	satScheduleActive(java.lang.String jobLabel, User user) Check whether there's an active schedule of given job label
java.util.Date	scheduleRepoSync(Channel chan, User user, java.lang.String cron) Schedule a recurring reposync
java.util.Date	scheduleRepoSync(Channel chan, User user, java.lang.String cron, java.util.Map<java.lang.String,java.lang.String> params) Schedule a recurring reposync
java.util.Date	scheduleSatBunch(User user, java.lang.String jobLabel, java.lang.String bunchName, java.lang.String cron) Creates a new schedule, unschedules, if en existing is defined
void	scheduleSingleRepoSync(Channel chan, User user) Schedule a single reposync
void	scheduleSingleRepoSync(Channel chan, User user, java.util.Map<java.lang.String,java.lang.String> params) Schedule a single reposync
java.util.Date	scheduleSingleSatBunch(User user, java.lang.String bunchName) Creates a new single satellite schedule
int	unscheduleInvalidRepoSyncSchedules(Org orgIn) unschedule all outdated repo-sync schedules within an org
void	unscheduleRepoSync(Channel chan, User user) Unchedule a reposync task
void	unscheduleSatTask(java.lang.String jobLabel, User user) unschedule satellite task

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskomaticApi

public TaskomaticApi()

Method Detail

isRunning

public boolean isRunning()

Returns whether taskomatic is running

Returns:

True if taskomatic is running

scheduleSingleRepoSync

public void scheduleSingleRepoSync(Channel chan,
                                   User user)
                            throws TaskomaticApiException

Schedule a single reposync

Parameters:

chan - the channel

user - the user

Throws:

TaskomaticApiException - if there was an error

scheduleSingleRepoSync

public void scheduleSingleRepoSync(Channel chan,
                                   User user,
                                   java.util.Map<java.lang.String,java.lang.String> params)
                            throws TaskomaticApiException

Schedule a single reposync

Parameters:

chan - the channel

user - the user

params - parameters

Throws:

TaskomaticApiException - if there was an error

scheduleRepoSync

public java.util.Date scheduleRepoSync(Channel chan,
                                       User user,
                                       java.lang.String cron)
                                throws TaskomaticApiException

Schedule a recurring reposync

Parameters:

chan - the channel

user - the user

cron - the cron format

Returns:

the Date?

Throws:

TaskomaticApiException - if there was an error

scheduleRepoSync

public java.util.Date scheduleRepoSync(Channel chan,
                                       User user,
                                       java.lang.String cron,
                                       java.util.Map<java.lang.String,java.lang.String> params)
                                throws TaskomaticApiException

Schedule a recurring reposync

Parameters:

chan - the channel

user - the user

cron - the cron format

params - parameters

Returns:

the Date?

Throws:

TaskomaticApiException - if there was an error

scheduleSingleSatBunch

public java.util.Date scheduleSingleSatBunch(User user,
                                             java.lang.String bunchName)
                                      throws TaskomaticApiException

Creates a new single satellite schedule

Parameters:

user - shall be sat admin

bunchName - bunch name

Returns:

date of the first schedule

Throws:

TaskomaticApiException - if there was an error

scheduleSatBunch

public java.util.Date scheduleSatBunch(User user,
                                       java.lang.String jobLabel,
                                       java.lang.String bunchName,
                                       java.lang.String cron)
                                throws TaskomaticApiException

Creates a new schedule, unschedules, if en existing is defined

Parameters:

user - shall be sat admin

jobLabel - name of the schedule

bunchName - bunch name

cron - cron expression

Returns:

date of the first schedule

Throws:

TaskomaticApiException - if there was an error

unscheduleRepoSync

public void unscheduleRepoSync(Channel chan,
                               User user)

Unchedule a reposync task

Parameters:

chan - the channel

user - the user

unscheduleSatTask

public void unscheduleSatTask(java.lang.String jobLabel,
                              User user)

unschedule satellite task

Parameters:

jobLabel - schedule name

user - shall be satellite admin

findActiveSchedules

public java.util.List findActiveSchedules(User user)

Return list of active schedules

Parameters:

user - shall be sat admin

Returns:

list of schedules

findRunsByBunch

public java.util.List findRunsByBunch(User user,
                                      java.lang.String bunchName)

Return list of bunch runs

Parameters:

user - shall be sat admin

bunchName - name of the bunch

Returns:

list of schedules

satScheduleActive

public boolean satScheduleActive(java.lang.String jobLabel,
                                 User user)

Check whether there's an active schedule of given job label

Parameters:

jobLabel - job label

user - the user

Returns:

true, if schedule exists

getRepoSyncSchedule

public java.lang.String getRepoSyncSchedule(Channel chan,
                                            User user)

Get the cron format for a single channel

Parameters:

chan - the channel

user - the user

Returns:

the Cron format

listSatBunchSchedules

public java.util.List listSatBunchSchedules(User user)

Return list of available bunches

Parameters:

user - shall be sat admin

Returns:

list of bunches

lookupScheduleById

public java.util.Map lookupScheduleById(User user,
                                        java.lang.Long scheduleId)

looks up schedule according to id

Parameters:

user - shall be sat admin

scheduleId - schedule id

Returns:

schedule

lookupScheduleByBunchAndLabel

public java.util.Map lookupScheduleByBunchAndLabel(User user,
                                                   java.lang.String bunchName,
                                                   java.lang.String scheduleLabel)

looks up schedule according to label

Parameters:

user - shall be sat admin

bunchName - bunch name

scheduleLabel - schedule label

Returns:

schedule

lookupBunchByName

public java.util.Map lookupBunchByName(User user,
                                       java.lang.String bunchName)

looks up bunch according to name

Parameters:

user - shall be sat admin

bunchName - bunch name

Returns:

bunch

unscheduleInvalidRepoSyncSchedules

public int unscheduleInvalidRepoSyncSchedules(Org orgIn)

unschedule all outdated repo-sync schedules within an org

Parameters:

orgIn - organization

Returns:

number of removed schedules