Nested and Inner Type Summary

Modifier and Type	Class and Description
public class	ExecuteShellCommandChange.StreamGobbler

Field Summary

Modifier and Type	Field and Description
private final List<String>	args
private String	executable
protected List<String>	finalCommandArray
private static final Long	HOUR_IN_MILLIS
protected Integer	maxStreamGobblerOutput
private static final Long	MIN_IN_MILLIS
private List<String>	os
private static final Long	SECS_IN_MILLIS
private String	timeout
private static final Pattern	TIMEOUT_PATTERN
private static final String	TIMEOUT_REGEX

Inherited from liquibase.change.AbstractChange:: NODENAME_COLUMN

Constructor Summary

Access	Constructor and Description
public	ExecuteShellCommandChange()

Method Summary

Modifier and Type	Method and Description
public void	addArg(String arg)
protected ExecuteShellCommandChange.StreamGobbler	createErrorGobbler(InputStream processStream, OutputStream outputStream)
protected List<String>	createFinalCommandArray(Database database)
protected ProcessBuilder	createProcessBuilder(Database database)
protected void	customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) Overrides liquibase.change.AbstractChange.customLoadLogic.
protected void	executeCommand(Database database)
public boolean	generateRollbackStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateRollbackStatementsVolatile. Implements liquibase.change.Change.generateRollbackStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateRollbackStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements` If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.
public SqlStatement[]	generateStatements(final Database database) Implements liquibase.change.Change.generateStatements. Generates the `SqlStatement` objects required to run the change for the given database.
public boolean	generateStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateStatementsVolatile. Implements liquibase.change.Change.generateStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements`.
public List<String>	getArgs()
protected String	getCommandString()
public String	getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Confirmation message to be displayed after the change is executed.
public String	getExecutable()
protected Integer	getMaxStreamGobblerOutput() Max bytes to copy from output to `processResult(int, String, String, Database)`.
public List<String>	getOs()
public String	getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.
public String	getTimeout()
protected long	Returns: the timeout value in millisecond getTimeoutInMillis()
protected void	processResult(int returnCode, String errorStreamOut, String infoStreamOut, Database database) Called by `executeCommand(Database)` after running the command.
public void	setExecutable(String executable)
public void	setOs(String os)
public void	setTimeout(String timeout)
public String	toString() Overrides liquibase.change.AbstractChange.toString. Returns a string representation of the object.
public ValidationErrors	validate(Database database) Overrides liquibase.change.AbstractChange.validate. Implements liquibase.change.Change.validate. Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the `liquibase.sqlgenerator.SqlGenerator#validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)` method on the `SqlStatement` objects returned by `generateStatements`.
private int	waitForOrKill(final Process process, final long waits for specified timeoutInMillis before destroying the process. timeoutInMillis) Waits for the process to complete and kills it if the process is not finished after the specified `timeoutInMillis`.
public Warnings	warn(Database database) Overrides liquibase.change.AbstractChange.warn. Implements liquibase.change.Change.warn. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#warn(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)` method on the `SqlStatement` objects returned by `generateStatements`.

Field Detail

args	back to summary
private final List<String> args

executable	back to summary
private String executable

finalCommandArray	back to summary
protected List<String> finalCommandArray

HOUR_IN_MILLIS	back to summary
private static final Long HOUR_IN_MILLIS

maxStreamGobblerOutput	back to summary
protected Integer maxStreamGobblerOutput

MIN_IN_MILLIS	back to summary
private static final Long MIN_IN_MILLIS

os	back to summary
private List<String> os

SECS_IN_MILLIS	back to summary
private static final Long SECS_IN_MILLIS

timeout	back to summary
private String timeout

TIMEOUT_PATTERN	back to summary
private static final Pattern TIMEOUT_PATTERN

TIMEOUT_REGEX	back to summary
private static final String TIMEOUT_REGEX

Constructor Detail

ExecuteShellCommandChange	back to summary
public ExecuteShellCommandChange()

Method Detail

addArg	back to summary
public void addArg(String arg)

createErrorGobbler	back to summary
protected ExecuteShellCommandChange.StreamGobbler createErrorGobbler(InputStream processStream, OutputStream outputStream)

createFinalCommandArray	back to summary
protected List<String> createFinalCommandArray(Database database)

createProcessBuilder	back to summary
protected ProcessBuilder createProcessBuilder(Database database)

customLoadLogic	back to summary
protected void customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException Overrides liquibase.change.AbstractChange.customLoadLogic. Annotations @Override

customLoadLogic

back to summary

protected void customLoadLogic(ParsedNode parsedNode, ResourceAccessor resourceAccessor) throws ParsedNodeException

Overrides liquibase.change.AbstractChange.customLoadLogic.

Annotations

@Override

executeCommand	back to summary
protected void executeCommand(Database database) throws Exception

generateRollbackStatementsVolatile back to summary

