io.druid.security.basic.authorization.endpoint

Class BasicAuthorizerResource

java.lang.Object

io.druid.security.basic.authorization.endpoint.BasicAuthorizerResource

public class BasicAuthorizerResource
extends Object

Constructor Summary

Constructors

Constructor and Description
BasicAuthorizerResource(BasicAuthorizerResourceHandler resourceHandler)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	assignRoleToUser(javax.servlet.http.HttpServletRequest req, String authorizerName, String userName, String roleName) Assign a role to a user.
javax.ws.rs.core.Response	authorizerUpdateListener(javax.servlet.http.HttpServletRequest req, String authorizerName, byte[] serializedUserAndRoleMap) Listen for update notifications for the auth storage
javax.ws.rs.core.Response	createRole(javax.servlet.http.HttpServletRequest req, String authorizerName, String roleName) Create a new role.
javax.ws.rs.core.Response	createUser(javax.servlet.http.HttpServletRequest req, String authorizerName, String userName) Create a new user with name userName
javax.ws.rs.core.Response	deleteRole(javax.servlet.http.HttpServletRequest req, String authorizerName, String roleName) Delete a role.
javax.ws.rs.core.Response	deleteUser(javax.servlet.http.HttpServletRequest req, String authorizerName, String userName) Delete a user
javax.ws.rs.core.Response	getAllRoles(javax.servlet.http.HttpServletRequest req, String authorizerName)
javax.ws.rs.core.Response	getAllUsers(javax.servlet.http.HttpServletRequest req, String authorizerName)
javax.ws.rs.core.Response	getCachedSerializedUserMap(javax.servlet.http.HttpServletRequest req, String authorizerName)
javax.ws.rs.core.Response	getLoadStatus(javax.servlet.http.HttpServletRequest req)
javax.ws.rs.core.Response	getRole(javax.servlet.http.HttpServletRequest req, String authorizerName, String roleName, String full) Get info about a role
javax.ws.rs.core.Response	getUser(javax.servlet.http.HttpServletRequest req, String authorizerName, String userName, String full)
javax.ws.rs.core.Response	refreshAll(javax.servlet.http.HttpServletRequest req)
javax.ws.rs.core.Response	setRolePermissions(javax.servlet.http.HttpServletRequest req, String authorizerName, String roleName, List<ResourceAction> permissions) Set the permissions of a role.
javax.ws.rs.core.Response	unassignRoleFromUser(javax.servlet.http.HttpServletRequest req, String authorizerName, String userName, String roleName) Remove a role from a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicAuthorizerResource

@Inject
public BasicAuthorizerResource(BasicAuthorizerResourceHandler resourceHandler)

Method Detail

getLoadStatus

public javax.ws.rs.core.Response getLoadStatus(@Context
                                               javax.servlet.http.HttpServletRequest req)

Parameters:

req - HTTP request

Returns:

Load status of authenticator DB caches

refreshAll

public javax.ws.rs.core.Response refreshAll(@Context
                                            javax.servlet.http.HttpServletRequest req)

Parameters:

req - HTTP request Sends an "update" notification to all services with the current user/role database state, causing them to refresh their DB cache state.

getAllUsers

public javax.ws.rs.core.Response getAllUsers(@Context
                                             javax.servlet.http.HttpServletRequest req,
                                             String authorizerName)

Parameters:

req - HTTP request

Returns:

List of all users

getUser

public javax.ws.rs.core.Response getUser(@Context
                                         javax.servlet.http.HttpServletRequest req,
                                         String authorizerName,
                                         String userName,
                                         String full)

Parameters:

req - HTTP request

userName - Name of user to retrieve information about

Returns:

Name, roles, and permissions of the user with userName, 400 error response if user doesn't exist

createUser

public javax.ws.rs.core.Response createUser(@Context
                                            javax.servlet.http.HttpServletRequest req,
                                            String authorizerName,
                                            String userName)

Create a new user with name userName

Parameters:

req - HTTP request

userName - Name to assign the new user

Returns:

OK response, or 400 error response if user already exists

deleteUser

public javax.ws.rs.core.Response deleteUser(@Context
                                            javax.servlet.http.HttpServletRequest req,
                                            String authorizerName,
                                            String userName)

Delete a user

Parameters:

req - HTTP request

userName - Name of user to delete

Returns:

OK response, or 400 error response if user doesn't exist

getAllRoles

public javax.ws.rs.core.Response getAllRoles(@Context
                                             javax.servlet.http.HttpServletRequest req,
                                             String authorizerName)

Parameters:

req - HTTP request

Returns:

List of all roles

getRole

public javax.ws.rs.core.Response getRole(@Context
                                         javax.servlet.http.HttpServletRequest req,
                                         String authorizerName,
                                         String roleName,
                                         String full)

Get info about a role

Parameters:

req - HTTP request

roleName - Name of role

Returns:

Role name, users with role, and permissions of role. 400 error if role doesn't exist.

createRole

public javax.ws.rs.core.Response createRole(@Context
                                            javax.servlet.http.HttpServletRequest req,
                                            String authorizerName,
                                            String roleName)

Create a new role.

Parameters:

req - HTTP request

roleName - Name of role

Returns:

OK response, 400 error if role already exists

deleteRole

public javax.ws.rs.core.Response deleteRole(@Context
                                            javax.servlet.http.HttpServletRequest req,
                                            String authorizerName,
                                            String roleName)

Delete a role.

Parameters:

req - HTTP request

roleName - Name of role

Returns:

OK response, 400 error if role doesn't exist.

assignRoleToUser

public javax.ws.rs.core.Response assignRoleToUser(@Context
                                                  javax.servlet.http.HttpServletRequest req,
                                                  String authorizerName,
                                                  String userName,
                                                  String roleName)

Assign a role to a user.

Parameters:

req - HTTP request

userName - Name of user

roleName - Name of role

Returns:

OK response. 400 error if user/role don't exist, or if user already has the role

unassignRoleFromUser

public javax.ws.rs.core.Response unassignRoleFromUser(@Context
                                                      javax.servlet.http.HttpServletRequest req,
                                                      String authorizerName,
                                                      String userName,
                                                      String roleName)

Remove a role from a user.

Parameters:

req - HTTP request

userName - Name of user

roleName - Name of role

Returns:

OK response. 400 error if user/role don't exist, or if user does not have the role.

setRolePermissions

public javax.ws.rs.core.Response setRolePermissions(@Context
                                                    javax.servlet.http.HttpServletRequest req,
                                                    String authorizerName,
                                                    String roleName,
                                                    List<ResourceAction> permissions)

Set the permissions of a role. This replaces the previous permissions of the role.

Parameters:

req - HTTP request

roleName - Name of role

resourceActions - Permissions to set

Returns:

OK response. 400 error if role doesn't exist.

getCachedSerializedUserMap

public javax.ws.rs.core.Response getCachedSerializedUserMap(@Context
                                                            javax.servlet.http.HttpServletRequest req,
                                                            String authorizerName)

Parameters:

req - HTTP request

Returns:

serialized user map

authorizerUpdateListener

public javax.ws.rs.core.Response authorizerUpdateListener(@Context
                                                          javax.servlet.http.HttpServletRequest req,
                                                          String authorizerName,
                                                          byte[] serializedUserAndRoleMap)

Listen for update notifications for the auth storage

Parameters:

req - HTTP request

userName - Name to assign the new user

Returns:

OK response, or 400 error response if user already exists