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

Link to this function

add_basic_auth_middleware(client)

View Source

Returns a Tesla.Client with Tesla.Middleware.BasicAuth middleware configured.

Link to this function

add_basic_auth_middleware(client, opts)

View Source
@spec add_basic_auth_middleware(client :: Tesla.Client.t(), opts :: Keyword.t()) ::
  Tesla.Client.t()
Link to this function

add_bearer_auth_middleware(client, opts)

View Source
@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.

Link to this function

add_query_middleware(client, params)

View Source
@spec add_query_middleware(client :: Tesla.Client.t(), params :: Keyword.t()) ::
  Tesla.Client.t()

Returns a Tesla.Client with Tesla.Middleware.Query middleware configured.

Link to this function

add_query_middleware(client, param, value)

View Source
Link to this function

basic_auth_middleware(client)

View Source

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.

Link to this function

basic_auth_middleware(client, opts)

View Source
@spec basic_auth_middleware(client :: Tesla.Client.t(), opts :: Keyword.t()) :: [
  {Tesla.Middleware.BasicAuth, Keyword.t()}
]
Link to this function

bearer_auth_middleware(client, opts)

View Source
@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()
Link to this function

query_middleware(client, params)

View Source
@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.