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:

BrowseJdbcTable, BrowseQueue, ClassInfo, CompatibilityShowScheduler, CompatiblityTransactionalStorage, ExecuteJdbcQuery, Init, SendJmsMessage, ServerStatistics, ShowAdapterStatistics, ShowConfiguration, ShowConfigurationStatus, ShowConnectionOverview, ShowEnvironmentVariables, ShowIbisstoreSummary, ShowInlineMessageStoreOverview, ShowLiquibaseScript, ShowLogging, ShowMonitors, 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
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()
protected boolean	allowDeprecatedEndpoints()
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)
org.springframework.context.ApplicationContext	getApplicationContext()
org.springframework.core.env.Environment	getEnvironment()
protected OutboundGateway	getGateway()
protected org.apache.cxf.jaxrs.JAXRSServiceFactoryBean	getJAXRSService()
protected <T> T	getProperty(String key, T defaultValue) Get a property from the Spring Environment.
javax.ws.rs.core.SecurityContext	getSecurityContext()
javax.servlet.http.HttpServletRequest	getServletRequest()
javax.ws.rs.core.UriInfo	getUriInfo()
protected String	getUserPrincipalName()
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

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

log

protected org.apache.logging.log4j.Logger log

Constructor Detail

FrankApiBase

public FrankApiBase()

Method Detail

getGateway

protected final OutboundGateway 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)

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 final void afterPropertiesSet()
                              throws Exception

Specified by:

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

Throws:

Exception

getProperty

protected <T> T getProperty(String key,
                            T defaultValue)

Get a property from the Spring Environment.

allowDeprecatedEndpoints

protected final boolean allowDeprecatedEndpoints()

getJAXRSService

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

getUserPrincipalName

protected String getUserPrincipalName()

getSecurityContext

public javax.ws.rs.core.SecurityContext getSecurityContext()

getServletRequest

public javax.servlet.http.HttpServletRequest getServletRequest()

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

getUriInfo

public javax.ws.rs.core.UriInfo getUriInfo()

getEnvironment

public org.springframework.core.env.Environment getEnvironment()