GroovyShellEndpoint (Moqui Framework 4.0.0)

org.moqui.impl.webapp.GroovyShellEndpoint

@groovy.transform.CompileStatic
class GroovyShellEndpoint
extends MoquiAbstractEndpoint

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`GroovyShellEndpoint.WsWriter`

Inherited fields
Fields inherited from class	Fields
`class MoquiAbstractEndpoint`	`destroyInitialEci, ecfi, handshakeRequest, httpSession, session, userId, username`

Properties Summary

Properties
Type	Name and description
`boolean`	`closing`
`ExecutionContextImpl`	`eci`
`java.util.concurrent.ScheduledFuture<?>`	`evalTimeoutTask`
`java.util.concurrent.ExecutorService`	`exec`
`groovy.lang.GroovyShell`	`groovyShell`
`java.util.concurrent.ScheduledFuture<?>`	`idleTask`
`java.util.concurrent.ScheduledExecutorService`	`scheduler`

Constructor Summary

Constructors
Constructor and description
`GroovyShellEndpoint()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`cancelEvalTimeout()`
	`void`	`checkSend(java.lang.String text)`
	`void`	`deregisterEci()` Remove the ExecutionContext from the executor thread after evaluation to avoid leaking it to the next task on the same thread.
	`void`	`onClose(javax.jcr.Session session, jakarta.websocket.CloseReason closeReason)`
	`void`	`onMessage(java.lang.String message)`
	`void`	`onOpen(javax.jcr.Session session, jakarta.websocket.EndpointConfig config)`
	`void`	`registerEci()` Bind this session's ExecutionContext to the current executor thread for the duration of a single Groovy evaluation.
	`void`	`resetIdleTimer()`
	`void`	`resumeIdleTimer()`
	`void`	`scheduleEvalTimeout()`
	`void`	`suspendIdleTimer()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class MoquiAbstractEndpoint`	`getEcf, getHttpSession, getSession, getUserId, getUsername, onClose, onError, onMessage, onOpen`

- Property Detail
  - boolean closing
  - ExecutionContextImpl eci
  - java.util.concurrent.ScheduledFuture<?> evalTimeoutTask
  - java.util.concurrent.ExecutorService exec
  - groovy.lang.GroovyShell groovyShell
  - java.util.concurrent.ScheduledFuture<?> idleTask
  - java.util.concurrent.ScheduledExecutorService scheduler
- Constructor Detail
  - GroovyShellEndpoint()
- Method Detail
  - void cancelEvalTimeout()
  - void checkSend(java.lang.String text)
  - void deregisterEci()
    
    Remove the ExecutionContext from the executor thread after evaluation to avoid leaking it to the next task on the same thread.
  - @java.lang.Override
    void onClose(javax.jcr.Session session, jakarta.websocket.CloseReason closeReason)
  - @java.lang.Override
    void onMessage(java.lang.String message)
  - @java.lang.Override
    void onOpen(javax.jcr.Session session, jakarta.websocket.EndpointConfig config)
  - void registerEci()
    
    Bind this session's ExecutionContext to the current executor thread for the duration of a single Groovy evaluation.
  - void resetIdleTimer()
  - void resumeIdleTimer()
  - void scheduleEvalTimeout()
  - void suspendIdleTimer()

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class GroovyShellEndpoint

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

boolean closing

ExecutionContextImpl eci

java.util.concurrent.ScheduledFuture<?> evalTimeoutTask

java.util.concurrent.ExecutorService exec

groovy.lang.GroovyShell groovyShell

java.util.concurrent.ScheduledFuture<?> idleTask

java.util.concurrent.ScheduledExecutorService scheduler

Constructor Detail

GroovyShellEndpoint()

Method Detail

void cancelEvalTimeout()

void checkSend(java.lang.String text)

void deregisterEci()

@java.lang.Override
void onClose(javax.jcr.Session session, jakarta.websocket.CloseReason closeReason)

@java.lang.Override
void onMessage(java.lang.String message)

@java.lang.Override
void onOpen(javax.jcr.Session session, jakarta.websocket.EndpointConfig config)

void registerEci()

void resetIdleTimer()

void resumeIdleTimer()

void scheduleEvalTimeout()

void suspendIdleTimer()

[Groovy] Class GroovyShellEndpoint

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

boolean closing

ExecutionContextImpl eci

java.util.concurrent.ScheduledFuture<?> evalTimeoutTask

java.util.concurrent.ExecutorService exec

groovy.lang.GroovyShell groovyShell

java.util.concurrent.ScheduledFuture<?> idleTask

java.util.concurrent.ScheduledExecutorService scheduler

Constructor Detail

GroovyShellEndpoint()

Method Detail

void cancelEvalTimeout()

void checkSend(java.lang.String text)

void deregisterEci()

@java.lang.Overridevoid onClose(javax.jcr.Session session, jakarta.websocket.CloseReason closeReason)

@java.lang.Overridevoid onMessage(java.lang.String message)

@java.lang.Overridevoid onOpen(javax.jcr.Session session, jakarta.websocket.EndpointConfig config)

void registerEci()

void resetIdleTimer()

void resumeIdleTimer()

void scheduleEvalTimeout()

void suspendIdleTimer()

@java.lang.Override
void onClose(javax.jcr.Session session, jakarta.websocket.CloseReason closeReason)

@java.lang.Override
void onMessage(java.lang.String message)

@java.lang.Override
void onOpen(javax.jcr.Session session, jakarta.websocket.EndpointConfig config)