org.gradle.foundation.ipc.gradle

Class AbstractGradleServerProtocol

java.lang.Object

org.gradle.foundation.ipc.gradle.AbstractGradleServerProtocol

All Implemented Interfaces:

ProcessLauncherServer.Protocol, Server.Protocol<ProcessLauncherServer>

Direct Known Subclasses:

ExecuteGradleCommandServerProtocol, TaskListServerProtocol

public abstract class AbstractGradleServerProtocol
extends Object
implements ProcessLauncherServer.Protocol

This defines the basic behavior of all gradle protocols for interprocess communication. It manages handshaking, detecting if the client executed prematurely, as well as executing alternate external processes. All you need to do is extend this, implement the abstract functions, and make sure you call setHasReceivedBuildCompleteNotification() when whatever you were doing is complete (so we know any exiting is not premature).

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractGradleServerProtocol.MyExecutionInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageObject	lastMessageReceived
protected ProcessLauncherServer	server

Constructor Summary

Constructors

Constructor and Description
AbstractGradleServerProtocol(File currentDirectory, File gradleHomeDirectory, File customGradleExecutor, String fullCommandLine, LogLevel logLevel, ShowStacktrace stackTraceLevel)

Method Summary

Methods

Modifier and Type	Method and Description
void	aboutToKillProcess()
protected abstract void	addStatus(String status) Notification of any status that might be helpful to the user.
void	clientCommunicationStopped() Notification that the client has stopped all communications.
void	clientExited(int returnCode, String output) Notification that the client has shutdown.
protected void	closeConnection() Call this to stop communication
void	connectionAccepted() Notification that the connection was accepted by the client.
boolean	continueConnection()
protected File	extractInitScriptFile(Class resourceClass, String resourceName) If you do have an init script that's a resource, this will extract it based on the name and write it to a temporary file and delete it on exit.
boolean	extractResourceAsFile(Class resourceClass, String name, File file) This extracts the given class' resource to the specified file if it doesn't already exist.
ExecutionInfo	getExecutionInfo(int serverPort) Fill in the ExecutionInfo object with information needed to execute the other process.
protected File	getGradleExecutableFile()
protected File	getGradleHomeDirectory()
abstract File	getInitScriptFile() This is called before we execute a command.
protected abstract boolean	handleMessageReceived(MessageObject message) Notification that a message was received that we didn't process.
protected void	handShakeCompleted() This provides you with a chance to do something when the handshaking is complete
void	initialize(ProcessLauncherServer server) Gives your protocol a chance to store this server so it can access its functions.
void	killGradle()
void	messageReceived(MessageObject message) Notification that a message has been received.
void	readFailureOccurred() Notification that a read failure occurred.
protected abstract void	reportClientExit(boolean wasPremature, int returnCode, String output) This is called if the client exits prematurely.
void	setHasReceivedBuildCompleteNotification() Call this to mark the build as completed (whether successfully or not).

Methods inherited from class java.lang.Object

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

Field Detail

server

protected ProcessLauncherServer server

lastMessageReceived

protected MessageObject lastMessageReceived

Constructor Detail

AbstractGradleServerProtocol

public AbstractGradleServerProtocol(File currentDirectory,
                            File gradleHomeDirectory,
                            File customGradleExecutor,
                            String fullCommandLine,
                            LogLevel logLevel,
                            ShowStacktrace stackTraceLevel)

Method Detail

continueConnection

public boolean continueConnection()

Specified by:

continueConnection in interface Server.Protocol<ProcessLauncherServer>

Returns:

true if we should keep the connection alive. False if we should stop communicaiton.

connectionAccepted

public void connectionAccepted()

Notification that the connection was accepted by the client.

Specified by:

connectionAccepted in interface Server.Protocol<ProcessLauncherServer>

initialize

public void initialize(ProcessLauncherServer server)

Gives your protocol a chance to store this server so it can access its functions.

Specified by:

initialize in interface Server.Protocol<ProcessLauncherServer>

closeConnection

