Footprintless::Factory

- NAME
- VERSION
- DESCRIPTION
- CONSTRUCTORS
  - new($entities)
- METHODS
  - agent()
  - command_options(%spec)
  - command_options_factory()
  - command_runner()
  - deployment($coordinate, %options)
  - entities()
  - localhost()
  - log($coordinate, %options)
  - overlay($coordinate, %options)
  - plugins()
  - register_plugin($plugin)
  - resource_manager()
  - service($coordinate, %options)
- AUTHOR
- COPYRIGHT AND LICENSE
- SEE ALSO

# NAME

Footprintless::Factory - The default factory for footprintless modules

# VERSION

version 1.03

# DESCRIPTION

The default factory for footprintless modules.

# CONSTRUCTORS

## new($entities)

Creates a new factory configured by `$entities`.

# METHODS

## agent()

Returns the agent used by this instance.

## command_options(%spec)

Returns a `Footprintless::Command::CommandOptions` object configured by `%spec`.

## command_options_factory()

Returns the command_options_factory used by this instance.

## command_runner()

Returns the command_runner used by this instance.

## deployment($coordinate, %options)

Returns a new instance of Footprintless::Deployment preconfigured to operate on the deployment at `$coordinate`. Supported options are

command_options_factory

  A `command_options_factory` to use instead of that which is supplied by this footprintless instance.

command_runner

  A `command_runner` to use instead of that which is supplied by this footprintless instance.

localhost

  A `localhost` to use instead of that which is supplied by this footprintless instance.

resource_manager

  A `resource_manager` to use instead of that which is supplied by this footprintless instance.

## entities()

Returns the Config::Entities that were resolved by this footprintless instance.

## localhost()

Returns the localhost resolver used by this instance.

## log($coordinate, %options)

Returns a new instance of Footprintless::Log preconfigured to operate on the log at `$coordinate`. Supported options are

command_options_factory

  A `command_options_factory` to use instead of that which is supplied by this footprintless instance.

command_runner

  A `command_runner` to use instead of that which is supplied by this footprintless instance.

localhost

  A `localhost` to use instead of that which is supplied by this footprintless instance.

## overlay($coordinate, %options)

Returns a new instance of Footprintless::Overlay preconfigured to operate on the overlay at `$coordinate`. Supported options are

command_options_factory

  A `command_options_factory` to use instead of that which is supplied by this footprintless instance.

command_runner

  A `command_runner` to use instead of that which is supplied by this footprintless instance.

localhost

  A `localhost` to use instead of that which is supplied by this footprintless instance.

resource_manager

  A `resource_manager` to use instead of that which is supplied by this footprintless instance.

## plugins()

Returns the registered plugins for this instance.

## register_plugin($plugin)

Registers `$plugin` with this instance. `$plugin` must be an instance of Footprintless::Plugin or a subclass.

## resource_manager()

Returns the resource_manager used by this instance.

## service($coordinate, %options)

Returns a new instance of Footprintless::Service preconfigured to operate on the service at `$coordinate`. Supported options are

command_options_factory

  A `command_options_factory` to use instead of that which is supplied by this footprintless instance.

command_runner

  A `command_runner` to use instead of that which is supplied by this footprintless instance.

localhost

  A `localhost` to use instead of that which is supplied by this footprintless instance.

# AUTHOR

Lucas Theisen <lucastheisen@pastdev.com>

# COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Lucas Theisen.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

# SEE ALSO

Please see those modules/websites for more information related to this module.

- Footprintless
- Footprintless
- Footprintless::Deployment
- Footprintless::Log
- Footprintless::Overlay
- Footprintless::Service