generateRollbackStatementsVolatile	back to summary
public boolean generateRollbackStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateRollbackStatementsVolatile. Implements liquibase.change.Change.generateRollbackStatementsVolatile. Doc from liquibase.change.AbstractChange.generateRollbackStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateRollbackStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements` If no or null SqlStatements are returned by generateRollbackStatements then this method returns false. Annotations @Override

public boolean generateRollbackStatementsVolatile(Database database)

Overrides liquibase.change.AbstractChange.generateRollbackStatementsVolatile.

Implements liquibase.change.Change.generateRollbackStatementsVolatile.

Doc from liquibase.change.AbstractChange.generateRollbackStatementsVolatile.

Implementation delegates logic to the liquibase.sqlgenerator.SqlGenerator#generateRollbackStatementsIsVolatile(Database) method on the SqlStatement objects returned by generateStatements If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.

Annotations

@Override

generateStatements back to summary

generateStatements	back to summary
public SqlStatement[] generateStatements(final Database database) Implements liquibase.change.Change.generateStatements. Doc from liquibase.change.Change.generateStatements. Generates the `SqlStatement` objects required to run the change for the given database. NOTE: This method may be called multiple times throughout the changelog execution process and may be called in documentation generation and other integration points as well. If this method reads from the current database state or uses any other logic that will be affected by whether previous changeSets have ran or not, you must return true from `generateStatementsVolatile`. Annotations @Override

public SqlStatement[] generateStatements(final Database database)

Implements liquibase.change.Change.generateStatements.

Doc from liquibase.change.Change.generateStatements.

Generates the SqlStatement objects required to run the change for the given database.

NOTE: This method may be called multiple times throughout the changelog execution process and may be called in documentation generation and other integration points as well.

If this method reads from the current database state or uses any other logic that will be affected by whether previous changeSets have ran or not, you must return true from generateStatementsVolatile.

Annotations

@Override

generateStatementsVolatile back to summary

generateStatementsVolatile	back to summary
public boolean generateStatementsVolatile(Database database) Overrides liquibase.change.AbstractChange.generateStatementsVolatile. Implements liquibase.change.Change.generateStatementsVolatile. Doc from liquibase.change.AbstractChange.generateStatementsVolatile. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database)` method on the `SqlStatement` objects returned by `generateStatements`. If zero or null SqlStatements are returned by generateStatements then this method returns false. Annotations @Override

public boolean generateStatementsVolatile(Database database)

Overrides liquibase.change.AbstractChange.generateStatementsVolatile.

Implements liquibase.change.Change.generateStatementsVolatile.

Doc from liquibase.change.AbstractChange.generateStatementsVolatile.

Implementation delegates logic to the liquibase.sqlgenerator.SqlGenerator#generateStatementsIsVolatile(Database) method on the SqlStatement objects returned by generateStatements. If zero or null SqlStatements are returned by generateStatements then this method returns false.

Annotations

@Override

getArgs	back to summary
public List<String> getArgs()

getCommandString	back to summary
protected String getCommandString()

getConfirmationMessage	back to summary
public String getConfirmationMessage() Implements liquibase.change.Change.getConfirmationMessage. Doc from liquibase.change.Change.getConfirmationMessage. Confirmation message to be displayed after the change is executed. Should include relevant configuration settings to make it as helpful as possible. This method may be called outside the changelog execution process, such as in documentation generation. Annotations @Override

getConfirmationMessage

back to summary

public String getConfirmationMessage()

Implements liquibase.change.Change.getConfirmationMessage.

Doc from liquibase.change.Change.getConfirmationMessage.

Confirmation message to be displayed after the change is executed. Should include relevant configuration settings to make it as helpful as possible. This method may be called outside the changelog execution process, such as in documentation generation.

Annotations

@Override

getExecutable	back to summary
public String getExecutable() Annotations @DatabaseChangeProperty description:Name of the executable to run exampleValue:mysqldump requiredForDatabase:all

getMaxStreamGobblerOutput	back to summary
protected Integer getMaxStreamGobblerOutput() Max bytes to copy from output to `processResult(int, String, String, Database)`. If null, process all output.

getOs	back to summary
public List<String> getOs() Annotations @DatabaseChangeProperty exampleValue:Windows 7 description:List of operating systems on which to execute the command (taken from the os.name Java system property)

getSerializedObjectNamespace	back to summary
public String getSerializedObjectNamespace() Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace. Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace. Annotations @Override

getSerializedObjectNamespace

back to summary

public String getSerializedObjectNamespace()

Overrides liquibase.change.AbstractChange.getSerializedObjectNamespace.

Implements liquibase.serializer.LiquibaseSerializable.getSerializedObjectNamespace.

Annotations

@Override

getTimeout	back to summary
public String getTimeout() Annotations @DatabaseChangeProperty description:Timeout value for the executable to run exampleValue:10s

getTimeoutInMillis	back to summary
protected long getTimeoutInMillis() Returns:long the timeout value in millisecond

processResult	back to summary
protected void processResult(int returnCode, String errorStreamOut, String infoStreamOut, Database database) Called by `executeCommand(Database)` after running the command. Default implementation throws an error if returnCode != 0

setExecutable	back to summary
public void setExecutable(String executable)

