com.spotify.helios.agent

Interface AgentModel

All Known Implementing Classes:

ZooKeeperAgentModel

public interface AgentModel

Models the desired state of a host as provided by masters and provides a way for an agent to indicate its current state.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AgentModel.Listener A listener for changes to the set of tasks.

Method Summary

Modifier and Type	Method and Description
void	addListener(AgentModel.Listener listener) Add a listener for changes to the set of tasks.
Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.Task>	getTasks() Get a map of tasks.
com.spotify.helios.common.descriptors.TaskStatus	getTaskStatus(com.spotify.helios.common.descriptors.JobId jobId) Get registered task status.
Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.TaskStatus>	getTaskStatuses() Get a map of the task statuses.
void	removeListener(AgentModel.Listener listener) Remove a listener.
void	removeTaskStatus(com.spotify.helios.common.descriptors.JobId jobId) Remove a task status.
void	setTaskStatus(com.spotify.helios.common.descriptors.JobId jobId, com.spotify.helios.common.descriptors.TaskStatus status) Register task status.

Method Detail

getTasks

Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.Task> getTasks()

Get a map of tasks.

Returns:

A map of job id's to tasks.

getTaskStatuses

Map<com.spotify.helios.common.descriptors.JobId,com.spotify.helios.common.descriptors.TaskStatus> getTaskStatuses()

Get a map of the task statuses.

Returns:

A map of job ids to task statuses.

setTaskStatus

void setTaskStatus(com.spotify.helios.common.descriptors.JobId jobId,
                   com.spotify.helios.common.descriptors.TaskStatus status)
            throws InterruptedException

Register task status.

Parameters:

jobId - The job ID.

status - The job state.

Throws:

InterruptedException - If the thread is interrupted.

getTaskStatus

com.spotify.helios.common.descriptors.TaskStatus getTaskStatus(com.spotify.helios.common.descriptors.JobId jobId)

Get registered task status.

Parameters:

jobId - The job ID.

Returns:

The job state.

removeTaskStatus

void removeTaskStatus(com.spotify.helios.common.descriptors.JobId jobId)
               throws InterruptedException

Remove a task status.

Parameters:

jobId - The job id.

Throws:

InterruptedException - If the thread is interrupted.

addListener

void addListener(AgentModel.Listener listener)

Add a listener for changes to the set of tasks.

Parameters:

listener - A listener that will be called when the set of tasks changes.

See Also:

AgentModel.Listener

removeListener

void removeListener(AgentModel.Listener listener)

Remove a listener.

Parameters:

listener - The listener to remove.

See Also:

addListener(Listener)