View Source ExRabbitMQAdmin (ex_rabbitmq_admin v0.1.2)
Default module for the RabbitMQ admin client.
Configuration
This module uses the ExRabbitMQAdmin.Client
macro, and can be configured
in config.exs
.
# config.ex
config :ex_rabbitmq_admin, ExRabbitMQAdmin,
base_url: "https://rabbitmq.example.com:15672",
username: "guest",
password: "guest"
Examples
Create a client, add basic auth by reading default values from config and list all virtual hosts running in the RabbitMQ cluster.
iex> ExRabbitMQAdmin.client() |> ExRabbitMQAdmin.add_basic_auth_middleware() |> ExRabbitMQAdmin.Vhost.list_vhosts() {:ok, %Tesla.Env{status: 200, body: [...]}}
Summary
Functions
Returns a Tesla.Client
with Tesla.Middleware.BasicAuth
middleware configured.
Returns a Tesla.Client
with Tesla.Middleware.BearerAuth
middleware configured.
Returns a Tesla.Client
with Tesla.Middleware.Query
middleware configured.
Adds Tesla.Middleware.BasicAuth
middleware to given Tesla.Client
middlewares.
Uses username
and password
from keyword opts, or if omitted, read credentials from config.exs
.
Adds Tesla.Middleware.BearerAuth
middleware to given Tesla.Client
middlewares.
Returns a Tesla.Client
with Tesla.Middleware.BaseUrl
, Tesla.Middleware.Logger
and
Tesla.Middleware.JSON
middleware configured.
Adds Tesla.Middleware.Query
middleware to given Tesla.Client
middlewares.
Functions
Returns a Tesla.Client
with Tesla.Middleware.BasicAuth
middleware configured.
@spec add_basic_auth_middleware(client :: Tesla.Client.t(), opts :: Keyword.t()) :: Tesla.Client.t()
@spec add_bearer_auth_middleware(client :: Tesla.Client.t(), opts :: Keyword.t()) :: Tesla.Client.t()
Returns a Tesla.Client
with Tesla.Middleware.BearerAuth
middleware configured.
@spec add_query_middleware(client :: Tesla.Client.t(), params :: Keyword.t()) :: Tesla.Client.t()
Returns a Tesla.Client
with Tesla.Middleware.Query
middleware configured.
Adds Tesla.Middleware.BasicAuth
middleware to given Tesla.Client
middlewares.
Uses username
and password
from keyword opts, or if omitted, read credentials from config.exs
.
@spec basic_auth_middleware(client :: Tesla.Client.t(), opts :: Keyword.t()) :: [ {Tesla.Middleware.BasicAuth, Keyword.t()} ]
@spec bearer_auth_middleware(client :: Tesla.Client.t(), opts :: Keyword.t()) :: [ {Tesla.Middleware.BearerAuth, Keyword.t()} ]
Adds Tesla.Middleware.BearerAuth
middleware to given Tesla.Client
middlewares.
Returns a Tesla.Client
with Tesla.Middleware.BaseUrl
, Tesla.Middleware.Logger
and
Tesla.Middleware.JSON
middleware configured.
@spec client(opts :: Keyword.t()) :: Tesla.Client.t()
@spec query_middleware(client :: Tesla.Client.t(), params :: Keyword.t()) :: [ {Tesla.Middleware.Query, Keyword.t()} ]
Adds Tesla.Middleware.Query
middleware to given Tesla.Client
middlewares.