nl.nn.adapterframework.core

Class PipeLineSession

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

nl.nn.adapterframework.core.PipeLineSession

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Map<String,Object>

public class PipeLineSession
extends HashMap<String,Object>
implements AutoCloseable

Basic implementation of PipeLineSession.

Since:

version 3.2.2

Author:

Johan Verrips IOS

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_PRINCIPAL_KEY
static String	correlationIdKey
static String	EXIT_CODE_CONTEXT_KEY
static String	EXIT_STATE_CONTEXT_KEY
static String	HTTP_REQUEST_KEY
static String	HTTP_RESPONSE_KEY
static String	messageIdKey
static String	originalMessageKey
static String	securityHandlerKey
static String	SERVLET_CONTEXT_KEY
static String	TS_RECEIVED_KEY
static String	TS_SENT_KEY

Constructor Summary

Constructors

Constructor and Description
PipeLineSession()
PipeLineSession(int initialCapacity)
PipeLineSession(int initialCapacity, float loadFactor)
PipeLineSession(Map<String,Object> t)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	get(String key, boolean defaultValue) Retrieves a boolean value from the PipeLineSession
double	get(String key, double defaultValue) Retrieves a double value from the PipeLineSession
int	get(String key, int defaultValue) Retrieves an int value from the PipeLineSession
long	get(String key, long defaultValue) Retrieves a long value from the PipeLineSession
String	get(String key, String defaultValue) Retrieves a String value from the PipeLineSession
Boolean	getBoolean(String key) Retrieves a Boolean value from the PipeLineSession
String	getCorrelationId()
Message	getMessage(String key)
String	getMessageId()
Principal	getPrincipal()
ISecurityHandler	getSecurityHandler()
Date	getTsReceived()
static Date	getTsReceived(Map<String,Object> context)
Date	getTsSent()
static Date	getTsSent(Map<String,Object> context)
boolean	isScheduledForCloseOnExit(Message message)
boolean	isUserInRole(String role)
void	scheduleCloseOnSessionExit(AutoCloseable resource, String requester)
void	scheduleCloseOnSessionExit(Message message, String label)
static void	setListenerParameters(Map<String,Object> map, String messageId, String correlationId, Date tsReceived, Date tsSent) Convenience method to set required parameters from listeners
void	setSecurityHandler(ISecurityHandler handler)
void	unscheduleCloseOnSessionExit(Message message)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

originalMessageKey

public static final String originalMessageKey

See Also:

Constant Field Values

messageIdKey

public static final String messageIdKey

See Also:

Constant Field Values

correlationIdKey

public static final String correlationIdKey

See Also:

Constant Field Values

TS_RECEIVED_KEY

public static final String TS_RECEIVED_KEY

See Also:

Constant Field Values

TS_SENT_KEY

public static final String TS_SENT_KEY

See Also:

Constant Field Values

securityHandlerKey

public static final String securityHandlerKey

See Also:

Constant Field Values

HTTP_REQUEST_KEY

public static final String HTTP_REQUEST_KEY

See Also:

Constant Field Values

HTTP_RESPONSE_KEY

public static final String HTTP_RESPONSE_KEY

See Also:

Constant Field Values

SERVLET_CONTEXT_KEY

public static final String SERVLET_CONTEXT_KEY

See Also:

Constant Field Values

API_PRINCIPAL_KEY

public static final String API_PRINCIPAL_KEY

See Also:

Constant Field Values

EXIT_STATE_CONTEXT_KEY

public static final String EXIT_STATE_CONTEXT_KEY

See Also:

Constant Field Values

EXIT_CODE_CONTEXT_KEY

public static final String EXIT_CODE_CONTEXT_KEY

See Also:

Constant Field Values

Constructor Detail

PipeLineSession

public PipeLineSession()

PipeLineSession

public PipeLineSession(int initialCapacity)

PipeLineSession

public PipeLineSession(int initialCapacity,
                       float loadFactor)

PipeLineSession

public PipeLineSession(Map<String,Object> t)

Method Detail

getMessageId

public String getMessageId()

getCorrelationId

public String getCorrelationId()

getMessage

public Message getMessage(String key)

getTsReceived

public Date getTsReceived()

getTsReceived

public static Date getTsReceived(Map<String,Object> context)

getTsSent

public Date getTsSent()

getTsSent

public static Date getTsSent(Map<String,Object> context)

setListenerParameters

public static void setListenerParameters(Map<String,Object> map,
                                         String messageId,
                                         String correlationId,
                                         Date tsReceived,
                                         Date tsSent)

Convenience method to set required parameters from listeners

setSecurityHandler

public void setSecurityHandler(ISecurityHandler handler)

getSecurityHandler

public ISecurityHandler getSecurityHandler()
                                    throws org.apache.commons.lang3.NotImplementedException

Throws:

org.apache.commons.lang3.NotImplementedException

isUserInRole

public boolean isUserInRole(String role)
                     throws org.apache.commons.lang3.NotImplementedException

Throws:

org.apache.commons.lang3.NotImplementedException

getPrincipal

public Principal getPrincipal()
                       throws org.apache.commons.lang3.NotImplementedException

Throws:

org.apache.commons.lang3.NotImplementedException

get

public String get(String key,
                  String defaultValue)

Retrieves a String value from the PipeLineSession

Parameters:

key - the referenced key

defaultValue - the value to return when the key cannot be found

Returns:

String

get

public boolean get(String key,
                   boolean defaultValue)

Retrieves a boolean value from the PipeLineSession

Parameters:

key - the referenced key

defaultValue - the value to return when the key cannot be found

Returns:

boolean

getBoolean

public Boolean getBoolean(String key)

Retrieves a Boolean value from the PipeLineSession

Parameters:

key - the referenced key

Returns:

Boolean

get

public int get(String key,
               int defaultValue)

Retrieves an int value from the PipeLineSession

Parameters:

key - the referenced key

defaultValue - the value to return when the key cannot be found

Returns:

int

get

public long get(String key,
                long defaultValue)

Retrieves a long value from the PipeLineSession

Parameters:

key - the referenced key

defaultValue - the value to return when the key cannot be found

Returns:

long

get

public double get(String key,
                  double defaultValue)

Retrieves a double value from the PipeLineSession

Parameters:

key - the referenced key

defaultValue - the value to return when the key cannot be found

Returns:

double

scheduleCloseOnSessionExit

public void scheduleCloseOnSessionExit(Message message,
                                       String label)

scheduleCloseOnSessionExit

public void scheduleCloseOnSessionExit(AutoCloseable resource,
                                       String requester)

isScheduledForCloseOnExit

public boolean isScheduledForCloseOnExit(Message message)

unscheduleCloseOnSessionExit

public void unscheduleCloseOnSessionExit(Message message)

close

public void close()

Specified by:

close in interface AutoCloseable