com.thindeck.api

Interface Deck

All Known Implementing Classes:

FkDeck

@Immutable
public interface Deck

Deck.

Deck is a configurable deployment of sources to Docker containers. Deck should be configured through exec(com.thindeck.api.Agent).

Deck is an XML document with data about the current state of the deck. A deck can contain, for example, the list of Docker containers that are running the deck at the moment.

Full description of what information a deck should (and can) include you can get from its XSD schema.

Since:

0.1

Version:

$Id$

Author:

Yegor Bugayenko (yegor@teamed.io)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Deck.Smart Smart.

Field Summary

Fields

Modifier and Type	Field and Description
static com.jcabi.xml.XSD	SCHEMA Schema.
static com.jcabi.xml.XSL	UPGRADE XSL for upgrade.

Method Summary

Methods

Modifier and Type	Method and Description
Events	events() Get events.
void	exec(Agent agent) Execute this agent.
String	name() Name, unique for the user.

Field Detail

SCHEMA

static final com.jcabi.xml.XSD SCHEMA

Schema.

UPGRADE

static final com.jcabi.xml.XSL UPGRADE

XSL for upgrade.

Method Detail

name

@NotNull(message="deck name can\'t be null")
String name()
            throws IOException

Name, unique for the user.

Returns:

Unique name of the deck

Throws:

IOException - If fails

exec

void exec(Agent agent)
          throws IOException

Execute this agent.

Parameters:

agent - The agent

Throws:

IOException - If fails

events

Events events()

Get events.

Returns:

Events