org.n0pe.asadmin
Interface IAsAdminCmd

All Known Implementing Classes:

AbstractAsAdminCmd, AddResources, Cluster, CreateAuthRealm, CreateFileUser, CreateJdbcConnectionPool, CreateJdbcResource, CreateMessageSecurityProvider, Database, DeleteFileUser, DeleteJdbcConnectionPool, DeleteJdbcResource, DeleteMessageSecurityProvider, Deployment, Domain, EnableSecureAdmin, Get, GetHealth, ListApplicationRefs, ListDomains, ListFileUsers, PingConnectionPool, Set, UpdateFileUser, Uptime

public interface IAsAdminCmd

Method Summary

boolean	failOnNonZeroExit() If asadmin command return is non zero the command will be given the change to say whether they wish to fail based on the contents of stdout and stderr they have been passed.
String	getActionCommand()
Reader	getErrorOutput()
String[]	getParameters()
Reader	getStandardOutput()
String	handlePasswordFile(String configuredPasswordFile) Hooks called by AsAdmin to allow commands to impact the configured password file.
boolean	needCredentials()
void	setOkayErrorPattern(Pattern pattern) Pass a Pattern which can be used to match the stderr output if the asadmin exits with a non zero value.
void	setOkayStdOutPattern(Pattern pattern) Pass a Pattern which can be used to match the stdout output if the asadmin exits with a non zero value.

Method Detail

getStandardOutput

Reader getStandardOutput()

getErrorOutput

Reader getErrorOutput()

needCredentials

boolean needCredentials()

handlePasswordFile

String handlePasswordFile(String configuredPasswordFile)
                          throws AsAdminException

Hooks called by AsAdmin to allow commands to impact the configured password file.

Parameters:

configuredPasswordFile - Configured password file

Returns:

Password file, same or changed if needed

Throws:

AsAdminException

getActionCommand

String getActionCommand()

getParameters

String[] getParameters()

failOnNonZeroExit

boolean failOnNonZeroExit()

If asadmin command return is non zero the command will be given the change to say whether they wish to fail based on the contents of stdout and stderr they have been passed. For example a DeployMojo executing an undeploy command which has failOnCommandSpecificErrors set to false will elect not to fail if the error output was along the lines of "remote failure: Application my-ear is not deployed on this target [server]" during an mvn clean or testing cycle...

Returns:

whether this command should cause the plugin to fail, or whether it is acceptable to continue.

setOkayErrorPattern

void setOkayErrorPattern(Pattern pattern)

Pass a Pattern which can be used to match the stderr output if the asadmin exits with a non zero value. If the Pattern matches the stderr output (multiline) the plugin will not throw an exception but just log the fact that it is continuing

setOkayStdOutPattern

void setOkayStdOutPattern(Pattern pattern)

Pass a Pattern which can be used to match the stdout output if the asadmin exits with a non zero value. If the Pattern matches the stdout output (multiline) the plugin will not throw an exception but just log the fact that it is continuing This is necessary as some asadmin subcommands cause it to exit with non zero, but it writes the error to stdout. start-domain writes its output there. If setOkayErrorPattern is not set then only setOkayStdOutPattern will be checked, which by default determines the value returned by failOnNonZeroExit If setOkayErrorPattern is set and setOkayStdOutPattern is not set then only setOkayErrorPattern will determine what failOnNonZeroExit returns If setOkayErrorPattern is set and setOkayStdOutPattern is set then BOTH setOkayErrorPattern and setOkayStdOutPattern must match if failOnNonZeroExit is to return false