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
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.FetchOnlyNested classes/interfaces inherited from interface io.deephaven.plugin.type.ObjectType
ObjectType.MessageStreamNested 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
FieldsModifier and TypeFieldDescriptionprotected static final ByteBufferstatic intprotected static final com.fasterxml.jackson.databind.ObjectMapper -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncompatibleClientConnection(Object object, ObjectType.MessageStream connection) protected booleanlogReqs()protected abstract ObjectmakeErrorResponse(String id, String errMsg) protected voidmaybeLogRequestEnd(ObjectType.MessageStream connection, String id) protected voidmaybeLogRequestPayload(ObjectType.MessageStream connection, byte[] payloadBytes) protected voidmaybeLogRequestStart(ObjectType.MessageStream connection, Object requestObject) protected voidonCloseConnection(Object object, ObjectType.MessageStream connection) protected abstract voidonDataCallback(Object object, ObjectType.MessageStream connection, ByteBuffer payload, Object... references) protected voidsendAndLogErrorResponse(Logger log, String logPfx, ObjectType.MessageStream connection, String requestId, String msgPrefix, Exception exIn) protected voidsendAndLogErrorResponse(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, walkMethods inherited from class io.deephaven.plugin.PluginBase
registerIntoMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface io.deephaven.plugin.type.ObjectType
isType, nameMethods inherited from interface io.deephaven.plugin.Plugin
registerInto
-
Field Details
-
objectMapper
protected static final com.fasterxml.jackson.databind.ObjectMapper objectMapper -
EMPTY_BUFFER
-
MAX_THREADS
public static int MAX_THREADS
-
-
Constructor Details
-
PluginBase
protected PluginBase()
-
-
Method Details
-
logReqs
protected boolean logReqs() -
maybeLogRequestPayload
-
maybeLogRequestStart
-
maybeLogRequestEnd
-
makeErrorResponse
-
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:
compatibleClientConnectionin classObjectTypeBase- Throws:
ObjectCommunicationException
-
onDataCallback
protected abstract void onDataCallback(Object object, ObjectType.MessageStream connection, ByteBuffer payload, Object... references) throws ObjectCommunicationException - Throws:
ObjectCommunicationException
-
onCloseConnection
-