nl.nn.adapterframework.management.web

Class FrankApiBase

java.lang.Object

nl.nn.adapterframework.management.web.FrankApiBase

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

Base, BrowseJdbcTable, BrowseQueue, ClassInfo, ExecuteJdbcQuery, Init, SendJmsMessage, ServerStatistics, ShowConfiguration, ShowConfigurationStatus, ShowConnectionOverview, ShowEnvironmentVariables, ShowIbisstoreSummary, ShowInlineMessageStoreOverview, ShowLiquibaseScript, ShowLogging, ShowScheduler, ShowSecurityItems, TestPipeline, TestServiceListener, TransactionalStorage, UpdateLoggingConfig, Webservices

public abstract class FrankApiBase
extends Object
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

Base class for API endpoints. Contains helper methods to read JAX-RS multiparts and handle message conversions to JAX-RS Responses.

Author:

Niels Meijer

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARSET
static String	HEADER_ADAPTER_NAME_KEY
static String	HEADER_CONFIGURATION_NAME_KEY
static String	HEADER_CONNECTION_FACTORY_NAME_KEY
static String	HEADER_DATASOURCE_NAME_KEY
static String	HEADER_RECEIVER_NAME_KEY
protected org.apache.logging.log4j.Logger	log
protected javax.ws.rs.core.SecurityContext	securityContext
protected javax.servlet.ServletConfig	servletConfig
protected javax.servlet.http.HttpServletRequest	servletRequest
protected javax.ws.rs.core.UriInfo	uriInfo

Constructor Summary

Constructors

Constructor and Description
FrankApiBase()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
javax.ws.rs.core.Response	callAsyncGateway(RequestMessageBuilder input)
javax.ws.rs.core.Response	callSyncGateway(RequestMessageBuilder input)
javax.ws.rs.core.Response	callSyncGateway(RequestMessageBuilder input, boolean evaluateEtag)
protected static <T> T	convert(Class<T> clazz, InputStream is)
protected Boolean	getBooleanValue(Map<String,Object> json, String key)
protected Gateway	getGateway()
protected Integer	getIntegerValue(Map<String,Object> json, String key)
protected org.apache.cxf.jaxrs.JAXRSServiceFactoryBean	getJAXRSService()
protected String	getUserPrincipalName()
protected String	getValue(Map<String,Object> json, String key) If present returns the value as String Else returns NULL
protected String	resolveStringFromMap(org.apache.cxf.jaxrs.ext.multipart.MultipartBody inputDataMap, String key)
protected String	resolveStringFromMap(org.apache.cxf.jaxrs.ext.multipart.MultipartBody inputDataMap, String key, String defaultValue)
protected String	resolveStringWithEncoding(org.apache.cxf.jaxrs.ext.multipart.MultipartBody inputDataMap, String key, String defaultEncoding)
protected <T> T	resolveTypeFromMap(org.apache.cxf.jaxrs.ext.multipart.MultipartBody inputDataMap, String key, Class<T> clazz, T defaultValue)
protected org.springframework.messaging.Message<?>	sendSyncMessage(RequestMessageBuilder input)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_DATASOURCE_NAME_KEY

public static final String HEADER_DATASOURCE_NAME_KEY

See Also:

Constant Field Values

HEADER_CONNECTION_FACTORY_NAME_KEY

public static final String HEADER_CONNECTION_FACTORY_NAME_KEY

See Also:

Constant Field Values

HEADER_CONFIGURATION_NAME_KEY

public static final String HEADER_CONFIGURATION_NAME_KEY

See Also:

Constant Field Values

HEADER_ADAPTER_NAME_KEY

public static final String HEADER_ADAPTER_NAME_KEY

See Also:

Constant Field Values

HEADER_RECEIVER_NAME_KEY

public static final String HEADER_RECEIVER_NAME_KEY

See Also:

Constant Field Values

servletConfig

@Context
protected javax.servlet.ServletConfig servletConfig

securityContext

@Context
protected javax.ws.rs.core.SecurityContext securityContext

servletRequest

@Context
protected javax.servlet.http.HttpServletRequest servletRequest

uriInfo

@Context
protected javax.ws.rs.core.UriInfo uriInfo

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

log

protected org.apache.logging.log4j.Logger log

Constructor Detail

FrankApiBase

public FrankApiBase()

Method Detail

getGateway

protected final Gateway getGateway()

sendSyncMessage

@Nonnull
protected org.springframework.messaging.Message<?> sendSyncMessage(RequestMessageBuilder input)

callSyncGateway

public javax.ws.rs.core.Response callSyncGateway(RequestMessageBuilder input)
                                          throws ApiException

Throws:

ApiException

callSyncGateway

public javax.ws.rs.core.Response callSyncGateway(RequestMessageBuilder input,
                                                 boolean evaluateEtag)
                                          throws ApiException

Throws:

ApiException

callAsyncGateway

public javax.ws.rs.core.Response callAsyncGateway(RequestMessageBuilder input)
                                           throws ApiException

Throws:

ApiException

setApplicationContext

public final void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                                 throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getJAXRSService

protected org.apache.cxf.jaxrs.JAXRSServiceFactoryBean getJAXRSService()

getUserPrincipalName

protected String getUserPrincipalName()

resolveStringFromMap

protected String resolveStringFromMap(org.apache.cxf.jaxrs.ext.multipart.MultipartBody inputDataMap,
                                      String key)
                               throws ApiException

Throws:

ApiException

resolveStringFromMap

protected String resolveStringFromMap(org.apache.cxf.jaxrs.ext.multipart.MultipartBody inputDataMap,
                                      String key,
                                      String defaultValue)
                               throws ApiException

Throws:

ApiException

resolveStringWithEncoding

protected String resolveStringWithEncoding(org.apache.cxf.jaxrs.ext.multipart.MultipartBody inputDataMap,
                                           String key,
                                           String defaultEncoding)

resolveTypeFromMap

protected <T> T resolveTypeFromMap(org.apache.cxf.jaxrs.ext.multipart.MultipartBody inputDataMap,
                                   String key,
                                   Class<T> clazz,
                                   T defaultValue)
                            throws ApiException

Throws:

ApiException

convert

protected static <T> T convert(Class<T> clazz,
                               InputStream is)
                        throws IOException

Throws:

IOException

getValue

@Nullable
protected String getValue(Map<String,Object> json,
                                    String key)

If present returns the value as String Else returns NULL

getIntegerValue

@Nullable
protected Integer getIntegerValue(Map<String,Object> json,
                                            String key)

getBooleanValue

@Nullable
protected Boolean getBooleanValue(Map<String,Object> json,
                                            String key)