Package org.swisspush.gateleen.core.util

Class ExpansionDeltaUtil

java.lang.Object

org.swisspush.gateleen.core.util.ExpansionDeltaUtil

public final class ExpansionDeltaUtil
extends Object

Utility class providing methods used in ExpansionHandler and DeltaHandler.

Author:

https://github.com/mcweba [Marc-Andre Weber]

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExpansionDeltaUtil.CollectionResourceContainer	Simple container holding a collectionName and a list of resourceNames
static class	ExpansionDeltaUtil.SlashHandling

Method Summary

Modifier and Type	Method	Description
static String	constructRequestUri(String path, io.vertx.core.MultiMap params, List<String> paramsToRemove, String subResource, ExpansionDeltaUtil.SlashHandling slashHandling)	Constructs a Request based on the given path and the given params without the paramsToRemove
static io.vertx.core.Handler<Throwable>	createRequestExceptionHandler(io.vertx.core.http.HttpServerRequest request, String uri, Class<?> caller)	Utility method to create a Exception for a HttpServerRequest
static io.vertx.core.Handler<Throwable>	createResponseExceptionHandler(io.vertx.core.http.HttpServerRequest request, String uri, Class<?> caller)	Utility method to create a Exception for a HttpServerRequest
static String	extractCollectionFromPath(String path)	Extracts the collection name from the given path.
static List<String>	extractCollectionResourceNames(io.vertx.core.json.JsonArray collectionArray)	Extracts the collection resource names from the given JsonArray
static String	mapToDelimetedString(io.vertx.core.MultiMap map, String delim)	Converts the given map to a delimited string based on the given delimiter.
static String	removeFromEndOfString(String source, String stringToRemove)	Remove the stringToRemove from source when existing
static ExpansionDeltaUtil.CollectionResourceContainer	verifyCollectionResponse(io.vertx.core.http.HttpServerRequest request, io.vertx.core.buffer.Buffer data, Set<String> originalParams)	Verifies the result of the collection request.
static ExpansionDeltaUtil.CollectionResourceContainer	verifyCollectionResponse(String targetPath, io.vertx.core.buffer.Buffer data, Set<String> originalParams)	Verifies the result of the collection request.

Methods inherited from class java.lang.Object

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

Method Detail

mapToDelimetedString

public static String mapToDelimetedString(io.vertx.core.MultiMap map,
                                          String delim)

Converts the given map to a delimited string based on the given delimiter.

 Example
 Input Map: {k1=v1, k2=v2, k3=v3} Input delim: 
 Result: k1=v1&k2=v2&k3=v3
 

Parameters:

map - The map to convert.

delim - The delimiter to use between key-value pairs.

Returns:

The delimited string.

removeFromEndOfString

public static String removeFromEndOfString(String source,
                                           String stringToRemove)

Remove the stringToRemove from source when existing

Parameters:

source - the source to remove the stringToRemove from

stringToRemove - the token to remove from source

Returns:

String

extractCollectionFromPath

public static String extractCollectionFromPath(String path)

Extracts the collection name from the given path. The collection name is known to be the last segment of the path

Parameters:

path - path

Returns:

String

extractCollectionResourceNames

public static List<String> extractCollectionResourceNames(io.vertx.core.json.JsonArray collectionArray)
                                                   throws ResourceCollectionException

Extracts the collection resource names from the given JsonArray

Parameters:

collectionArray - collectionArray

Returns:

the list of collection names

Throws:

ResourceCollectionException - ResourceCollectionException

constructRequestUri

public static String constructRequestUri(String path,
                                         io.vertx.core.MultiMap params,
                                         List<String> paramsToRemove,
                                         String subResource,
                                         ExpansionDeltaUtil.SlashHandling slashHandling)

Constructs a Request based on the given path and the given params without the paramsToRemove

Parameters:

path - the original path to modify

params - the params of the original request

paramsToRemove - the params which should be removed in the new request

subResource - additional segment for the new request

slashHandling - when set to true, the new request will have a / at the end

Returns:

String

createRequestExceptionHandler

public static io.vertx.core.Handler<Throwable> createRequestExceptionHandler(io.vertx.core.http.HttpServerRequest request,
                                                                             String uri,
                                                                             Class<?> caller)

Utility method to create a Exception for a HttpServerRequest

Parameters:

request - the request

uri - an uri

caller - the caller

Returns:

Handler

createResponseExceptionHandler

public static io.vertx.core.Handler<Throwable> createResponseExceptionHandler(io.vertx.core.http.HttpServerRequest request,
                                                                              String uri,
                                                                              Class<?> caller)

Utility method to create a Exception for a HttpServerRequest

Parameters:

request - the request

uri - an uri

caller - the caller

Returns:

Handler

verifyCollectionResponse

public static ExpansionDeltaUtil.CollectionResourceContainer verifyCollectionResponse(io.vertx.core.http.HttpServerRequest request,
                                                                                      io.vertx.core.buffer.Buffer data,
                                                                                      Set<String> originalParams)
                                                                               throws ResourceCollectionException

Verifies the result of the collection request. Throws a ResourceCollectionException when no collection or more than one collection was found Returns a ExpansionDeltaUtil.CollectionResourceContainer containing the name of the collection and a list of the resourceNames.

Parameters:

request - the request

data - the data

originalParams - originalParams

Returns:

CollectionResourceContainer

Throws:

ResourceCollectionException - ResourceCollectionException

verifyCollectionResponse

public static ExpansionDeltaUtil.CollectionResourceContainer verifyCollectionResponse(String targetPath,
                                                                                      io.vertx.core.buffer.Buffer data,
                                                                                      Set<String> originalParams)
                                                                               throws ResourceCollectionException

Verifies the result of the collection request. Throws a ResourceCollectionException when no collection or more than one collection was found Returns a ExpansionDeltaUtil.CollectionResourceContainer containing the name of the collection and a list of the resourceNames.

Parameters:

targetPath - target path

data - the data

originalParams - originalParams

Returns:

CollectionResourceContainer

Throws:

ResourceCollectionException - ResourceCollectionException