Class DomainManager

java.lang.Object

org.wildfly.plugin.tools.server.DomainManager

All Implemented Interfaces:

AutoCloseable, ServerManager

public class DomainManager
extends Object

A utility for executing management operations on domain servers.

Author:

James R. Perkins

Nested Class Summary

Nested classes/interfaces inherited from interface ServerManager

ServerManager.Builder

Field Summary

Fields inherited from interface ServerManager

TIMEOUT

Method Summary

Modifier and Type	Method	Description
ServerManager	addServerManagerListener(ServerManagerListener listener)	Adds a ServerManagerListener to be notified of server manager events.
org.jboss.as.controller.client.helpers.domain.DomainClient	client()	Returns the client associated with this server manager.
void	close()
ContainerDescription	containerDescription()	Returns the container description for the running server.
ServerManager	deploy(Deployment deployment)	Deploys content to the server.
DeploymentManager	deploymentManager()	Returns the deployment manager for the server.
org.jboss.dmr.ModelNode	determineHostAddress()	Determines the address for the host being used.
void	executeReload()	Reloads the server and returns immediately.
void	executeReload(org.jboss.dmr.ModelNode reloadOp)	Reloads the server and returns immediately.
boolean	isClosed()	Checks if this server manager has been closed.
boolean	isRunning()	Checks to see if the domain is running.
CompletableFuture<ServerManager>	kill()	If a process is available and alive, the process is attempted to be killed.
String	launchType()	Determines the servers "launch-type".
void	reloadIfRequired(long timeout, TimeUnit unit)	Checks if the container status is "reload-required" and if it's the case, executes reload and waits for completion.
boolean	removeServerManagerListener(ServerManagerListener listener)	Removes a previously added ServerManagerListener from this server manager.
String	serverState()	Gets the "server-state" for standalone servers or the "host-state" for domain servers.
void	shutdown(long timeout)	Shuts down the server and wait for the servers to be shutdown.
CompletableFuture<ServerManager>	shutdownAsync(long timeout)	Shuts down the server.
ServerManager	start(long timeout, TimeUnit unit)	Starts a server and waits for it to reach a running state.
CompletionStage<ServerManager>	startAsync(long timeout, TimeUnit unit)	Asynchronously starts a server and waits the amount of time defined by the timeout and the time unit.
String	takeSnapshot()	Takes a snapshot of the current servers configuration and returns the relative file name of the snapshot.
ServerManager	undeploy(DeploymentDescription deployment)	Undeploys content from the server.
boolean	waitFor(long startupTimeout, TimeUnit unit)	Waits the given amount of time for a server to start.

Methods inherited from class Object

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

Methods inherited from interface ServerManager

asManaged, executeOperation, executeOperation, reloadIfRequired, shutdown, shutdownAsync, start, startAsync, waitFor

Method Details

serverState

public String serverState()

Description copied from interface: ServerManager

Gets the "server-state" for standalone servers or the "host-state" for domain servers.

Returns:

the server-state or "failed" if an error occurred

determineHostAddress

public org.jboss.dmr.ModelNode determineHostAddress()
                                             throws OperationExecutionException,
IOException

Determines the address for the host being used.

Returns:

the address of the host

Throws:

IOException - if an error occurs communicating with the server

OperationExecutionException - if the operation used to determine the host name fails

isRunning

public boolean isRunning()

Checks to see if the domain is running. If the server is not in admin only mode each servers running state is checked. If any server is not in a started state the domain is not considered to be running.

Returns:

true if the server is in a running state, otherwise false

executeReload

public void executeReload()
                   throws IOException,
OperationExecutionException

Description copied from interface: ServerManager

Reloads the server and returns immediately.

Throws:

IOException - if an error occurs communicating with the server

OperationExecutionException

reloadIfRequired

public void reloadIfRequired(long timeout,
 TimeUnit unit)
                      throws IOException

Description copied from interface: ServerManager

Checks if the container status is "reload-required" and if it's the case, executes reload and waits for completion.

Parameters:

timeout - the time to wait for the server to reload

unit - the time unit for the timeout argument

Throws:

IOException - if an error occurs communicating with the server

client

public org.jboss.as.controller.client.helpers.domain.DomainClient client()

Description copied from interface: ServerManager

Returns the client associated with this server manager.

Specified by:

client in interface ServerManager

Returns:

a client to communicate with the server

containerDescription

public ContainerDescription containerDescription()
                                          throws IOException

Description copied from interface: ServerManager

Returns the container description for the running server.

Specified by:

containerDescription in interface ServerManager

Returns:

the container description for the running server

Throws:

IOException - if an error occurs communicating with the server

deploymentManager

public DeploymentManager deploymentManager()

Description copied from interface: ServerManager

Returns the deployment manager for the server.

Specified by:

deploymentManager in interface ServerManager

Returns:

the deployment manager

launchType

public String launchType()

Determines the servers "launch-type".

Specified by:

launchType in interface ServerManager

Returns:

the servers launch-type or "unknown" if it could not be determined

kill

public CompletableFuture<ServerManager> kill()

Description copied from interface: ServerManager

If a process is available and alive, the process is attempted to be killed. Note in cases where the process is not associated with this server manager, this method does nothing.

The returned ServerManager is the same instance of this server manager. You can use the CompletableFuture.get() to wait until the process, if available, to exit.

Specified by:

kill in interface ServerManager

Returns:

a completable future that on a CompletableFuture.get() will wait for the process, if available, exits

waitFor

public boolean waitFor(long startupTimeout,
 TimeUnit unit)
                throws InterruptedException

Description copied from interface: ServerManager

Waits the given amount of time for a server to start.

If the process is not null and a timeout occurs the process will be destroyed.

Specified by:

waitFor in interface ServerManager

Parameters:

startupTimeout - the time, to wait for the server start

unit - the time unit for the startupTimeout argument

Returns:

true if the server is up and running, false if a timeout occurred waiting for the server to be in a running state

Throws:

InterruptedException - if interrupted while waiting for the server to start

addServerManagerListener

public ServerManager addServerManagerListener(ServerManagerListener listener)

Description copied from interface: ServerManager

Adds a ServerManagerListener to be notified of server manager events.

Listeners are invoked in the order they are added (FIFO) for all events except beforeShutdown, which uses reverse order (LIFO) to allow proper cleanup of resources.

Event Ordering:

• ServerManagerListener.afterStart(ServerManager) - after successful server start
• ServerManagerListener.beforeShutdown(ServerManager) - before server shutdown (LIFO order)
• ServerManagerListener.beforeDeploy(ServerManager, Deployment) - before deployment
• ServerManagerListener.afterDeploy(ServerManager, Deployment) - after successful deployment
• ServerManagerListener.deployFailed(ServerManager, Deployment, Throwable) - on deployment failure
• ServerManagerListener.beforeUndeploy(ServerManager, DeploymentDescription) - before undeployment
• ServerManagerListener.afterUndeploy(ServerManager, DeploymentDescription) - after successful undeployment
• ServerManagerListener.undeployFailed(ServerManager, DeploymentDescription, Throwable) - on undeployment failure

Thread Safety: This method is thread-safe. Listeners are stored in a concurrent collection and can be added at any time, even while the server is running.

Specified by:

addServerManagerListener in interface ServerManager

Parameters:

listener - the listener to add (must not be null)

Returns:

this server manager instance for method chaining

removeServerManagerListener

public boolean removeServerManagerListener(ServerManagerListener listener)

Description copied from interface: ServerManager

Removes a previously added ServerManagerListener from this server manager.

Once removed, the listener will no longer receive notifications for any subsequent server manager events. If the listener is currently being invoked when this method is called, it will complete its current invocation but will not be called for future events.

Thread Safety: This method is thread-safe and can be called at any time, even while the server is running or events are being processed.

Specified by:

removeServerManagerListener in interface ServerManager

Parameters:

listener - the listener to remove

Returns:

true if the listener was found and removed, false if the listener was not registered

takeSnapshot

public String takeSnapshot()
                    throws IOException,
OperationExecutionException

Takes a snapshot of the current servers configuration and returns the relative file name of the snapshot.

This simply executes the take-snapshot operation with no arguments.

Specified by:

takeSnapshot in interface ServerManager

Returns:

the file name of the snapshot configuration file

Throws:

IOException - if an error occurs executing the operation

OperationExecutionException - if the take-snapshot operation fails

executeReload

public void executeReload(org.jboss.dmr.ModelNode reloadOp)
                   throws IOException,
OperationExecutionException

