Package io.deephaven.enterprise.webclientdata2

Class PluginBase

java.lang.Object

io.deephaven.plugin.PluginBase

io.deephaven.plugin.type.ObjectTypeBase

io.deephaven.enterprise.webclientdata2.PluginBase

All Implemented Interfaces:

Plugin, Registration, ObjectType

Direct Known Subclasses:

ForceLogoutProviderServicePlugin, RevertTableProviderServicePlugin, WebClientTableFactoryServicePlugin, WorkspaceDataWriterServicePlugin

public abstract class PluginBase
extends ObjectTypeBase

Common functionality to send error responses for plugin service implementations

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.plugin.type.ObjectTypeBase

ObjectTypeBase.FetchOnly

Nested classes/interfaces inherited from interface io.deephaven.plugin.type.ObjectType

ObjectType.MessageStream

Nested classes/interfaces inherited from interface io.deephaven.plugin.Plugin

Plugin.Visitor<T extends Object>

Nested classes/interfaces inherited from interface io.deephaven.plugin.Registration

Registration.Callback

Field Summary

Fields

Modifier and Type	Field	Description
protected static final ByteBuffer	EMPTY_BUFFER
static int	MAX_THREADS
protected static final com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PluginBase()

Method Summary

Modifier and Type	Method	Description
ObjectType.MessageStream	compatibleClientConnection(Object object, ObjectType.MessageStream connection)
protected boolean	logReqs()
protected abstract Object	makeErrorResponse(String id, String errMsg)
protected void	maybeLogRequestEnd(ObjectType.MessageStream connection, String id)
protected void	maybeLogRequestPayload(ObjectType.MessageStream connection, byte[] payloadBytes)
protected void	maybeLogRequestStart(ObjectType.MessageStream connection, Object requestObject)
protected void	onCloseConnection(Object object, ObjectType.MessageStream connection)
protected abstract void	onDataCallback(Object object, ObjectType.MessageStream connection, ByteBuffer payload, Object... references)
protected void	sendAndLogErrorResponse(Logger log, String logPfx, ObjectType.MessageStream connection, String requestId, String msgPrefix, Exception exIn)
protected void	sendAndLogErrorResponse(Logger log, String logPfx, ObjectType.MessageStream connection, String requestId, String user, String msgPrefix, Exception exIn)

Methods inherited from class io.deephaven.plugin.type.ObjectTypeBase

clientConnection, walk

Methods inherited from class io.deephaven.plugin.PluginBase

registerInto

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.plugin.type.ObjectType

isType, name

Methods inherited from interface io.deephaven.plugin.Plugin

registerInto

Field Details

objectMapper

protected static final com.fasterxml.jackson.databind.ObjectMapper objectMapper

EMPTY_BUFFER

protected static final ByteBuffer EMPTY_BUFFER

MAX_THREADS

public static int MAX_THREADS

Constructor Details

PluginBase

protected PluginBase()

Method Details

logReqs

protected boolean logReqs()

maybeLogRequestPayload

protected void maybeLogRequestPayload(ObjectType.MessageStream connection,
 byte[] payloadBytes)

maybeLogRequestStart

protected void maybeLogRequestStart(ObjectType.MessageStream connection,
 Object requestObject)

maybeLogRequestEnd

protected void maybeLogRequestEnd(ObjectType.MessageStream connection,
 String id)

makeErrorResponse

protected abstract Object makeErrorResponse(String id,
 String errMsg)

sendAndLogErrorResponse

protected void sendAndLogErrorResponse(Logger log,
 String logPfx,
 ObjectType.MessageStream connection,
 String requestId,
 String msgPrefix,
 Exception exIn)
                                throws ObjectCommunicationException

Throws:

ObjectCommunicationException

sendAndLogErrorResponse

protected void sendAndLogErrorResponse(Logger log,
 String logPfx,
 ObjectType.MessageStream connection,
 String requestId,
 String user,
 String msgPrefix,
 Exception exIn)
                                throws ObjectCommunicationException

Throws:

ObjectCommunicationException

compatibleClientConnection

public ObjectType.MessageStream compatibleClientConnection(Object object,
 ObjectType.MessageStream connection)
                                                    throws ObjectCommunicationException

Specified by:

compatibleClientConnection in class ObjectTypeBase

Throws:

ObjectCommunicationException

onDataCallback

protected abstract void onDataCallback(Object object,
 ObjectType.MessageStream connection,
 ByteBuffer payload,
 Object... references)
                                throws ObjectCommunicationException

Throws:

ObjectCommunicationException

onCloseConnection

protected void onCloseConnection(Object object,
 ObjectType.MessageStream connection)