utils.common

Class Helpers

java.lang.Object

utils.common.Helpers

public class Helpers
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Helpers()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	formatDate(java.util.Date date)
static java.lang.String	getDateTimeYyyyMMddHHmmss()
static java.util.Map<java.lang.String,java.lang.String>	getJVMInfo()
static java.util.Map<java.lang.String,java.lang.String>	getOSInfo()
static java.lang.String	getQueryParameter(play.mvc.Http.Request request, java.lang.String parameter) Gets the value of to the given parameter in request's query string and trims whitespace.
static java.lang.String	getQueryString(play.mvc.Http.Request request) Returns the whole query string of the given Request including '?'.
static java.net.URL	getRealBaseUrl(play.mvc.Http.Request request) Returns the request's host URL with base path from 'play.http.context' but without the rest of the path or query string (e.g.
static java.net.URL	getRealHostUrl(play.mvc.Http.Request request) Returns the request's host URL without path (and without base path from 'play.http.context') or query string (e.g.
static int	getStringSize(java.lang.String str) Gets the number of bytes in UTF-8 the given string has
static java.lang.String	humanReadableByteCount(long bytes)
static java.lang.String	humanReadableDuration(java.time.Duration duration)
static void	initializeAndUnproxy(java.lang.Object... objs) Initialize all given objects that are loaded lazily in a Hibernate object
static <T> T	initializeAndUnproxy(T obj) Initialize an object that is loaded lazily in a Hibernate object
static java.lang.Boolean	isAjax() Check if the request was made via Ajax or not.
static boolean	isAllowedSuperuser(User user)
static boolean	isApiRequest(play.mvc.Http.Request request) Checks if the HTTP request has an "Authorization: Bearer" header.
static boolean	isHtmlRequest(play.mvc.Http.Request request)
static boolean	isHtmlRequest(play.api.mvc.RequestHeader request)
static boolean	isLocalhost()
static boolean	isSessionCookieRequest(play.mvc.Http.Request request) Checks if the session has a field 'username'
static akka.stream.javadsl.Source<akka.util.ByteString,java.util.concurrent.CompletionStage<akka.stream.IOResult>>	okFileStreamed(java.io.File file, java.lang.Runnable handler) Helper function to allow an action after a file was sent (e.g.
static java.util.Optional<java.lang.Long>	parseLong(java.lang.String str)
static java.lang.String	urlDecode(java.lang.String str)
static java.lang.String	urlEncode(java.lang.String str)

Methods inherited from class java.lang.Object

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

Constructor Detail

Helpers

public Helpers()

Method Detail

isAjax

public static java.lang.Boolean isAjax()

Check if the request was made via Ajax or not.

isHtmlRequest

public static boolean isHtmlRequest(play.mvc.Http.Request request)

isHtmlRequest

public static boolean isHtmlRequest(play.api.mvc.RequestHeader request)

isSessionCookieRequest

public static boolean isSessionCookieRequest(play.mvc.Http.Request request)

Checks if the session has a field 'username'

isApiRequest

public static boolean isApiRequest(play.mvc.Http.Request request)

Checks if the HTTP request has an "Authorization: Bearer" header. This does not check any authentication.

getRealHostUrl

public static java.net.URL getRealHostUrl(play.mvc.Http.Request request)

Returns the request's host URL without path (and without base path from 'play.http.context') or query string (e.g. "https://www.example.com"). It returns the URL with the proper protocol http or https. If JATOS is run behind a proxy the real host address must be passed on with X-Forwarded-For header. See: https://www.playframework.com/documentation/2.8.x/HTTPServer#Forwarded-header-version

getRealBaseUrl

public static java.net.URL getRealBaseUrl(play.mvc.Http.Request request)

Returns the request's host URL with base path from 'play.http.context' but without the rest of the path or query string (e.g. "https://www.example.com/basepath/"). It returns the URL with the proper protocol http or https. If JATOS is run behind a proxy the real host address must be passed on with X-Forwarded-For header. See: https://www.playframework.com/documentation/2.8.x/HTTPServer#Forwarded-header-version

isLocalhost

public static boolean isLocalhost()

urlEncode

public static java.lang.String urlEncode(java.lang.String str)

urlDecode

public static java.lang.String urlDecode(java.lang.String str)

getQueryParameter

public static java.lang.String getQueryParameter(play.mvc.Http.Request request,
                                                 java.lang.String parameter)

Gets the value of to the given parameter in request's query string and trims whitespace.

getQueryString

public static java.lang.String getQueryString(play.mvc.Http.Request request)

Returns the whole query string of the given Request including '?'.

humanReadableByteCount

public static java.lang.String humanReadableByteCount(long bytes)

getJVMInfo

public static java.util.Map<java.lang.String,java.lang.String> getJVMInfo()

getOSInfo

public static java.util.Map<java.lang.String,java.lang.String> getOSInfo()

humanReadableDuration

public static java.lang.String humanReadableDuration(java.time.Duration duration)

formatDate

public static java.lang.String formatDate(java.util.Date date)

getDateTimeYyyyMMddHHmmss

public static java.lang.String getDateTimeYyyyMMddHHmmss()

initializeAndUnproxy

public static void initializeAndUnproxy(java.lang.Object... objs)

Initialize all given objects that are loaded lazily in a Hibernate object

initializeAndUnproxy

public static <T> T initializeAndUnproxy(T obj)

Initialize an object that is loaded lazily in a Hibernate object

isAllowedSuperuser

public static boolean isAllowedSuperuser(User user)

okFileStreamed

public static akka.stream.javadsl.Source<akka.util.ByteString,java.util.concurrent.CompletionStage<akka.stream.IOResult>> okFileStreamed(java.io.File file,
                                                                                                                                         java.lang.Runnable handler)

Helper function to allow an action after a file was sent (e.g. delete the file)

parseLong

public static java.util.Optional<java.lang.Long> parseLong(java.lang.String str)

getStringSize

public static int getStringSize(java.lang.String str)

Gets the number of bytes in UTF-8 the given string has