Reloads the server and returns immediately.

Specified by:

executeReload in interface ServerManager

Parameters:

reloadOp - the reload operation to execute

Throws:

OperationExecutionException - if the reload operation fails

IOException - if an error occurs communicating with the server

start

public ServerManager start(long timeout,
 TimeUnit unit)

Description copied from interface: ServerManager

Starts a server and waits for it to reach a running state.

This method can be used to start a server that was created using ServerManager.of(Configuration) or to restart a server that was previously shutdown.

Thread Safety: This method is thread-safe and uses internal locking to ensure only one server instance can be started at a time. If multiple threads attempt to start the server concurrently, only one will succeed and the others will receive a ServerManagerException.

Lifecycle:

• If the server is already running, throws a ServerManagerException
• On successful start, the server manager becomes operational and ready for use
• On failure or timeout, the server process is cleaned up and the error state is restored

Relationship with other methods:

• ServerManager.shutdown() must be called before calling start() again to restart a server
• ServerManager.close() may shutdown the server if configured with shutdownOnClose

Specified by:

start in interface ServerManager

Parameters:

timeout - the maximum time to wait for the server to start

unit - the time unit for the timeout parameter

Returns:

this server manager instance

startAsync

public CompletionStage<ServerManager> startAsync(long timeout,
 TimeUnit unit)

Description copied from interface: ServerManager

Asynchronously starts a server and waits the amount of time defined by the timeout and the time unit.

Specified by:

startAsync in interface ServerManager

Parameters:

timeout - the timeout

unit - the unit for the timeout

Returns:

a completion stage with the started server if the server starts within timeout constraints

See Also:

• ServerManager.start(long, TimeUnit)

shutdown

public void shutdown(long timeout)
              throws IOException

Description copied from interface: ServerManager

Shuts down the server and wait for the servers to be shutdown.

Specified by:

shutdown in interface ServerManager

Parameters:

timeout - the graceful shutdown timeout, a value of -1 will wait indefinitely and a value of 0 will not attempt a graceful shutdown

Throws:

IOException - if an error occurs communicating with the server

shutdownAsync

public CompletableFuture<ServerManager> shutdownAsync(long timeout)

Description copied from interface: ServerManager

Shuts down the server.

The returned ServerManager is the same instance of this server manager. You can use the CompletableFuture.get() to wait until the process, if available, to exit.

Note for implementations. The default method should likely not be used. Care must be taken to ensure a TimeoutException on a CompletableFuture.get() stops the shutdown from continuing to run in the background.

Specified by:

shutdownAsync in interface ServerManager

Parameters:

timeout - the graceful shutdown timeout, a value of -1 will wait indefinitely and a value of 0 will not attempt a graceful shutdown

Returns:

a completable future that on a CompletableFuture.get() will wait for the process, if available, exits

isClosed

public boolean isClosed()

Description copied from interface: ServerManager

Checks if this server manager has been closed. The server manager may be closed if the underlying client was closed.

Specified by:

isClosed in interface ServerManager

Returns:

true if the server manager was closed, otherwise false

close

public void close()

Description copied from interface: ServerManager

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ServerManager

deploy

public ServerManager deploy(Deployment deployment)

Description copied from interface: ServerManager

Deploys content to the server. This will fire ServerManagerListener.beforeDeploy(ServerManager, Deployment) before the deployment and ServerManagerListener.afterDeploy(ServerManager, Deployment) after a successful deployment. If the deployment fails, ServerManagerListener.deployFailed(ServerManager, Deployment, Throwable) will be invoked to allow listeners to clean up any resources.

Specified by:

deploy in interface ServerManager

Parameters:

deployment - the deployment to deploy to the server

Returns:

this server manager

undeploy

public ServerManager undeploy(DeploymentDescription deployment)

Description copied from interface: ServerManager

Undeploys content from the server. This will fire ServerManagerListener.beforeUndeploy(ServerManager, DeploymentDescription) before undeploying and ServerManagerListener.afterUndeploy(ServerManager, DeploymentDescription) after a successful undeployment. If the undeployment fails, ServerManagerListener.undeployFailed(ServerManager, DeploymentDescription, Throwable) will be invoked.

Specified by:

undeploy in interface ServerManager

Parameters:

deployment - the deployment description for the deployment to undeploy

Returns:

this server manager