Simple server that executes supplied script against a socket.

Typically this is used from the groovy command line agent but it can be invoked programmatically. To run this program from the command line please refer to the command line documentation at Running Groovy from the commandline.

Here is an example of how to use this class to open a listening socket on the server, listen for incoming data, and then echo the data back to the client in reverse order:

new GroovySocketServer(
        new GroovyShell(),      // evaluator
        false,                  // is not a file
        "println line.reverse()",         // script to evaluate
        true,                   // return result to client
        1960)                   //port

There are several variables in the script binding:

line - The data from the socket
out - The output PrintWriter, should you need it for some reason.
socket - The socket, should you need it for some reason.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	GroovySocketServer.GroovyClientConnection

Field Summary

Modifier and Type	Field and Description
private final boolean	autoOutput
private static int	counter
private final GroovyShell	groovy
private final GroovyCodeSource	source
private static final Pattern	URI_PATTERN
private URL	url

Constructor Summary

Access	Constructor and Description
public	GroovySocketServer(GroovyShell The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object. groovy, boolean Whether the incoming socket data String will be a script or a file path. isScriptFile, String This will be a groovy script or a file location depending on the argument isScriptFile. scriptFilenameOrText, boolean whether output should be automatically echoed back to the client autoOutput, int the port to listen on port) This creates and starts the socket server on a new Thread.
public	GroovySocketServer(GroovyShell The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object. groovy, GroovyCodeSource GroovyCodeSource for the Groovy script source, boolean whether output should be automatically echoed back to the client autoOutput, int the port to listen on port) This creates and starts the socket server on a new Thread.

Access

Constructor and Description

public

GroovySocketServer(GroovyShell

The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object.

groovy, boolean

Whether the incoming socket data String will be a script or a file path.

isScriptFile, String

This will be a groovy script or a file location depending on the argument isScriptFile.

scriptFilenameOrText, boolean

whether output should be automatically echoed back to the client

autoOutput, int

the port to listen on

port)

This creates and starts the socket server on a new Thread.

public

GroovySocketServer(GroovyShell

The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object.

groovy, GroovyCodeSource

GroovyCodeSource for the Groovy script

source, boolean

whether output should be automatically echoed back to the client

autoOutput, int

the port to listen on

port)

This creates and starts the socket server on a new Thread.

Method Summary

Modifier and Type	Method and Description
private static synchronized String	generateScriptName()
private static GroovyCodeSource	getCodeSource(boolean scriptFile, String scriptFilenameOrText)
public void	run() Implements java.lang.Runnable.run. Runs this server.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

autoOutput	back to summary
private final boolean autoOutput

counter	back to summary
private static int counter

groovy	back to summary
private final GroovyShell groovy

source	back to summary
private final GroovyCodeSource source

URI_PATTERN	back to summary
private static final Pattern URI_PATTERN

url	back to summary
private URL url

Constructor Detail

GroovySocketServer	back to summary
public GroovySocketServer(GroovyShell groovy, boolean isScriptFile, String scriptFilenameOrText, boolean autoOutput, int port) This creates and starts the socket server on a new Thread. There is no need to call run or spawn a new thread yourself. Parameters groovy:GroovyShell The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object. isScriptFile:boolean Whether the incoming socket data String will be a script or a file path. scriptFilenameOrText:String This will be a groovy script or a file location depending on the argument isScriptFile. autoOutput:boolean whether output should be automatically echoed back to the client port:int the port to listen on

GroovySocketServer

back to summary

public GroovySocketServer(GroovyShell groovy, boolean isScriptFile, String scriptFilenameOrText, boolean autoOutput, int port)

This creates and starts the socket server on a new Thread. There is no need to call run or spawn a new thread yourself.

Parameters

groovy:GroovyShell: The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object.
isScriptFile:boolean: Whether the incoming socket data String will be a script or a file path.
scriptFilenameOrText:String: This will be a groovy script or a file location depending on the argument isScriptFile.
autoOutput:boolean: whether output should be automatically echoed back to the client
port:int: the port to listen on

GroovySocketServer	back to summary
public GroovySocketServer(GroovyShell groovy, GroovyCodeSource source, boolean autoOutput, int port) This creates and starts the socket server on a new Thread. There is no need to call run or spawn a new thread yourself. Parameters groovy:GroovyShell The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object. source:GroovyCodeSource GroovyCodeSource for the Groovy script autoOutput:boolean whether output should be automatically echoed back to the client port:int the port to listen on Since 2.3.0

GroovySocketServer

back to summary

public GroovySocketServer(GroovyShell groovy, GroovyCodeSource source, boolean autoOutput, int port)

This creates and starts the socket server on a new Thread. There is no need to call run or spawn a new thread yourself.

Parameters

groovy:GroovyShell: The GroovyShell object that evaluates the incoming text. If you need additional classes in the classloader then configure that through this object.
source:GroovyCodeSource: GroovyCodeSource for the Groovy script
autoOutput:boolean: whether output should be automatically echoed back to the client
port:int: the port to listen on

Since

2.3.0

Method Detail

generateScriptName	back to summary
private static synchronized String generateScriptName()

getCodeSource	back to summary
private static GroovyCodeSource getCodeSource(boolean scriptFile, String scriptFilenameOrText)

run	back to summary
public void run() Implements java.lang.Runnable.run. Runs this server. There is typically no need to call this method, as the object's constructor creates a new thread and runs this object automatically.

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Runs this server. There is typically no need to call this method, as the object's constructor creates a new thread and runs this object automatically.

groovy.ui back to summary

pack-priv Class GroovySocketServer.GroovyClientConnection

Class Inheritance

extends Object
implements Runnable

java.lang.Object
groovy.ui.GroovySocketServer.GroovyClientConnection

All Implemented Interfaces

java.lang.Runnable

Field Summary

Modifier and Type	Field and Description
private boolean	autoOutputFlag
private BufferedReader	reader
private Script	script
private Socket	socket
private PrintWriter	writer

Constructor Summary

Access	Constructor and Description
pack-priv	GroovyClientConnection(Script script, boolean autoOutput, Socket socket)

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

autoOutputFlag	back to summary
private boolean autoOutputFlag

reader	back to summary
private BufferedReader reader

script	back to summary
private Script script

socket	back to summary
private Socket socket

writer	back to summary
private PrintWriter writer

Constructor Detail

GroovyClientConnection	back to summary
pack-priv GroovyClientConnection(Script script, boolean autoOutput, Socket socket) throws IOException

Method Detail

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation.

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

public Class GroovySocketServer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class GroovySocketServer.GroovyClientConnection

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail