Package de.pisa.psa.rst.hdl.out

Class PsaRstApiEvtHdlOut

java.lang.Object

de.pisa.psa.rst.hdl.PsaRstApiEvtHdl

de.pisa.psa.rst.hdl.out.PsaRstApiEvtHdlOut

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

PsaRstApiEvtHdlOutDelete, PsaRstApiEvtHdlOutGet, PsaRstApiEvtHdlOutPatch, PsaRstApiEvtHdlOutPost, PsaRstApiEvtHdlOutPut

public abstract class PsaRstApiEvtHdlOut
extends PsaRstApiEvtHdl

REST API: outgoing event handler

Since:

07.08.2023

Author:

weiland

Nested Class Summary

Nested classes/interfaces inherited from class de.pisa.psa.rst.hdl.PsaRstApiEvtHdl

PsaRstApiEvtHdl.EurekaHighlighting

Field Summary

Fields inherited from class de.pisa.psa.rst.hdl.PsaRstApiEvtHdl

Default_External_Language, Default_User, Force_IAM_User, Max_Records

Constructor Summary

Constructors

Constructor	Description
PsaRstApiEvtHdlOut(PsaRstApiEvtHdlDat data)	Constructor

Method Summary

Modifier and Type	Method	Description
protected void	bufferEntity(javax.ws.rs.core.Response response)	Buffer the response entity. In case of an exception, the exception is logged.
protected javax.ws.rs.client.Entity<?>	getEntity(Object entity, javax.ws.rs.core.MediaType type)	get an entity
String	getIAMKey()	set the key for the IAM properties
String	getRequestBody()	get the request body
String	getRequestHeader()	get the request header
String	getRequestPath()	get the request path
protected de.pisa.psc.srv.rst.PscRstCli	newRestClient(String url)	create a new REST client
protected javax.ws.rs.core.Response	sendDeleteRequest(de.pisa.psc.srv.rst.PscRstCli client, Object entity, javax.ws.rs.core.MediaType type)	send a DELETE request
protected javax.ws.rs.core.Response	sendGetRequest(de.pisa.psc.srv.rst.PscRstCli client, Object entity, javax.ws.rs.core.MediaType type)	send a GET request
protected javax.ws.rs.core.Response	sendPatchRequest(de.pisa.psc.srv.rst.PscRstCli client, Object entity, javax.ws.rs.core.MediaType type)	send a PATCH request
protected javax.ws.rs.core.Response	sendPostRequest(de.pisa.psc.srv.rst.PscRstCli client, Object entity, javax.ws.rs.core.MediaType type)	send a POST request
protected javax.ws.rs.core.Response	sendPutRequest(de.pisa.psc.srv.rst.PscRstCli client, Object entity, javax.ws.rs.core.MediaType type)	send a PUT request
javax.ws.rs.core.Response	sendRequest(Object entity, javax.ws.rs.core.MediaType type)	send a REST request
javax.ws.rs.core.Response	sendRequest(javax.ws.rs.core.Response record)	send a REST request
protected void	setAuthorization(de.pisa.psc.srv.rst.PscRstCli client)	set the authorization for the REST client
void	setBufferResponseEntity(boolean buffer)	Control whether the received response entity should be buffered or not
void	setIAMKey(String key)	get the key for the IAM properties
void	setRequest(de.pisa.psc.srv.rst.PscRstCli client, Object entity)	set the request data
void	setRequestBody(Object body)	set the request body
void	setRequestHeader(String header)	set the request header
void	setRequestPath(String path)	set the request path

Methods inherited from class de.pisa.psa.rst.hdl.PsaRstApiEvtHdl

buildResponse, cloneRecords, close, fetchContact, fetchEureka, fetchEurekaRecords, fetchIAMContact, fetchRecord, fetchRecord, fetchRecords, findEmail, getActiveEventHandler, getContinuation, getData, getEurekaDtoQuery, getEurekaHighlighting, getEurekaQueryField, getExternalCommunicationLanguage, getFetchRecordKeyField, getField, getIAMUser, getJsonIncludeEmpty, getQuery, getSsn, getSsnUsr, getSysSsn, handleEvent, isIAMUser, loadRecord, mapQuery, newDto, newObject, newPsaRstApiObjLis, noEventLogging, queryEureka, queryEurekaRecords, queryRecord, queryRecords, queryRecordsAddSort, queryRecordsSetQuery, setActiveEventHandler, setExternalLanguage, setJsonIncludeEmpty, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

