Class: Aspisec::Modules::Filezilla — Documentation by YARD 0.9.36

# Class: Aspisec::Modules::Filezilla

Inherits:
  Aspisec::Module
  - Object
  - Aspisec::Module
  - Aspisec::Modules::Filezilla
  show all

Defined in:
  lib-ruby/aspisec/modules/filezilla.rb

## Overview

FileZilla module.
Inherits Aspisec::Module.
For more examples of methods, see Sqlmap.

Examples:

    # Get the global config
    conf = Aspisec::Config.new.conf
    # Create a Filezilla module instance
    fzl = Aspisec::Modules::Filezilla.new(conf)
    # Locations available
    fzl.locations_list # => ["connexions", "config", "queue"]

See Also:

- https://filezilla-project.org

## Instance Attribute Summary collapse

- #config ⇒ Location readonly

  see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

- #connexions ⇒ Location readonly

  see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

- #queue ⇒ Location readonly

  see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

### Attributes inherited from Aspisec::Module

#base, #conf, #locations_list, #name

## Instance Method Summary collapse

- #initialize(conf, logger: nil) ⇒ Filezilla constructor

  Inherits from Aspisec::Module but has only the `conf` argument, `tool_name` is hardcoded for each module.

### Methods inherited from Aspisec::Module

#check_config, #enabled?, #locations

## Constructor Details

### #initialize(conf, logger: nil) ⇒ `Filezilla`

Inherits from Aspisec::Module but has only the `conf` argument,
`tool_name` is hardcoded for each module.

Parameters:

- conf (`Aspisec::Config`) —

  an instance of the global configuration

    34
    35
    36
    37
    38
    39
    40
    # File 'lib-ruby/aspisec/modules/filezilla.rb', line 34

    def initialize(conf, logger: nil)
      super(conf, 'filezilla', logger:)
      @connexions = Location.new(@conf, 'connexions')
      @config = Location.new(@conf, 'config')
      @queue = Location.new(@conf, 'queue')
      @locations_list = %w[connexions config queue]
    end

## Instance Attribute Details

### #config ⇒ `Location` (readonly)

see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

Returns:

- (`Location`)

    25
    26
    27
    # File 'lib-ruby/aspisec/modules/filezilla.rb', line 25

    def config
      @config
    end

### #connexions ⇒ `Location` (readonly)

see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

Returns:

- (`Location`)

    21
    22
    23
    # File 'lib-ruby/aspisec/modules/filezilla.rb', line 21

    def connexions
      @connexions
    end

### #queue ⇒ `Location` (readonly)

see Config::DEFAULT_CONFIG or call Aspisec::Module::Location#description.

Returns:

- (`Location`)

    29
    30
    31
    # File 'lib-ruby/aspisec/modules/filezilla.rb', line 29

    def queue
      @queue
    end