protected void closeConnection()

Call this to stop communication

messageReceived

public void messageReceived(MessageObject message)

Notification that a message has been received. If we just connected, we'll do a quick handshake to verify the client, then we just pass the rest on our our output panel.

Specified by:

messageReceived in interface Server.Protocol<ProcessLauncherServer>

Parameters:

message - the message that was received.

handShakeCompleted

protected void handShakeCompleted()

This provides you with a chance to do something when the handshaking is complete

handleMessageReceived

protected abstract boolean handleMessageReceived(MessageObject message)

Notification that a message was received that we didn't process. Implement this to handle the specifics of your protocol. Basically, the base class handles the handshake. The rest of the conversation is up to you.

Parameters:

message - the message we received.

Returns:

true if we handled the message, false if not. If we don't know it, we won't return an acknowlegement.

setHasReceivedBuildCompleteNotification

public void setHasReceivedBuildCompleteNotification()

Call this to mark the build as completed (whether successfully or not). This is used to determine if the client has exited prematurely which indicates a problem.

addStatus

protected abstract void addStatus(String status)

Notification of any status that might be helpful to the user.

Parameters:

status - a status message

getExecutionInfo

public ExecutionInfo getExecutionInfo(int serverPort)

Fill in the ExecutionInfo object with information needed to execute the other process.

Specified by:

getExecutionInfo in interface ProcessLauncherServer.Protocol

Parameters:

serverPort - the port the server is listening on. The client should send messages here

Returns:

an executionInfo object containing information about what we execute.

getGradleExecutableFile

protected File getGradleExecutableFile()

Returns:

the file that should be used to execute gradle. If we've been given a custom file, we use that, otherwise, we use the batch or shell script inside the gradle home's bin directory.

clientCommunicationStopped

public void clientCommunicationStopped()

Notification that the client has stopped all communications.

Specified by:

clientCommunicationStopped in interface Server.Protocol<ProcessLauncherServer>

clientExited

public void clientExited(int returnCode,
                String output)

Notification that the client has shutdown. Note: this can occur before communciations has ever started. You SHOULD get this notification before receiving serverExited, even if the client fails to launch or locks up.

Specified by:

clientExited in interface ProcessLauncherServer.Protocol

Parameters:

returnCode - the return code of the client application

output - the standard error and standard output of the client application

reportClientExit

protected abstract void reportClientExit(boolean wasPremature,
                    int returnCode,
                    String output)

This is called if the client exits prematurely. That is, we never connected to it or it didn't finish. This can happen because of setup issues or errors that occur in gradle.

Parameters:

returnCode - the return code of the application

getInitScriptFile

public abstract File getInitScriptFile()

This is called before we execute a command. Here, return an init script for this protocol. An init script is a gradle script that gets run before the other scripts are processed. This is useful here for initiating the gradle client that talks to the server.

Returns:

The path to an init script. Null if you have no init script.

extractInitScriptFile

protected File extractInitScriptFile(Class resourceClass,
                         String resourceName)

If you do have an init script that's a resource, this will extract it based on the name and write it to a temporary file and delete it on exit.

Parameters:

resourceClass - the class associated with the resource

resourceName - the name (minus extension or '.') of the resource

extractResourceAsFile

public boolean extractResourceAsFile(Class resourceClass,
                            String name,
                            File file)

This extracts the given class' resource to the specified file if it doesn't already exist.

Parameters:

resourceClass - the class associated with the resource

name - the resource's name

file - where to put the resource

Returns:

true if successful, false if not.

getGradleHomeDirectory

protected File getGradleHomeDirectory()

readFailureOccurred

public void readFailureOccurred()

Notification that a read failure occurred. This really only exists for debugging purposes when things go wrong.

Specified by:

readFailureOccurred in interface Server.Protocol<ProcessLauncherServer>

aboutToKillProcess

public void aboutToKillProcess()

Specified by:

aboutToKillProcess in interface ProcessLauncherServer.Protocol

killGradle

public void killGradle()