PsaRstApiEvtHdlOut

public PsaRstApiEvtHdlOut(PsaRstApiEvtHdlDat data)

Constructor

Parameters:

data - event data

Method Details

setBufferResponseEntity

public void setBufferResponseEntity(boolean buffer)

Control whether the received response entity should be buffered or not

Parameters:

buffer - if true it will be buffered (default=false)

setRequest

public void setRequest(de.pisa.psc.srv.rst.PscRstCli client,
 Object entity)

set the request data

Parameters:

client - REST client

entity - payload entity

setRequestPath

public void setRequestPath(String path)

set the request path

Parameters:

path - path

getRequestPath

public String getRequestPath()

get the request path

Returns:

path

setRequestBody

public void setRequestBody(Object body)

set the request body

Parameters:

body - body

getRequestBody

public String getRequestBody()

get the request body

Returns:

body

setRequestHeader

public void setRequestHeader(String header)

set the request header

Parameters:

header - header

getRequestHeader

public String getRequestHeader()

get the request header

Returns:

header

setIAMKey

public void setIAMKey(String key)

get the key for the IAM properties

Parameters:

key - key

getIAMKey

public String getIAMKey()

set the key for the IAM properties

Returns:

key

sendRequest

public javax.ws.rs.core.Response sendRequest(javax.ws.rs.core.Response record)
                                      throws Exception

send a REST request

Parameters:

record - record data to send

Returns:

response of the called end point

Throws:

Exception

newRestClient

protected de.pisa.psc.srv.rst.PscRstCli newRestClient(String url)
                                               throws URISyntaxException

create a new REST client

Parameters:

url - target URL

Returns:

client

Throws:

URISyntaxException

sendRequest

public javax.ws.rs.core.Response sendRequest(Object entity,
 javax.ws.rs.core.MediaType type)
                                      throws Exception

send a REST request

Parameters:

entity - payload entity

type - media type of the entity

Returns:

response of the called end point

Throws:

Exception

setAuthorization

protected void setAuthorization(de.pisa.psc.srv.rst.PscRstCli client)
                         throws Exception

set the authorization for the REST client

Parameters:

client - REST client

Throws:

Exception

getEntity

protected javax.ws.rs.client.Entity<?> getEntity(Object entity,
 javax.ws.rs.core.MediaType type)

get an entity

Parameters:

entity - entity object

type - type of the entity

Returns:

entity

sendPostRequest

protected javax.ws.rs.core.Response sendPostRequest(de.pisa.psc.srv.rst.PscRstCli client,
 Object entity,
 javax.ws.rs.core.MediaType type)
                                             throws Exception

send a POST request

Parameters:

client - REST client

entity - payload entity

type - media type of the entity

Returns:

response of the called end point

Throws:

Exception

sendPutRequest

protected javax.ws.rs.core.Response sendPutRequest(de.pisa.psc.srv.rst.PscRstCli client,
 Object entity,
 javax.ws.rs.core.MediaType type)
                                            throws Exception

send a PUT request

Parameters:

client - REST client

entity - payload entity

type - media type of the entity

Returns:

response of the called end point

Throws:

Exception

sendPatchRequest

protected javax.ws.rs.core.Response sendPatchRequest(de.pisa.psc.srv.rst.PscRstCli client,
 Object entity,
 javax.ws.rs.core.MediaType type)
                                              throws Exception

send a PATCH request

Parameters:

client - REST client

entity - payload entity

type - media type of the entity

Returns:

response of the called end point

Throws:

Exception

sendGetRequest

protected javax.ws.rs.core.Response sendGetRequest(de.pisa.psc.srv.rst.PscRstCli client,
 Object entity,
 javax.ws.rs.core.MediaType type)
                                            throws Exception

send a GET request

Parameters:

client - REST client

entity - payload entity

type - media type of the entity

Returns:

response of the called end point

Throws:

Exception

sendDeleteRequest

protected javax.ws.rs.core.Response sendDeleteRequest(de.pisa.psc.srv.rst.PscRstCli client,
 Object entity,
 javax.ws.rs.core.MediaType type)
                                               throws Exception

send a DELETE request

Parameters:

client - REST client

entity - payload entity

type - media type of the entity

Returns:

response of the called end point

Throws:

Exception

bufferEntity

protected void bufferEntity(javax.ws.rs.core.Response response)

Buffer the response entity.
In case of an exception, the exception is logged.

Parameters:

response - response