com.goldencode.p2j.admin.server.tenant

Class TenantHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

com.goldencode.p2j.admin.server.tenant.TenantHandler

All Implemented Interfaces:

org.eclipse.jetty.server.Handler, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

public class TenantHandler
extends org.eclipse.jetty.server.handler.AbstractHandler

Class that handles HTTP requests that are intended for (multi-)tenant administration. It uses basic authentication and authorization when performing the processes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	TenantHandler.UpdateTenantBody Class responsible with storing the information required by a tenant update operation.

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Set<java.lang.String>	acceptedKeys A set of accepted keys for the update list.
private WebAuthHandler	authHandler The handler used for authentication and authorization.
private static org.eclipse.jetty.server.handler.ContextHandler	handler The context handler.
private static TenantHandler	instance The singleton instance for this handler.
private static CentralLogger	LOG Logger
private java.lang.ThreadLocal<com.fasterxml.jackson.databind.ObjectMapper>	mapper Used to parse the HTTP body as a JSON object.
private LegacyWebSecurityManager	wsm Instance used for executing requests in a context.

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor and Description
TenantHandler(int timeout) Constructor that initializes the authentication handler and the web security manager.

Method Summary

Modifier and Type	Method and Description
private boolean	checkTenantEnabled(java.lang.String token, javax.servlet.http.HttpServletResponse response, java.lang.String tenantName) Check if a specific tenant is enabled.
private boolean	checkUpdateListKeys(java.util.Map<java.lang.String,java.lang.String> updateList) Check if the mapping contains other keys than the accepted ones.
private boolean	executeAndWriteResponse(java.lang.String token, javax.servlet.http.HttpServletResponse response, java.lang.Runnable task, java.lang.Boolean[] result) Execute the given task and assign a message to the HTTP response.
private boolean	executeAndWriteResponse(java.lang.String token, javax.servlet.http.HttpServletResponse response, java.lang.Runnable task, java.lang.String message, java.lang.Boolean[] result) Execute the given task and assign a message to the HTTP response.
void	handle(java.lang.String target, org.eclipse.jetty.server.Request baseRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method for handling the requests.
private void	handleDelete(java.lang.String target, java.lang.String body, javax.servlet.http.HttpServletResponse response, java.lang.String token) Method for handling the DELETE requests.
private void	handleGet(java.lang.String target, javax.servlet.http.HttpServletResponse response, java.lang.String token) Method for handling the GET requests.
private void	handlePost(java.lang.String target, java.lang.String body, javax.servlet.http.HttpServletResponse response, java.lang.String token) Method for handling the POST requests.
private void	handlePut(java.lang.String target, java.lang.String body, javax.servlet.http.HttpServletResponse response, java.lang.String token) Method for handling the PUT requests.
static org.eclipse.jetty.server.handler.AbstractHandler	initialize(int timeout) Function used for initializing the instance of this class.
private TenantDatabaseDescriptor	parseAddDatabaseToTenantBody(java.lang.String body) Parse a JSON and extract the required values for adding a database to a tenant.
private java.util.List<TenantDatabaseDescriptor>	parseAddTenantBody(java.lang.String body, java.lang.String[] tenantName) Parse a JSON and extract the required values for adding a tenant.
private java.lang.Object	parseBody(java.lang.String body, java.lang.String fieldName, java.lang.Class<?> cls) Parse a JSON and extract the value (String or boolean for the moment) of a given field.
private TenantHandler.UpdateTenantBody	parseUpdateTenantBody(java.lang.String body) Parse a JSON and extract the required values for updating a tenant or a database assigned to a tenant.
private java.lang.String	printTenants(java.util.List<TenantManager.Tenant> tenants) List all the tenants from the given list in a JSON format.
static boolean	useWebServiceAuthentication() Determine if this service is configured to use authentication.

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

destroy, doError, doStart, doStop, getServer, setServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, start, stop, stop

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

Field Detail

LOG

private static final CentralLogger LOG

Logger

instance

private static TenantHandler instance

The singleton instance for this handler.

handler

private static org.eclipse.jetty.server.handler.ContextHandler handler

The context handler.

acceptedKeys

private static java.util.Set<java.lang.String> acceptedKeys

A set of accepted keys for the update list.

mapper

private final java.lang.ThreadLocal<com.fasterxml.jackson.databind.ObjectMapper> mapper

Used to parse the HTTP body as a JSON object.

authHandler

private WebAuthHandler authHandler

The handler used for authentication and authorization.

wsm

private LegacyWebSecurityManager wsm

Instance used for executing requests in a context.

Constructor Detail

TenantHandler

public TenantHandler(int timeout)

Constructor that initializes the authentication handler and the web security manager.

Parameters:

timeout - The timeout used when generating tokens.

Method Detail

initialize

public static org.eclipse.jetty.server.handler.AbstractHandler initialize(int timeout)

Function used for initializing the instance of this class.

Parameters:

timeout - The timeout used when generating tokens.

Returns:

The handler instance of this class.

useWebServiceAuthentication

public static boolean useWebServiceAuthentication()

Determine if this service is configured to use authentication.

Returns:

true if this service uses authentication, false otherwise.

handle

public void handle(java.lang.String target,
                   org.eclipse.jetty.server.Request baseRequest,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException,
                   javax.servlet.ServletException

Method for handling the requests.

Specified by:

handle in interface org.eclipse.jetty.server.Handler

Specified by:

handle in class org.eclipse.jetty.server.handler.AbstractHandler

Throws:

java.io.IOException

javax.servlet.ServletException

handleGet

private void handleGet(java.lang.String target,
                       javax.servlet.http.HttpServletResponse response,
                       java.lang.String token)

Method for handling the GET requests.

handlePost

private void handlePost(java.lang.String target,
                        java.lang.String body,
                        javax.servlet.http.HttpServletResponse response,
                        java.lang.String token)

Method for handling the POST requests.

handlePut

private void handlePut(java.lang.String target,
                       java.lang.String body,
                       javax.servlet.http.HttpServletResponse response,
                       java.lang.String token)

Method for handling the PUT requests.

handleDelete

private void handleDelete(java.lang.String target,
                          java.lang.String body,
                          javax.servlet.http.HttpServletResponse response,
                          java.lang.String token)

Method for handling the DELETE requests.

executeAndWriteResponse

private boolean executeAndWriteResponse(java.lang.String token,
                                        javax.servlet.http.HttpServletResponse response,
                                        java.lang.Runnable task,
                                        java.lang.Boolean[] result)

Execute the given task and assign a message to the HTTP response.

Parameters:

token - The token used in the request.

response - The HTTP response.

task - The task to be executed.

result - The field that will contain the result after the execution is performed.

Returns:

true if the operations finish successfully, false otherwise.

executeAndWriteResponse

private boolean executeAndWriteResponse(java.lang.String token,
                                        javax.servlet.http.HttpServletResponse response,
                                        java.lang.Runnable task,
                                        java.lang.String message,
                                        java.lang.Boolean[] result)

Execute the given task and assign a message to the HTTP response.

Parameters:

token - The token used in the request.

response - The HTTP response.

task - The task to be executed.

message - The key value that will be written in the JSON response.

result - The field that will contain the result after the execution is performed.

Returns:

true if the operations finish successfully, false otherwise.

parseAddTenantBody

private java.util.List<TenantDatabaseDescriptor> parseAddTenantBody(java.lang.String body,
                                                                    java.lang.String[] tenantName)

Parse a JSON and extract the required values for adding a tenant.

Parameters:

body - The JSON data.

tenantName - An array that will hold the tenant name, after it is discovered in the body.

Returns:

A list of instances, each one storing a configuration for a database instance.

parseAddDatabaseToTenantBody

private TenantDatabaseDescriptor parseAddDatabaseToTenantBody(java.lang.String body)

Parse a JSON and extract the required values for adding a database to a tenant.

Parameters:

body - The JSON data.

Returns:

A TenantDatabaseDescriptor instance that contains the database information.

parseUpdateTenantBody

private TenantHandler.UpdateTenantBody parseUpdateTenantBody(java.lang.String body)

Parse a JSON and extract the required values for updating a tenant or a database assigned to a tenant.

Parameters:

body - The JSON data.

Returns:

An UpdateTenantBody instance that holds the information required by the update.

checkUpdateListKeys

private boolean checkUpdateListKeys(java.util.Map<java.lang.String,java.lang.String> updateList)

Check if the mapping contains other keys than the accepted ones.

Parameters:

updateList - The mapping of updates.

Returns:

true if the mapping is correct, meaning that no unknown keys are found, false if there is at least an unknown key.

parseBody

private java.lang.Object parseBody(java.lang.String body,
                                   java.lang.String fieldName,
                                   java.lang.Class<?> cls)

Parse a JSON and extract the value (String or boolean for the moment) of a given field.

Parameters:

body - The JSON data.

fieldName - The field for which the value is extracted.

cls - The expected type of value that is retrieved.

Returns:

The value of the given field.

printTenants

private java.lang.String printTenants(java.util.List<TenantManager.Tenant> tenants)

List all the tenants from the given list in a JSON format.

Parameters:

tenants - The list with the tenants.

Returns:

A string in JSON format with the tenant information.

checkTenantEnabled

private boolean checkTenantEnabled(java.lang.String token,
                                   javax.servlet.http.HttpServletResponse response,
                                   java.lang.String tenantName)

Check if a specific tenant is enabled. If not, the function also sets the response accordingly.

Parameters:

token - The token used in this request.

response - The response for the request.

tenantName - The tenant to be checked.

Returns:

true if the tenant is enabled, false otherwise. null if the caller does not have sufficient rights or performs a bad request.