Package org.wildfly.plugin.server
Class AbstractStartMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.wildfly.plugin.common.AbstractServerConnection
-
- org.wildfly.plugin.server.AbstractStartMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled,org.apache.maven.plugin.Mojo
- Direct Known Subclasses:
AbstractServerStartMojo,StartJarMojo
public abstract class AbstractStartMojo extends AbstractServerConnection
- Author:
- James R. Perkins
-
-
Field Summary
Fields Modifier and Type Field Description protected booleandebugStarts the server with debugging enabled.protected StringdebugHostSets the hostname to listen on for debugging.protected intdebugPortSets the port the debugger should listen on.protected booleandebugSuspendIndicates whether the server should suspend itself until a debugger is attached.protected StringjavaHomeTheJAVA_HOMEto use for launching the server.protected String[]javaOptsThe JVM options to use.protected org.jboss.galleon.universe.maven.repo.MavenRepoManagermavenRepoManagerprotected org.apache.maven.execution.MavenSessionmavenSessionprotected org.apache.maven.project.MavenProjectprojectprotected StringpropertiesFileThe path to the system properties file to load.protected List<org.eclipse.aether.repository.RemoteRepository>repositoriesprotected org.eclipse.aether.RepositorySystemrepoSystemprotected String[]serverArgsThe arguments to be passed to the server.protected org.wildfly.plugin.tools.server.ServerManagerserverManagerprotected org.eclipse.aether.RepositorySystemSessionsessionprotected booleanskipSet totrueif you want to skip this goal, otherwisefalse.-
Fields inherited from class org.wildfly.plugin.common.AbstractServerConnection
DEBUG_MESSAGE_NO_CREDS, DEBUG_MESSAGE_NO_ID, DEBUG_MESSAGE_NO_SERVER_SECTION, DEBUG_MESSAGE_NO_SETTINGS_FILE, DEBUG_MESSAGE_POM_HAS_CREDS, DEBUG_MESSAGE_SETTINGS_HAS_CREDS, DEBUG_MESSAGE_SETTINGS_HAS_ID, timeout
-
-
Constructor Summary
Constructors Constructor Description AbstractStartMojo()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected ServerContextactOnServerState(org.jboss.as.controller.client.ModelControllerClient client, ServerContext context)Checks the current state of the server.protected abstract org.wildfly.core.launcher.CommandBuildercreateCommandBuilder(Path jbossHome)protected org.jboss.galleon.universe.maven.repo.MavenRepoManagercreateMavenRepoManager()protected StringgetManagementHostName()protected intgetManagementPort()protected abstract PathgetServerHome()protected voidinit()voidsetJavaOpts(String value)Allows thejavaOptsto be set as a string.protected StandardOutputstandardOutput()protected ServerContextstartServer(ServerType serverType)-
Methods inherited from class org.wildfly.plugin.common.AbstractServerConnection
createClient, getClientConfiguration, goal
-
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
-
-
-
Field Detail
-
repoSystem
@Component protected org.eclipse.aether.RepositorySystem repoSystem
-
session
@Parameter(defaultValue="${repositorySystemSession}", readonly=true, required=true) protected org.eclipse.aether.RepositorySystemSession session
-
repositories
@Parameter(defaultValue="${project.remoteProjectRepositories}", readonly=true, required=true) protected List<org.eclipse.aether.repository.RemoteRepository> repositories
-
project
@Parameter(defaultValue="${project}", readonly=true, required=true) protected org.apache.maven.project.MavenProject project
-
mavenSession
@Parameter(defaultValue="${session}", readonly=true, required=true) protected org.apache.maven.execution.MavenSession mavenSession
-
javaOpts
@Parameter(alias="java-opts", property="wildfly.javaOpts") protected String[] javaOptsThe JVM options to use.
-
javaHome
@Parameter(alias="java-home", property="java.home") protected String javaHomeTheJAVA_HOMEto use for launching the server.
-
debug
@Parameter(property="wildfly.debug", defaultValue="false") protected boolean debugStarts the server with debugging enabled.
-
debugHost
@Parameter(property="wildfly.debug.host", defaultValue="*") protected String debugHostSets the hostname to listen on for debugging. An*means all hosts.
-
debugPort
@Parameter(property="wildfly.debug.port", defaultValue="8787") protected int debugPortSets the port the debugger should listen on.
-
debugSuspend
@Parameter(property="wildfly.debug.suspend", defaultValue="false") protected boolean debugSuspendIndicates whether the server should suspend itself until a debugger is attached.
-
propertiesFile
@Parameter(alias="properties-file", property="wildfly.propertiesFile") protected String propertiesFileThe path to the system properties file to load.
-
serverArgs
@Parameter(alias="server-args", property="wildfly.serverArgs") protected String[] serverArgsThe arguments to be passed to the server.
-
skip
@Parameter(defaultValue="false", property="wildfly.skip") protected boolean skipSet totrueif you want to skip this goal, otherwisefalse.
-
serverManager
protected org.wildfly.plugin.tools.server.ServerManager serverManager
-
mavenRepoManager
protected org.jboss.galleon.universe.maven.repo.MavenRepoManager mavenRepoManager
-
-
Method Detail
-
init
protected void init() throws org.apache.maven.plugin.MojoExecutionException- Throws:
org.apache.maven.plugin.MojoExecutionException
-
createMavenRepoManager
protected org.jboss.galleon.universe.maven.repo.MavenRepoManager createMavenRepoManager() throws org.apache.maven.plugin.MojoExecutionException- Throws:
org.apache.maven.plugin.MojoExecutionException
-
getServerHome
protected abstract Path getServerHome() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
- Throws:
org.apache.maven.plugin.MojoExecutionExceptionorg.apache.maven.plugin.MojoFailureException
-
startServer
protected ServerContext startServer(ServerType serverType) throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
- Throws:
org.apache.maven.plugin.MojoExecutionExceptionorg.apache.maven.plugin.MojoFailureException
-
createCommandBuilder
protected abstract org.wildfly.core.launcher.CommandBuilder createCommandBuilder(Path jbossHome) throws org.apache.maven.plugin.MojoExecutionException
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
standardOutput
protected StandardOutput standardOutput() throws IOException
- Throws:
IOException
-
setJavaOpts
public void setJavaOpts(String value)
Allows thejavaOptsto be set as a string. The string is assumed to be space delimited.- Parameters:
value- a spaced delimited value of JVM options
-
actOnServerState
protected ServerContext actOnServerState(org.jboss.as.controller.client.ModelControllerClient client, ServerContext context) throws IOException, org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
Checks the current state of the server. If the server is in a state ofClientConstants.CONTROLLER_PROCESS_STATE_RESTART_REQUIRED, the process is restarted and a newServerContextis returned. If the server is in a stat ofClientConstants.CONTROLLER_PROCESS_STATE_RELOAD_REQUIRED, the server will be reloaded and wait until the server is running. If the server is in any other state, other thanClientConstants.CONTROLLER_PROCESS_STATE_RUNNING, a warning message is logged to let the user know the state is unknown.- Parameters:
client- the client used to communicate with the servercontext- the current server context- Returns:
- a new context if a restart was required, otherwise the same context
- Throws:
IOException- if an error occurs communicating with the serverorg.apache.maven.plugin.MojoExecutionException- if a failure occurs checking the state or reloading the serverorg.apache.maven.plugin.MojoFailureException- if a failure occurs checking the state or reloading the server
-
getManagementPort
protected int getManagementPort()
- Overrides:
getManagementPortin classAbstractServerConnection
-
getManagementHostName
protected String getManagementHostName()
- Overrides:
getManagementHostNamein classAbstractServerConnection
-
-