co.ecg.alpaca.toolkit.helper.device

Class ResetWatcher

java.lang.Object

co.ecg.alpaca.toolkit.task.Task

co.ecg.alpaca.toolkit.task.SingleServerTask

co.ecg.alpaca.toolkit.helper.device.ResetWatcher

All Implemented Interfaces:

Comparable<Task>

public class ResetWatcher
extends SingleServerTask

A task to reset a set of AccessDevice and monitor the associated User registrations. If the registration is updated then the User is considered to have successfully re-registered.

Author:

Matthew Keathley

Field Summary

Fields inherited from class co.ecg.alpaca.toolkit.task.SingleServerTask

broadWorksServer, log

Fields inherited from class co.ecg.alpaca.toolkit.task.Task

name, taskLog

Constructor Summary

Constructors

Constructor and Description
ResetWatcher(String name, BroadWorksServer broadWorksServer, List<User> userList) Creates a ResetWatcher with the given list of Users
ResetWatcher(String name, Group group) Creates a ResetWatcher with the given Group
ResetWatcher(String name, Group group, String userAgentVersion) Creates a ResetWatcher with the given Group
ResetWatcher(String name, User user) Creates a ResetWatcher with the given User

Method Summary

Modifier and Type	Method and Description
Completion	getTaskSpecificCompletion()
void	task() The action that the task performs

Methods inherited from class co.ecg.alpaca.toolkit.task.Task

addTaskLogListener, close, compareTo, finish, finish, getCompletion, getName, getResult, getStatus, getTaskLog, getTaskServers, isComplete, logToConsole, postLogMessage, start, stop, taskEvent, waitForResult

Methods inherited from class java.lang.Object

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

Constructor Detail

ResetWatcher

public ResetWatcher(String name,
                    BroadWorksServer broadWorksServer,
                    List<User> userList)
             throws HelperException

Creates a ResetWatcher with the given list of Users

Parameters:

broadWorksServer - The BroadWorksServer for the Watcher

userList - The list of users

Throws:

HelperException - Thrown if the UserList is null or initialization fails.

ResetWatcher

public ResetWatcher(String name,
                    Group group)
             throws HelperException

Creates a ResetWatcher with the given Group

Parameters:

group - The group to reset

Throws:

HelperException - Thrown if retrieval of data or initialization fails.

ResetWatcher

public ResetWatcher(String name,
                    Group group,
                    String userAgentVersion)
             throws HelperException

Creates a ResetWatcher with the given Group

Parameters:

group - The group to reset

Throws:

HelperException - Thrown if retrieval of data or initialization fails.

ResetWatcher

public ResetWatcher(String name,
                    User user)
             throws HelperException

Creates a ResetWatcher with the given User

Parameters:

user - The user to reset

Throws:

HelperException - Thrown if initialization fails.

Method Detail

getTaskSpecificCompletion

public Completion getTaskSpecificCompletion()

Specified by:

getTaskSpecificCompletion in class Task

task

public void task()
          throws Exception

Description copied from class: Task

The action that the task performs

Specified by:

task in class Task

Throws:

Exception