setOs	back to summary
public void setOs(String os)

setTimeout	back to summary
public void setTimeout(String timeout)

toString back to summary

toString	back to summary
public String toString() Overrides liquibase.change.AbstractChange.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides liquibase.change.AbstractChange.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

validate back to summary

validate	back to summary
public ValidationErrors validate(Database database) Overrides liquibase.change.AbstractChange.validate. Implements liquibase.change.Change.validate. Doc from liquibase.change.AbstractChange.validate. Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the `liquibase.sqlgenerator.SqlGenerator#validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)` method on the `SqlStatement` objects returned by `generateStatements`. If no or null SqlStatements are returned by generateStatements then this method returns no errors. If there are no parameters than this method returns no errors Annotations @Override

public ValidationErrors validate(Database database)

Overrides liquibase.change.AbstractChange.validate.

Implements liquibase.change.Change.validate.

Doc from liquibase.change.AbstractChange.validate.

Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the liquibase.sqlgenerator.SqlGenerator#validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by generateStatements. If no or null SqlStatements are returned by generateStatements then this method returns no errors. If there are no parameters than this method returns no errors

Annotations

@Override

waitForOrKill back to summary

waitForOrKill	back to summary
private int waitForOrKill(final Process process, final long timeoutInMillis) throws TimeoutException Waits for the process to complete and kills it if the process is not finished after the specified `timeoutInMillis`. Creates a scheduled task to destroy the process in given timeout milliseconds. This killer task will be cancelled if the process returns before the timeout value. Parameters timeoutInMillis:long waits for specified timeoutInMillis before destroying the process. Annotations @SuppressWarnings:squid:S2142

private int waitForOrKill(final Process process, final long timeoutInMillis) throws TimeoutException

Waits for the process to complete and kills it if the process is not finished after the specified timeoutInMillis.

Creates a scheduled task to destroy the process in given timeout milliseconds. This killer task will be cancelled if the process returns before the timeout value.

Parameters

timeoutInMillis:long: waits for specified timeoutInMillis before destroying the process.

Annotations

@SuppressWarnings:squid:S2142

warn back to summary

warn	back to summary
public Warnings warn(Database database) Overrides liquibase.change.AbstractChange.warn. Implements liquibase.change.Change.warn. Doc from liquibase.change.AbstractChange.warn. Implementation delegates logic to the `liquibase.sqlgenerator.SqlGenerator#warn(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain)` method on the `SqlStatement` objects returned by `generateStatements`. If a generated statement is not supported for the given database, no warning will be added since that is a validation error. If no or null SqlStatements are returned by generateStatements then this method returns no warnings. Annotations @Override

public Warnings warn(Database database)

Overrides liquibase.change.AbstractChange.warn.

Implements liquibase.change.Change.warn.

Doc from liquibase.change.AbstractChange.warn.

Implementation delegates logic to the liquibase.sqlgenerator.SqlGenerator#warn(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by generateStatements. If a generated statement is not supported for the given database, no warning will be added since that is a validation error. If no or null SqlStatements are returned by generateStatements then this method returns no warnings.

Annotations

@Override

liquibase.change.core back to summary

public Class ExecuteShellCommandChange.StreamGobbler

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
liquibase.change.core.ExecuteShellCommandChange.StreamGobbler

Field Summary

Modifier and Type	Field and Description
pack-priv long	copiedSize
pack-priv boolean	loggedTruncated
private final OutputStream	outputStream
private final Thread	parentThread
private InputStream	processStream
private static final int	THREAD_SLEEP_MILLIS

Inherited from java.lang.Thread:: MAX_PRIORITY MIN_PRIORITY NORM_PRIORITY

Constructor Summary

Access	Constructor and Description
public	StreamGobbler(InputStream processStream, OutputStream outputStream, Thread parentThread)

Method Summary

Modifier and Type	Method and Description
public void	copy(InputStream inputStream, OutputStream outputStream)
public void	finish()
public void	run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. This method is run by the thread when it executes.

Field Detail

copiedSize	back to summary
pack-priv long copiedSize

loggedTruncated	back to summary
pack-priv boolean loggedTruncated

outputStream	back to summary
private final OutputStream outputStream

parentThread	back to summary
private final Thread parentThread

processStream	back to summary
private InputStream processStream

THREAD_SLEEP_MILLIS	back to summary
private static final int THREAD_SLEEP_MILLIS

Constructor Detail

StreamGobbler	back to summary
public StreamGobbler(InputStream processStream, OutputStream outputStream, Thread parentThread)

Method Detail

copy	back to summary
public void copy(InputStream inputStream, OutputStream outputStream) throws IOException

finish	back to summary
public void finish()

run back to summary

public void run()

Overrides java.lang.Thread.run.

Implements java.lang.Runnable.run.

Doc from java.lang.Thread.run.

This method is run by the thread when it executes. Subclasses of Thread may override this method.

This method is not intended to be invoked directly. If this thread is a platform thread created with a Runnable task then invoking this method will invoke the task's run method. If this thread is a virtual thread then invoking this method directly does nothing.

Annotations

@Override