org.gradle.foundation.ipc.gradle

Class ExecuteGradleCommandServerProtocol

java.lang.Object

org.gradle.foundation.ipc.gradle.AbstractGradleServerProtocol

org.gradle.foundation.ipc.gradle.ExecuteGradleCommandServerProtocol

All Implemented Interfaces:

ProcessLauncherServer.Protocol, Server.Protocol<ProcessLauncherServer>

public class ExecuteGradleCommandServerProtocol
extends AbstractGradleServerProtocol

This manages the communication between the UI and an externally-launched copy of Gradle when using socket-based inter-process communication. This is the server side for executing a gradle command. This listens for messages from the gradle client.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExecuteGradleCommandServerProtocol.ExecutionInteraction

Nested classes/interfaces inherited from class org.gradle.foundation.ipc.gradle.AbstractGradleServerProtocol

AbstractGradleServerProtocol.MyExecutionInfo

Field Summary

Fields inherited from class org.gradle.foundation.ipc.gradle.AbstractGradleServerProtocol

lastMessageReceived, server

Constructor Summary

Constructors

Constructor and Description
ExecuteGradleCommandServerProtocol(File currentDirectory, File gradleHomeDirectory, File customGradleExecutor, String fullCommandLine, LogLevel logLevel, ShowStacktrace stackTraceLevel, ExecuteGradleCommandServerProtocol.ExecutionInteraction executionInteraction)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addStatus(String status) Notification of any status that might be helpful to the user.
File	getInitScriptFile() This is called before we execute a command.
protected boolean	handleMessageReceived(MessageObject message) Notification that a message was received that we didn't process.
protected void	reportClientExit(boolean wasPremature, int returnCode, String output) This is called when when the client exits.

Methods inherited from class org.gradle.foundation.ipc.gradle.AbstractGradleServerProtocol

aboutToKillProcess, clientCommunicationStopped, clientExited, closeConnection, connectionAccepted, continueConnection, extractInitScriptFile, extractResourceAsFile, getExecutionInfo, getGradleExecutableFile, getGradleHomeDirectory, handShakeCompleted, initialize, killGradle, messageReceived, readFailureOccurred, setHasReceivedBuildCompleteNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecuteGradleCommandServerProtocol

public ExecuteGradleCommandServerProtocol(File currentDirectory,
                                  File gradleHomeDirectory,
                                  File customGradleExecutor,
                                  String fullCommandLine,
                                  LogLevel logLevel,
                                  ShowStacktrace stackTraceLevel,
                                  ExecuteGradleCommandServerProtocol.ExecutionInteraction executionInteraction)

Method Detail

handleMessageReceived

protected 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.

Specified by:

handleMessageReceived in class AbstractGradleServerProtocol

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.

reportClientExit

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

This is called when when the client exits. This does not mean it succeeded. This is probably the only way you'll get ALL of the client's output as it continues to output things like error messages after it sends us an executionFinished message.

Specified by:

reportClientExit in class AbstractGradleServerProtocol

Parameters:

returnCode - the return code of the application

output - its total output

addStatus

protected void addStatus(String status)

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

Specified by:

addStatus in class AbstractGradleServerProtocol

Parameters:

status - a status message

getInitScriptFile

public 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.

Specified by:

getInitScriptFile in class AbstractGradleServerProtocol

Returns:

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