Package liquibase.change.core

Class ExecuteShellCommandChange

java.lang.Object

liquibase.AbstractExtensibleObject

liquibase.plugin.AbstractPlugin

liquibase.change.AbstractChange

liquibase.change.core.ExecuteShellCommandChange

All Implemented Interfaces:

Cloneable, Change, ExtensibleObject, Plugin, LiquibaseSerializable

public class ExecuteShellCommandChange
extends AbstractChange

Executes a given shell executable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ExecuteShellCommandChange.StreamGobbler

Nested classes/interfaces inherited from interface liquibase.serializer.LiquibaseSerializable

LiquibaseSerializable.SerializationType

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	finalCommandArray
protected Integer	maxStreamGobblerOutput

Fields inherited from class liquibase.change.AbstractChange

NODENAME_COLUMN

Fields inherited from interface liquibase.change.Change

EMPTY_CHANGE, SHOULD_EXECUTE

Fields inherited from interface liquibase.serializer.LiquibaseSerializable

GENERIC_CHANGELOG_EXTENSION_NAMESPACE, GENERIC_SNAPSHOT_EXTENSION_NAMESPACE, STANDARD_CHANGELOG_NAMESPACE, STANDARD_SNAPSHOT_NAMESPACE

Fields inherited from interface liquibase.plugin.Plugin

PRIORITY_DATABASE, PRIORITY_DEFAULT, PRIORITY_NOT_APPLICABLE, PRIORITY_SPECIALIZED

Constructor Summary

Constructors

Constructor	Description
ExecuteShellCommandChange()

Method Summary

Modifier and Type	Method	Description
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)
protected void	executeCommand(Database database)
void	finishInitialization()	Default implementation is a no-op
boolean	generateRollbackStatementsVolatile(Database database)	Implementation delegates logic to the SqlGenerator.generateRollbackStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database) If no or null SqlStatements are returned by generateRollbackStatements then this method returns false.
SqlStatement[]	generateStatements(Database database)	Generates the SqlStatement objects required to run the change for the given database.
boolean	generateStatementsVolatile(Database database)	Implementation delegates logic to the SqlGenerator.generateStatementsIsVolatile(Database) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database).
List<String>	getArgs()
protected String	getCommandString()
String	getConfirmationMessage()	Confirmation message to be displayed after the change is executed.
String	getExecutable()
protected Integer	getMaxStreamGobblerOutput()	Max bytes to copy from output to processResult(int, String, String, Database).
List<String>	getOs()
String	getSerializedObjectNamespace()
String	getTimeout()
protected long	getTimeoutInMillis()
protected void	processResult(int returnCode, String errorStreamOut, String infoStreamOut, Database database)	Called by executeCommand(Database) after running the command.
void	setOs(String os)
boolean	shouldRunOnOs()	Default implementation always returns true.
String	toString()
ValidationErrors	validate(Database database)	Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the SqlGenerator.validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database).
Warnings	warn(Database database)	Implementation delegates logic to the SqlGenerator.warn(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database).

Methods inherited from class liquibase.change.AbstractChange

checkStatus, createAlternateParameterNames, createChangeMetaData, createChangeParameterMetadata, createDescriptionMetaData, createEmptyColumnConfig, createExampleValueMetaData, createInverses, createMustEqualExistingMetaData, createRequiredDatabasesMetaData, createSerializationTypeMetaData, createSinceMetaData, createSupportedDatabasesMetaData, equals, generateCheckSum, generateRollbackStatements, getAffectedDatabaseObjects, getChangeSet, getDescription, getExcludedFieldFilters, getResourceAccessor, getSerializableFieldNamespace, getSerializableFields, getSerializableFieldType, getSerializableFieldValue, getSerializedObjectName, hashCode, isInvalidProperty, load, modify, serialize, serializeValue, setChangeSet, setResourceAccessor, shouldExecuteChange, supports, supportsRollback

Methods inherited from class liquibase.AbstractExtensibleObject

clone, describe, get, get, get, getAttributes, getFieldValue, getObjectMetaData, getValuePath, has, set

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface liquibase.ExtensibleObject

clone, describe, get, get, getAttributes, getObjectMetaData, getValuePath, has, set

Field Details

finalCommandArray

protected List<String> finalCommandArray

maxStreamGobblerOutput

protected Integer maxStreamGobblerOutput

Constructor Details

ExecuteShellCommandChange

public ExecuteShellCommandChange()

Method Details

shouldRunOnOs

public boolean shouldRunOnOs()

Description copied from interface: Change

Default implementation always returns true. Any implementation can override. Currently only ExecuteShellCommandChange overrides

Returns:

boolean

generateStatementsVolatile

public boolean generateStatementsVolatile(Database database)

Description copied from class: AbstractChange

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

Specified by:

generateStatementsVolatile in interface Change

Overrides:

generateStatementsVolatile in class AbstractChange

generateRollbackStatementsVolatile

public boolean generateRollbackStatementsVolatile(Database database)

Description copied from class: AbstractChange

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

Specified by:

generateRollbackStatementsVolatile in interface Change

Overrides:

generateRollbackStatementsVolatile in class AbstractChange

getExecutable

public String getExecutable()

getArgs

public List<String> getArgs()

addArg

public void addArg(String arg)

getTimeout

public String getTimeout()

getOs

public List<String> getOs()

setOs

public void setOs(String os)

validate

public ValidationErrors validate(Database database)

Description copied from class: AbstractChange

Implementation checks the ChangeParameterMetaData for declared required fields and also delegates logic to the SqlGenerator.validate(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database). 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

Specified by:

validate in interface Change

Overrides:

validate in class AbstractChange

finishInitialization

public void finishInitialization()
                          throws SetupException

Description copied from class: AbstractChange

Default implementation is a no-op

Specified by:

finishInitialization in interface Change

Overrides:

finishInitialization in class AbstractChange

Throws:

SetupException

warn

public Warnings warn(Database database)

Description copied from class: AbstractChange

Implementation delegates logic to the SqlGenerator.warn(liquibase.statement.SqlStatement, liquibase.database.Database, liquibase.sqlgenerator.SqlGeneratorChain) method on the SqlStatement objects returned by Change.generateStatements(liquibase.database.Database). 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.

Specified by:

warn in interface Change

Overrides:

warn in class AbstractChange

generateStatements

public SqlStatement[] generateStatements(Database database)

Description copied from interface: Change

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 Change.generateStatementsVolatile(liquibase.database.Database).

createFinalCommandArray

protected List<String> createFinalCommandArray(Database database)

executeCommand

protected void executeCommand(Database database)
                       throws Exception

Throws:

Exception

createErrorGobbler

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

getMaxStreamGobblerOutput

protected Integer getMaxStreamGobblerOutput()

Max bytes to copy from output to processResult(int, String, String, Database). If null, process all output.

Returns:

getTimeoutInMillis

protected long getTimeoutInMillis()

Returns:

the timeout value in millisecond

processResult

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

createProcessBuilder

protected ProcessBuilder createProcessBuilder(Database database)

getConfirmationMessage

public String getConfirmationMessage()

Description copied from interface: Change

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.

getCommandString

protected String getCommandString()

getSerializedObjectNamespace

public String getSerializedObjectNamespace()

Specified by:

getSerializedObjectNamespace in interface LiquibaseSerializable

Overrides:

getSerializedObjectNamespace in class AbstractChange

customLoadLogic

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

Overrides:

customLoadLogic in class AbstractChange

Throws:

ParsedNodeException

toString

public String toString()

Overrides:

toString in class AbstractChange