Class: WEBrick::HTTPServlet::FileHandler (Ruby 2.2.4)
Description: Class : WEBrick::HTTPServlet::FileHandler - Ruby 2.2.4

- Home
- Core 2.2.4
- Std-lib 2.2.4
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- webrick/httpservlet/filehandler.rb

### Parent

WEBrick::HTTPServlet::AbstractServlet

### Methods

- ::add_handler
- ::new
- ::remove_handler

### Class/Module Index

Quicksearch

- Dir
- Errno
- Errno::ECONNABORTED
- Errno::ECONNRESET
- Errno::EPROTO
- File
- Object
- WEBrick
- WEBrick::AccessLog
- WEBrick::AccessLog::AccessLogError
- WEBrick::BasicLog
- WEBrick::CGI
- WEBrick::Config
- WEBrick::Config::OpenSSL
- WEBrick::Cookie
- WEBrick::Daemon
- WEBrick::GenericServer
- WEBrick::HTMLUtils
- WEBrick::HTTPAuth
- WEBrick::HTTPAuth::Authenticator
- WEBrick::HTTPAuth::BasicAuth
- WEBrick::HTTPAuth::DigestAuth
- WEBrick::HTTPAuth::Htdigest
- WEBrick::HTTPAuth::Htgroup
- WEBrick::HTTPAuth::Htpasswd
- WEBrick::HTTPAuth::ProxyAuthenticator
- WEBrick::HTTPAuth::ProxyBasicAuth
- WEBrick::HTTPAuth::ProxyDigestAuth
- WEBrick::HTTPAuth::UserDB
- WEBrick::HTTPProxyServer
- WEBrick::HTTPRequest
- WEBrick::HTTPResponse
- WEBrick::HTTPServer
- WEBrick::HTTPServerError
- WEBrick::HTTPServlet
- WEBrick::HTTPServlet::AbstractServlet
- WEBrick::HTTPServlet::CGIHandler
- WEBrick::HTTPServlet::DefaultFileHandler
- WEBrick::HTTPServlet::ERBHandler
- WEBrick::HTTPServlet::FileHandler
- WEBrick::HTTPServlet::HTTPServletError
- WEBrick::HTTPServlet::ProcHandler
- WEBrick::HTTPStatus
- WEBrick::HTTPStatus::ClientError
- WEBrick::HTTPStatus::EOFError
- WEBrick::HTTPStatus::Error
- WEBrick::HTTPStatus::Info
- WEBrick::HTTPStatus::Redirect
- WEBrick::HTTPStatus::ServerError
- WEBrick::HTTPStatus::Status
- WEBrick::HTTPStatus::Success
- WEBrick::HTTPUtils
- WEBrick::HTTPUtils::FormData
- WEBrick::HTTPVersion
- WEBrick::Log
- WEBrick::ServerError
- WEBrick::SimpleServer
- WEBrick::Utils
- WEBrick::Utils::TimeoutHandler
- WEBrick::Utils::TimeoutHandler::Thread

No matching classes.

# WEBrick::HTTPServlet::FileHandler

Serves a directory including fancy indexing and a variety of other options.

Example:

    server.mount '/assets', WEBrick::FileHandler, '/path/to/assets'

### Public Class Methods

add_handler(suffix, handler) click to toggle source

Allow custom handling of requests for files with `suffix` by class `handler`

                   # File webrick/httpservlet/filehandler.rb, line 162
    def self.add_handler(suffix, handler)
      HandlerTable[suffix] = handler
    end

new(server, root, options={}, default=Config::FileHandler) click to toggle source

Creates a FileHandler servlet on `server` that serves files starting at directory `root`

`options` may be a Hash containing keys from WEBrick::Config::FileHandler or `true` or `false`.

If `options` is true or false then `:FancyIndexing` is enabled or disabled respectively.

                   # File webrick/httpservlet/filehandler.rb, line 183
    def initialize(server, root, options={}, default=Config::FileHandler)
      @config = server.config
      @logger = @config[:Logger]
      @root = File.expand_path(root)
      if options == true || options == false
        options = { :FancyIndexing => options }
      end
      @options = default.dup.update(options)
    end

remove_handler(suffix) click to toggle source

Remove custom handling of requests for files with `suffix`

                   # File webrick/httpservlet/filehandler.rb, line 169
    def self.remove_handler(suffix)
      HandlerTable.delete(suffix)
    end