summaryrefslogtreecommitdiff
path: root/include/rabbit_auth_backend_spec.hrl
blob: e26d44ea94d9f4f99e31dfa69f5a8dbc13d8b38f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
%% The contents of this file are subject to the Mozilla Public License
%% Version 1.1 (the "License"); you may not use this file except in
%% compliance with the License. You may obtain a copy of the License
%% at http://www.mozilla.org/MPL/
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and
%% limitations under the License.
%%
%% The Original Code is RabbitMQ.
%%
%% The Initial Developer of the Original Code is VMware, Inc.
%% Copyright (c) 2007-2011 VMware, Inc.  All rights reserved.
%%

-ifdef(use_specs).

-spec(description/0 :: () -> [{atom(), any()}]).

-spec(check_user_login/2 :: (rabbit_types:username(), [term()]) ->
                                 {'ok', rabbit_types:user()} |
                                 {'refused', string(), [any()]} |
                                 {'error', any()}).
-spec(check_vhost_access/3 :: (rabbit_types:user(), rabbit_types:vhost(),
                               rabbit_access_control:vhost_permission_atom()) ->
                                   boolean() | {'error', any()}).
-spec(check_resource_access/3 :: (rabbit_types:user(),
                                  rabbit_types:r(atom()),
                                  rabbit_access_control:permission_atom()) ->
                                      boolean() | {'error', any()}).
-endif.