Package de.pisa.psa.rst.uti

Class PsaRstApiUti

java.lang.Object

de.pisa.psa.rst.uti.PsaRstApiUti

public final class PsaRstApiUti
extends Object

REST API: utilities

Since:

20.06.2023

Author:

weiland

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PsaRstApiUti.Implementation	implementation
static class	PsaRstApiUti.ImplementationParameter	handler implementation parameter
static enum	PsaRstApiUti.ImplementationType	implementation types

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVT_TPL_BLB	BLOB: event template class
static final String	HEADER_AUTHORIZATION	HTTP Authorization header key
static final String	OBJ_TPL_BLB	BLOB: object template class

Method Summary

Modifier and Type	Method	Description
static String	booleanToCubes(String string)	convert a string into a PisaCubes boolean
static PsaRstApiErrFac	createCheckFailedError(de.pisa.psc.srv.glb.PscExc pex)	Create a "PsaRstApiErrCod.CHECK_FAILED" error
static String	dateFromCubes(String string)	Convert a PisaCubes date to a string that can be used for the JSON
static String	dateFromCubes(String string, boolean timezone)	Convert a PisaCubes date to a string that can be used for the JSON
static String	dateToCubes(String string)	Convert a JSON date to a PisaCubes date
static String	generateImplementation(de.pisa.psc.srv.glb.PscSsn ssn, String blob, PsaRstApiUti.ImplementationParameter parameter)	generate an implementation
static Optional<de.pisa.psa.ifc.PsaDtoDat>	getConfig(de.pisa.psc.srv.glb.PscSsn ssn, String cnf_gid)	Get a configuration record
static String	getDtoTitle(de.pisa.psc.srv.glb.PscSsn ssn, String dto)	get the English title for a data object
static Optional<de.pisa.psa.ifc.PsaDtoDat>	getEvent(de.pisa.psc.srv.glb.PscSsn ssn, String evt_gid)	Get an event record
static Optional<de.pisa.psa.ifc.PsaDtoDat>	getKey(de.pisa.psc.srv.glb.PscSsn ssn, String key_gid)	get a key record
static HeaderMap	getMultivaluedStringMap(String json)	convert a JSON into a multi valued string map (String to a list of strings)
static String	getSourceBlob(de.pisa.psc.srv.glb.PscSsn ssn, String blob)	get source code from a BLOB
static de.pisa.psc.srv.svc.MapToList<String,String>	getUrlQueryParameter(String url)	get the query parameter from an URL
static boolean	isIsoDate(String string)	check if a string is an ISO date
static String	removeQuotes(String value)	Remove leading and trailing single quotes from a string
static String	validUrlPath(String path)	Make sure only valid characters are in an URL path.

Methods inherited from class java.lang.Object

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

Field Details

EVT_TPL_BLB

public static final String EVT_TPL_BLB

BLOB: event template class

See Also:

• Constant Field Values

OBJ_TPL_BLB

public static final String OBJ_TPL_BLB

BLOB: object template class

See Also:

• Constant Field Values

HEADER_AUTHORIZATION

public static final String HEADER_AUTHORIZATION

HTTP Authorization header key

See Also:

• Constant Field Values

Method Details

isIsoDate

public static boolean isIsoDate(String string)

check if a string is an ISO date

Parameters:

string - string to check

Returns:

true if ISO date format

booleanToCubes

public static String booleanToCubes(String string)

convert a string into a PisaCubes boolean

Parameters:

string - string to convert

Returns:

y, n or an empty string

dateFromCubes

public static String dateFromCubes(String string)
                            throws ParseException

Convert a PisaCubes date to a string that can be used for the JSON

Parameters:

string - PisaCubes date

Returns:

UTC date as string in the format yyyy-MM-ddTHH:mm:ssZ

Throws:

ParseException

dateFromCubes

public static String dateFromCubes(String string,
 boolean timezone)
                            throws ParseException

Convert a PisaCubes date to a string that can be used for the JSON

Parameters:

string - PisaCubes date

timezone - add the timezone Z to the string?

Returns:

UTC date as string in the format yyyy-MM-ddTHH:mm:ssZ

Throws:

ParseException

dateToCubes

public static String dateToCubes(String string)

Convert a JSON date to a PisaCubes date

Parameters:

string - JSON date

Returns:

PisaCubes date

getConfig

public static Optional<de.pisa.psa.ifc.PsaDtoDat> getConfig(de.pisa.psc.srv.glb.PscSsn ssn,
 String cnf_gid)
                                                     throws Exception

Get a configuration record

Parameters:

ssn - session

cnf_gid - PSC_GID of the configuration record

Returns:

data

Throws:

Exception

getKey

public static Optional<de.pisa.psa.ifc.PsaDtoDat> getKey(de.pisa.psc.srv.glb.PscSsn ssn,
 String key_gid)
                                                  throws Exception

get a key record

Parameters:

ssn - session

key_gid - PSC_GID of the key record

Returns:

data

Throws:

Exception

getEvent

public static Optional<de.pisa.psa.ifc.PsaDtoDat> getEvent(de.pisa.psc.srv.glb.PscSsn ssn,
 String evt_gid)
                                                    throws Exception

Get an event record

Parameters:

ssn - session

evt_gid - PSC_GID of the event record

Returns:

data

Throws:

Exception

getSourceBlob

public static String getSourceBlob(de.pisa.psc.srv.glb.PscSsn ssn,
 String blob)
                            throws Exception

get source code from a BLOB

Parameters:

ssn - session

blob - name of the BLOB

Returns:

source code

Throws:

Exception

generateImplementation

public static String generateImplementation(de.pisa.psc.srv.glb.PscSsn ssn,
 String blob,
 PsaRstApiUti.ImplementationParameter parameter)
                                     throws Exception

generate an implementation

Parameters:

ssn - session

blob - name of the BLOB

parameter - implementation parameter

Returns:

source code

Throws:

Exception

getUrlQueryParameter

public static de.pisa.psc.srv.svc.MapToList<String,String> getUrlQueryParameter(String url)

get the query parameter from an URL

Parameters:

url - URL to parse

Returns:

map with keys and values

getMultivaluedStringMap

public static HeaderMap getMultivaluedStringMap(String json)
                                         throws com.fasterxml.jackson.core.JsonProcessingException

convert a JSON into a multi valued string map (String to a list of strings)

Parameters:

json - JSON to parse

Returns:

map (never null)

Throws:

com.fasterxml.jackson.core.JsonProcessingException

validUrlPath

public static String validUrlPath(String path)

Make sure only valid characters are in an URL path. Invalid characters will be replaced by a -

Parameters:

path - path to check

Returns:

the path with only the valid characters

getDtoTitle

public static String getDtoTitle(de.pisa.psc.srv.glb.PscSsn ssn,
 String dto)
                          throws Exception

get the English title for a data object

Parameters:

ssn - session

dto - data object descriptor

Returns:

title

Throws:

Exception

createCheckFailedError

public static PsaRstApiErrFac createCheckFailedError(de.pisa.psc.srv.glb.PscExc pex)

Create a "PsaRstApiErrCod.CHECK_FAILED" error

Parameters:

pex - PisaCubes exception

Returns:

error factory

removeQuotes

public static String removeQuotes(String value)

Remove leading and trailing single quotes from a string

Parameters:

value - value to change

Returns:

new string without quotes