com.palantir.giraffe.command

Class CommandTimeoutException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.util.concurrent.TimeoutException

com.palantir.giraffe.command.CommandTimeoutException

All Implemented Interfaces:

Serializable

public class CommandTimeoutException
extends TimeoutException

Checked exception thrown when the timeout for a command is exceeded.

The message contains detailed information about the command that ran, the execution system that ran it, and the output of the command until the timeout. This information is also available programmatically via getter methods.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandTimeoutException(TerminatedCommand failed, long timeout, TimeUnit unit)

Method Summary

Methods

Modifier and Type	Method and Description
ImmutableList<String>	getArguments() Returns the arguments of the failed command.
String	getExecutable() Returns the failed command.
String	getMessage() Returns a description of the executed command until the time out.
CommandResult	getResult() Returns the result of executing the command until the timeout.
URI	getUri() Returns the URI of the system that executed the command.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandTimeoutException

public CommandTimeoutException(TerminatedCommand failed,
                       long timeout,
                       TimeUnit unit)

Method Detail

getExecutable

public String getExecutable()

Returns the failed command.

getArguments

public ImmutableList<String> getArguments()

Returns the arguments of the failed command.

getUri

public URI getUri()

Returns the URI of the system that executed the command.

getResult

public CommandResult getResult()

Returns the result of executing the command until the timeout. The exit status of the result is invalid.

getMessage

public String getMessage()

Returns a description of the executed command until the time out.

The description spans multiple lines and includes the:

• Executable name or path
• Argument list, with each argument surrounded by double quotes
• Working directory, if not the default
• Environment, if not the default
• Execution system URI
• Contents of the output and error streams

Overrides:

getMessage in class Throwable

Returns:

a description of the failed command