mn.foreman.api.endpoints.pickaxe

Class PickaxeImpl

java.lang.Object

mn.foreman.api.endpoints.pickaxe.PickaxeImpl

All Implemented Interfaces:

Pickaxe

public class PickaxeImpl
extends Object
implements Pickaxe

A simple Pickaxe implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface mn.foreman.api.endpoints.pickaxe.Pickaxe

Pickaxe.CancelledCommands, Pickaxe.InfrastructureConfig, Pickaxe.InfrastructureStats, Pickaxe.MinerConfig, Pickaxe.PickaxeConfiguration, Pickaxe.PickaxeInstance

Constructor Summary

Constructors

Constructor and Description
PickaxeImpl(String clientId, String pickaxeId, com.fasterxml.jackson.databind.ObjectMapper objectMapper, WebUtil webUtil) Constructor.

Method Summary

Modifier and Type	Method and Description
List<Pickaxe.PickaxeInstance>	all() Returns all of the pickaxes.
Optional<List<String>>	cancelCommands() Cancels all of the pending or in-progress commands on this Pickaxe.
Optional<CommandDone.Response>	commandDone(CommandDone done, String commandId) Sends a command completion to the Foreman API.
Optional<CommandDoneBatch.Response>	commandDoneBatch(CommandDoneBatch done) Sends command completions to the Foreman API.
Optional<CommandStart.Response>	commandStarted(CommandStart start) Sends a command started to the Foreman API.
Optional<CommandStartBatch.Response>	commandStartedBatch(CommandStartBatch start) Sends command starts to the Foreman API.
Optional<CommandUpdate.Response>	commandUpdate(CommandUpdate update, String commandId) Sends a command update to the Foreman API.
Optional<CommandUpdateBatch.Response>	commandUpdateBatch(CommandUpdateBatch update) Sends command updates to the Foreman API.
Optional<Pickaxe.PickaxeConfiguration>	config() Obtains the configuration.
Optional<Commands>	getCommands() Queries for pending commands to be executed.
Optional<List<Pickaxe.InfrastructureConfig>>	infrastructureConfigs() Returns the infrastructure configs.
boolean	infrastructureUpdate(List<Pickaxe.InfrastructureStats> stats) Publishes the provided stats to the Foreman API.
Optional<List<Pickaxe.MinerConfig>>	minerConfigs(String version, String hostname, String hostIp) Returns the miner configurations.
boolean	started() Informs Foreman that the Pickaxe has started.
boolean	updateMacs(Map<Miners.Miner,String> newMacs) Sets the MACs for the provided miners.

Methods inherited from class java.lang.Object

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

Constructor Detail

PickaxeImpl

public PickaxeImpl(String clientId,
                   String pickaxeId,
                   com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                   WebUtil webUtil)

Constructor.

Parameters:

clientId - The client ID.

pickaxeId - The pickaxe ID.

objectMapper - The mapper.

webUtil - The web utilities.

Method Detail

all

public List<Pickaxe.PickaxeInstance> all()

Description copied from interface: Pickaxe

Returns all of the pickaxes.

Specified by:

all in interface Pickaxe

Returns:

All of the pickaxes.

cancelCommands

public Optional<List<String>> cancelCommands()

Description copied from interface: Pickaxe

Cancels all of the pending or in-progress commands on this Pickaxe.

Specified by:

cancelCommands in interface Pickaxe

Returns:

The cancelled command IDs.

commandDone

public Optional<CommandDone.Response> commandDone(CommandDone done,
                                                  String commandId)

Description copied from interface: Pickaxe

Sends a command completion to the Foreman API.

Specified by:

commandDone in interface Pickaxe

Parameters:

done - The completed command.

commandId - The referencing command ID.

Returns:

The command response.

commandDoneBatch

public Optional<CommandDoneBatch.Response> commandDoneBatch(CommandDoneBatch done)

Description copied from interface: Pickaxe

Sends command completions to the Foreman API.

Specified by:

commandDoneBatch in interface Pickaxe

Parameters:

done - The completed commands.

Returns:

The command response.

commandStarted

public Optional<CommandStart.Response> commandStarted(CommandStart start)

Description copied from interface: Pickaxe

Sends a command started to the Foreman API.

Specified by:

commandStarted in interface Pickaxe

Parameters:

start - The started command.

Returns:

The command response.

commandStartedBatch

public Optional<CommandStartBatch.Response> commandStartedBatch(CommandStartBatch start)

Description copied from interface: Pickaxe

Sends command starts to the Foreman API.

Specified by:

commandStartedBatch in interface Pickaxe

Parameters:

start - The started commands.

Returns:

The command response.

commandUpdate

public Optional<CommandUpdate.Response> commandUpdate(CommandUpdate update,
                                                      String commandId)

Description copied from interface: Pickaxe

Sends a command update to the Foreman API.

Specified by:

commandUpdate in interface Pickaxe

Parameters:

update - The updated command.

commandId - The referencing command ID.

Returns:

The command response.

commandUpdateBatch

public Optional<CommandUpdateBatch.Response> commandUpdateBatch(CommandUpdateBatch update)

Description copied from interface: Pickaxe

Sends command updates to the Foreman API.

Specified by:

commandUpdateBatch in interface Pickaxe

Parameters:

update - The updates.

Returns:

The command response.

config

public Optional<Pickaxe.PickaxeConfiguration> config()

Description copied from interface: Pickaxe

Obtains the configuration.

Specified by:

config in interface Pickaxe

Returns:

The configuration.

getCommands

public Optional<Commands> getCommands()

Description copied from interface: Pickaxe

Queries for pending commands to be executed.

Specified by:

getCommands in interface Pickaxe

Returns:

The commands to execute, if any.

infrastructureConfigs

public Optional<List<Pickaxe.InfrastructureConfig>> infrastructureConfigs()

Description copied from interface: Pickaxe

Returns the infrastructure configs.

Specified by:

infrastructureConfigs in interface Pickaxe

Returns:

The infrastructure configs.

infrastructureUpdate

public boolean infrastructureUpdate(List<Pickaxe.InfrastructureStats> stats)

Description copied from interface: Pickaxe

Publishes the provided stats to the Foreman API.

Specified by:

infrastructureUpdate in interface Pickaxe

Parameters:

stats - The stats.

Returns:

Whether successful.

minerConfigs

public Optional<List<Pickaxe.MinerConfig>> minerConfigs(String version,
                                                        String hostname,
                                                        String hostIp)

Description copied from interface: Pickaxe

Returns the miner configurations.

Specified by:

minerConfigs in interface Pickaxe

Parameters:

version - The version.

hostname - The hostname.

hostIp - The host IP.

Returns:

The miner configurations.

started

public boolean started()

Description copied from interface: Pickaxe

Informs Foreman that the Pickaxe has started.

Specified by:

started in interface Pickaxe

Returns:

Whether successful.

updateMacs

public boolean updateMacs(Map<Miners.Miner,String> newMacs)

Description copied from interface: Pickaxe

Sets the MACs for the provided miners.

Specified by:

updateMacs in interface Pickaxe

Parameters:

newMacs - The new MACs.

Returns:

Whether the command was successful.