io.druid.security.basic.authentication.endpoint

Class BasicAuthenticatorResource

java.lang.Object

io.druid.security.basic.authentication.endpoint.BasicAuthenticatorResource

public class BasicAuthenticatorResource
extends Object

Constructor Summary

Constructors

Constructor and Description
BasicAuthenticatorResource(BasicAuthenticatorResourceHandler handler)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	authenticatorUpdateListener(javax.servlet.http.HttpServletRequest req, String authenticatorName, byte[] serializedUserMap) Listen for update notifications for the auth storage
javax.ws.rs.core.Response	createUser(javax.servlet.http.HttpServletRequest req, String authenticatorName, String userName) Create a new user with name userName
javax.ws.rs.core.Response	deleteUser(javax.servlet.http.HttpServletRequest req, String authenticatorName, String userName) Delete a user
javax.ws.rs.core.Response	getAllUsers(javax.servlet.http.HttpServletRequest req, String authenticatorName)
javax.ws.rs.core.Response	getCachedSerializedUserMap(javax.servlet.http.HttpServletRequest req, String authenticatorName)
javax.ws.rs.core.Response	getLoadStatus(javax.servlet.http.HttpServletRequest req)
javax.ws.rs.core.Response	getUser(javax.servlet.http.HttpServletRequest req, String authenticatorName, String userName)
javax.ws.rs.core.Response	refreshAll(javax.servlet.http.HttpServletRequest req)
javax.ws.rs.core.Response	updateUserCredentials(javax.servlet.http.HttpServletRequest req, String authenticatorName, String userName, BasicAuthenticatorCredentialUpdate update) Assign credentials for a user

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthenticatorResource

@Inject
public BasicAuthenticatorResource(BasicAuthenticatorResourceHandler handler)

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 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 authenticatorName)

Parameters:

req - HTTP request

Returns:

List of all users

getUser

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

Parameters:

req - HTTP request

userName - Name of user to retrieve information about

Returns:

Name and credentials 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 authenticatorName,
                                            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 authenticatorName,
                                            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

updateUserCredentials

public javax.ws.rs.core.Response updateUserCredentials(@Context
                                                       javax.servlet.http.HttpServletRequest req,
                                                       String authenticatorName,
                                                       String userName,
                                                       BasicAuthenticatorCredentialUpdate update)

Assign credentials for a user

Parameters:

req - HTTP request

userName - Name of user

password - Password to assign

Returns:

OK response, 400 error if user doesn't exist

getCachedSerializedUserMap

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

Parameters:

req - HTTP request

Returns:

serialized user map

authenticatorUpdateListener

public javax.ws.rs.core.Response authenticatorUpdateListener(@Context
                                                             javax.servlet.http.HttpServletRequest req,
                                                             String authenticatorName,
                                                             byte[] serializedUserMap)

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