com.naturalprogrammer.spring.lemon.util

Class LemonUtils

java.lang.Object

com.naturalprogrammer.spring.lemon.util.LemonUtils

@Component
public class LemonUtils
extends java.lang.Object

Useful helper methods

Author:

Sanjay Patel

Field Summary

Fields

Modifier and Type	Field and Description
static MultiErrorException	NOT_FOUND_EXCEPTION

Constructor Summary

Constructors

Constructor and Description
LemonUtils(org.springframework.context.ApplicationContext applicationContext, org.springframework.context.MessageSource messageSource, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
static void	afterCommit(java.lang.Runnable runnable) A convenient method for running code after successful database commit.
static <T> T	applyPatch(T originalObj, java.lang.String patchString) Applies a JsonPatch to an object
static <ID extends java.io.Serializable> UserDto<ID>	currentUser() Gets the current-user
static <ID extends java.io.Serializable> UserDto<ID>	currentUser(org.springframework.security.core.Authentication auth) Extracts the current-user from authentication object
static void	ensureAuthority(boolean authorized, java.lang.String messageKey) Throws AccessDeniedException is not authorized
static <U extends AbstractUser<U,ID>,ID extends java.io.Serializable> void	ensureCorrectVersion(VersionedEntity<U,ID> original, VersionedEntity<U,ID> updated) Throws a VersionException if the versions of the given entities aren't same.
static void	ensureCredentials(boolean valid, java.lang.String messageKey) Throws BadCredentialsException if not valid
static <U extends AbstractUser<U,ID>,ID extends java.io.Serializable> void	ensureCredentialsUpToDate(com.nimbusds.jwt.JWTClaimsSet claims, U user) Throws BadCredentialsException if user's credentials were updated after the JWT was issued
static <T> void	ensureFound(T entity) Throws 404 Error is the entity isn't found
static java.util.Optional<javax.servlet.http.Cookie>	fetchCookie(javax.servlet.http.HttpServletRequest request, java.lang.String name) Fetches a cookie from the request
static <T> T	fromJson(java.lang.String json, java.lang.Class<T> clazz) Deserializes a JSON String
static <T> T	getBean(java.lang.Class<T> clazz) Gets the reference to an application-context bean
static com.fasterxml.jackson.databind.ObjectMapper	getMapper()
static java.lang.String	getMessage(java.lang.String messageKey, java.lang.Object... args) Gets a message from messages.properties
static <U extends AbstractUser<U,ID>,ID extends java.io.Serializable> void	login(U user) Signs a user in
static <K,V> java.util.Map<K,V>	mapOf(java.lang.Object... keyValPair) Constructs a map of the key-value pairs, passed as parameters
static java.util.function.Supplier<MultiErrorException>	notFoundSupplier() Supplys a 404 exception
void	postConstruct()
static <T> java.lang.String	toJson(T obj) Serializes an object to JSON string
static java.lang.String	toString(org.springframework.core.io.Resource resource) Reads a resource into a String
static java.lang.String	uid() Generates a random unique string
static MultiErrorException	validate(boolean valid, java.lang.String messageKey, java.lang.Object... args) Creates a MultiErrorException out of the given parameters
static MultiErrorException	validate(java.lang.String fieldName, boolean valid, java.lang.String messageKey, java.lang.Object... args) Creates a MultiErrorException out of the given parameters

Methods inherited from class java.lang.Object

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

Field Detail

NOT_FOUND_EXCEPTION

public static final MultiErrorException NOT_FOUND_EXCEPTION

Constructor Detail

LemonUtils

public LemonUtils(org.springframework.context.ApplicationContext applicationContext,
                  org.springframework.context.MessageSource messageSource,
                  com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

postConstruct

@PostConstruct
public void postConstruct()

getMapper

public static com.fasterxml.jackson.databind.ObjectMapper getMapper()

getBean

public static <T> T getBean(java.lang.Class<T> clazz)

Gets the reference to an application-context bean

Parameters:

clazz - the type of the bean

getMessage

public static java.lang.String getMessage(java.lang.String messageKey,
                                          java.lang.Object... args)

Gets a message from messages.properties

Parameters:

messageKey - the key of the message

args - any arguments

mapOf

public static <K,V> java.util.Map<K,V> mapOf(java.lang.Object... keyValPair)

Constructs a map of the key-value pairs, passed as parameters

Parameters:

keyValPair -

currentUser

public static <ID extends java.io.Serializable> UserDto<ID> currentUser()

Gets the current-user

currentUser

public static <ID extends java.io.Serializable> UserDto<ID> currentUser(org.springframework.security.core.Authentication auth)

Extracts the current-user from authentication object

Parameters:

auth -

Returns:

login

public static <U extends AbstractUser<U,ID>,ID extends java.io.Serializable> void login(U user)

Signs a user in

Parameters:

user -

ensureCorrectVersion

public static <U extends AbstractUser<U,ID>,ID extends java.io.Serializable> void ensureCorrectVersion(VersionedEntity<U,ID> original,
                                                                                                       VersionedEntity<U,ID> updated)

Throws a VersionException if the versions of the given entities aren't same.

Parameters:

original -

updated -

ensureCredentials

public static void ensureCredentials(boolean valid,
                                     java.lang.String messageKey)

Throws BadCredentialsException if not valid

Parameters:

valid -

messageKey -

ensureAuthority

public static void ensureAuthority(boolean authorized,
                                   java.lang.String messageKey)

Throws AccessDeniedException is not authorized

Parameters:

authorized -

messageKey -

validate

public static MultiErrorException validate(boolean valid,
                                           java.lang.String messageKey,
                                           java.lang.Object... args)

Creates a MultiErrorException out of the given parameters

Parameters:

valid - the condition to check for

messageKey - key of the error message

args - any message arguments

validate

public static MultiErrorException validate(java.lang.String fieldName,
                                           boolean valid,
                                           java.lang.String messageKey,
                                           java.lang.Object... args)

Creates a MultiErrorException out of the given parameters

Parameters:

fieldName - the name of the field related to the error

valid - the condition to check for

messageKey - key of the error message

args - any message arguments

ensureFound

public static <T> void ensureFound(T entity)

Throws 404 Error is the entity isn't found

Parameters:

entity -

notFoundSupplier

public static java.util.function.Supplier<MultiErrorException> notFoundSupplier()

Supplys a 404 exception

afterCommit

public static void afterCommit(java.lang.Runnable runnable)

A convenient method for running code after successful database commit.

Parameters:

runnable -

uid

public static java.lang.String uid()

Generates a random unique string

applyPatch

public static <T> T applyPatch(T originalObj,
                               java.lang.String patchString)
                        throws com.fasterxml.jackson.core.JsonProcessingException,
                               java.io.IOException,
                               com.github.fge.jsonpatch.JsonPatchException

Applies a JsonPatch to an object

Throws:

com.fasterxml.jackson.core.JsonProcessingException

java.io.IOException

com.github.fge.jsonpatch.JsonPatchException

toJson

public static <T> java.lang.String toJson(T obj)
                                   throws com.fasterxml.jackson.core.JsonProcessingException

Serializes an object to JSON string

Throws:

com.fasterxml.jackson.core.JsonProcessingException

fromJson

public static <T> T fromJson(java.lang.String json,
                             java.lang.Class<T> clazz)
                      throws com.fasterxml.jackson.core.JsonParseException,
                             com.fasterxml.jackson.databind.JsonMappingException,
                             java.io.IOException

Deserializes a JSON String

Throws:

com.fasterxml.jackson.core.JsonParseException

com.fasterxml.jackson.databind.JsonMappingException

java.io.IOException

ensureCredentialsUpToDate

public static <U extends AbstractUser<U,ID>,ID extends java.io.Serializable> void ensureCredentialsUpToDate(com.nimbusds.jwt.JWTClaimsSet claims,
                                                                                                            U user)

Throws BadCredentialsException if user's credentials were updated after the JWT was issued

toString

public static java.lang.String toString(org.springframework.core.io.Resource resource)
                                 throws java.io.IOException

Reads a resource into a String

Throws:

java.io.IOException

fetchCookie

public static java.util.Optional<javax.servlet.http.Cookie> fetchCookie(javax.servlet.http.HttpServletRequest request,
                                                                        java.lang.String name)

Fetches a cookie from the request