org.jboss.as.host.controller

Class ServerInventoryImpl

java.lang.Object

org.jboss.as.host.controller.ServerInventoryImpl

All Implemented Interfaces:

ServerInventory

public class ServerInventoryImpl
extends Object
implements ServerInventory

Inventory of the managed servers.

Author:

Emanuel Muckenhuber, Kabir Khan

Method Summary

Modifier and Type	Method and Description
void	awaitServersState(Collection<String> serverNames, boolean started) Await for a group of servers to be either started or stopped.
boolean	awaitServerSuspend(Set<String> waitForServers, int timeoutInSeconds) Suspends and waits for the given set of servers to suspend up to the timeout
void	connectionFinished() Signal the end of the PC connection, regardless of the reason.
void	destroyServer(String serverName) Destroy a stopping server process.
Map<String,ProcessInfo>	determineRunningProcesses() Gets information on all the running processes
Map<String,ProcessInfo>	determineRunningProcesses(boolean serversOnly) Gets information on all the running processes
org.jboss.as.controller.client.helpers.domain.ServerStatus	determineServerStatus(String serverName) Get the status of the server with the given name.
String	getProcessServerName(String processName) Gets the server model name for a process
CallbackHandler	getServerCallbackHandler() Gets a callback handler security services can use for handling authentication data provided by a server attempting to connect with this host controller.
String	getServerProcessName(String serverName) Gets the process name for a server
void	killServer(String serverName) Try to kill a server process.
void	operationFailed(String serverProcessName, ProcessMessageHandler.OperationType type) Notification that an operation failed on the process-controller.
void	processInventory(Map<String,ProcessInfo> processInfos) Notification that managed server process information is available.
void	reconnectServer(String serverName, org.jboss.dmr.ModelNode domainModel, String authKey, boolean running, boolean stopping) Re-establishes management communications with a server following a restart of the Host Controller process.
org.jboss.as.controller.client.helpers.domain.ServerStatus	reloadServer(String serverName, boolean blocking) Reload a server with the given name.
org.jboss.as.controller.client.helpers.domain.ServerStatus	restartServer(String serverName, int gracefulTimeout, org.jboss.dmr.ModelNode domainModel) Restart the server with the given name.
org.jboss.as.controller.client.helpers.domain.ServerStatus	restartServer(String serverName, int gracefulTimeout, org.jboss.dmr.ModelNode domainModel, boolean blocking) Restart the server with the given name.
void	resumeServer(String serverName) Resumes a server, allowing it to begin processing requests normally
ProxyController	serverCommunicationRegistered(String serverProcessName, ManagementChannelHandler channelAssociation) Notification that a channel for communication with a managed server process has been registered.
void	serverProcessAdded(String serverProcessName) Notification that a server has been added to the process-controller.
void	serverProcessRemoved(String serverProcessName) Notification that a server has been removed from the process-controller.
void	serverProcessStarted(String serverProcessName) Notification that a server process has been started.
void	serverProcessStopped(String serverProcessName) Notification that a server has stopped.
boolean	serverReconnected(String serverProcessName, ManagementChannelHandler channelHandler) Notification that a server has been reconnected.
void	serverStarted(String serverProcessName) Notification that the server is started.
void	serverStartFailed(String serverProcessName) Notification that the start of a server process has failed.
org.jboss.as.controller.client.helpers.domain.ServerStatus	startServer(String serverName, org.jboss.dmr.ModelNode domainModel) Start the server with the given name.
org.jboss.as.controller.client.helpers.domain.ServerStatus	startServer(String serverName, org.jboss.dmr.ModelNode domainModel, boolean blocking) Start the server with the given name.
org.jboss.as.controller.client.helpers.domain.ServerStatus	stopServer(String serverName, int gracefulTimeout) Stop the server with the given name.
org.jboss.as.controller.client.helpers.domain.ServerStatus	stopServer(String serverName, int gracefulTimeout, boolean blocking) Stop the server with the given name.
void	stopServers(int gracefulTimeout) Stop all servers.
void	stopServers(int gracefulTimeout, boolean blockUntilStopped) Stop all servers.
void	suspendServer(String serverName) Suspends a server, allowing current requests to finish and blocking any new requests from starting.

Methods inherited from class java.lang.Object

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

Method Detail

getServerProcessName

public String getServerProcessName(String serverName)

Description copied from interface: ServerInventory

Gets the process name for a server

Specified by:

getServerProcessName in interface ServerInventory

Parameters:

serverName - the name of a server in the model

Returns:

the server name

getProcessServerName

public String getProcessServerName(String processName)

Description copied from interface: ServerInventory

Gets the server model name for a process

Specified by:

getProcessServerName in interface ServerInventory

Parameters:

processName - the name of the server process

Returns:

the server model name

determineRunningProcesses

public Map<String,ProcessInfo> determineRunningProcesses()

Description copied from interface: ServerInventory

Gets information on all the running processes

Specified by:

determineRunningProcesses in interface ServerInventory

Returns:

map of all server process names to information about the process

determineRunningProcesses

public Map<String,ProcessInfo> determineRunningProcesses(boolean serversOnly)

Description copied from interface: ServerInventory

Gets information on all the running processes

Specified by:

determineRunningProcesses in interface ServerInventory

Parameters:

serversOnly - true to only return the server processes

Returns:

map of server process names to information about the process

determineServerStatus

public org.jboss.as.controller.client.helpers.domain.ServerStatus determineServerStatus(String serverName)

Description copied from interface: ServerInventory

Get the status of the server with the given name.

Specified by:

determineServerStatus in interface ServerInventory

Parameters:

serverName - the server name. Cannot be null

Returns:

the status. Will not return null; will return ServerStatus.STOPPED for unknown servers

startServer

public org.jboss.as.controller.client.helpers.domain.ServerStatus startServer(String serverName,
                                                                              org.jboss.dmr.ModelNode domainModel)

Description copied from interface: ServerInventory

Start the server with the given name. Note that returning from this method does not mean the server is completely started; it usually will only be in the process of starting, having received all startup instructions.

Specified by:

startServer in interface ServerInventory

Parameters:

serverName - the name of the server

domainModel - the configuration model for the domain

Returns:

the status of the server following the attempt to start

startServer

public org.jboss.as.controller.client.helpers.domain.ServerStatus startServer(String serverName,
                                                                              org.jboss.dmr.ModelNode domainModel,
                                                                              boolean blocking)

Description copied from interface: ServerInventory

Start the server with the given name.

Specified by:

startServer in interface ServerInventory

Parameters:

serverName - the name of the server

domainModel - the configuration model for the domain

blocking - whether to block until the server is started

Returns:

the status of the server following the attempt to start

restartServer

public org.jboss.as.controller.client.helpers.domain.ServerStatus restartServer(String serverName,
                                                                                int gracefulTimeout,
                                                                                org.jboss.dmr.ModelNode domainModel)

Description copied from interface: ServerInventory

Restart the server with the given name. Note that returning from this method does not mean the server is completely started; it usually will only be in the process of starting, having received all startup instructions.

Specified by:

restartServer in interface ServerInventory

Parameters:

serverName - the name of the server

gracefulTimeout - time in ms the server should allow for graceful shutdown (if supported) before terminating all services

domainModel - the configuration model for the domain

Returns:

the status of the server following the attempt to restart

restartServer

public org.jboss.as.controller.client.helpers.domain.ServerStatus restartServer(String serverName,
                                                                                int gracefulTimeout,
                                                                                org.jboss.dmr.ModelNode domainModel,
                                                                                boolean blocking)

Description copied from interface: ServerInventory

Restart the server with the given name.

Specified by:

restartServer in interface ServerInventory

Parameters:

serverName - the name of the server

gracefulTimeout - time in ms the server should allow for graceful shutdown (if supported) before terminating all services

domainModel - the configuration model for the domain

blocking - whether to block until the server is restarted

Returns:

the status of the server following the attempt to restart

stopServer

public org.jboss.as.controller.client.helpers.domain.ServerStatus stopServer(String serverName,
                                                                             int gracefulTimeout)

Description copied from interface: ServerInventory

Stop the server with the given name. Note that returning from this method does not mean the server is completely stopped; it may only be in the process of stopping.

Specified by:

stopServer in interface ServerInventory

Parameters:

serverName - the name of the server

gracefulTimeout - time in ms the server should allow for graceful shutdown (if supported) before terminating all services

Returns:

the status of the server following the attempt to stop

stopServer

public org.jboss.as.controller.client.helpers.domain.ServerStatus stopServer(String serverName,
                                                                             int gracefulTimeout,
                                                                             boolean blocking)

Description copied from interface: ServerInventory

Stop the server with the given name.

Specified by:

stopServer in interface ServerInventory

Parameters:

serverName - the name of the server

gracefulTimeout - time in ms the server should allow for graceful shutdown (if supported) before terminating all services

blocking - whether to block until the server is stopped

Returns:

the status of the server following the attempt to stop

reconnectServer

public void reconnectServer(String serverName,
                            org.jboss.dmr.ModelNode domainModel,
                            String authKey,
                            boolean running,
                            boolean stopping)

Description copied from interface: ServerInventory

Re-establishes management communications with a server following a restart of the Host Controller process.

Specified by:

reconnectServer in interface ServerInventory

Parameters:

serverName - the name of the server

domainModel - the configuration model for the domain

authKey - the authentication key

running - whether the process was running. If false, the existence of the server will be recorded but no attempt to contact it will be made

stopping - whether the process is currently stopping

reloadServer

public org.jboss.as.controller.client.helpers.domain.ServerStatus reloadServer(String serverName,
                                                                               boolean blocking)

Description copied from interface: ServerInventory

Reload a server with the given name.

Specified by:

reloadServer in interface ServerInventory

Parameters:

serverName - the name of the server

destroyServer

public void destroyServer(String serverName)

Description copied from interface: ServerInventory

Destroy a stopping server process. In case the the server is not stopping, this will attempt to stop the server and this method has to be called again.

Specified by:

destroyServer in interface ServerInventory

Parameters:

serverName - the server name

killServer

public void killServer(String serverName)

Description copied from interface: ServerInventory

Try to kill a server process. In case the server is not stopping, this will attempt to stop the server and this method has to be called again.

Specified by:

killServer in interface ServerInventory

Parameters:

serverName - the server name

stopServers

public void stopServers(int gracefulTimeout)

Description copied from interface: ServerInventory

Stop all servers. Note that returning from this method does not mean the servers are completely stopped; they may only be in the process of stopping.

Specified by:

stopServers in interface ServerInventory

Parameters:

gracefulTimeout - time in ms a server should allow for graceful shutdown (if supported) before terminating all services

stopServers

public void stopServers(int gracefulTimeout,
                        boolean blockUntilStopped)

Description copied from interface: ServerInventory

Stop all servers. Note that unless blockUntilStopped is set to true returning from this method does not mean the servers are completely stopped;

Specified by:

stopServers in interface ServerInventory

Parameters:

gracefulTimeout - time in ms a server should allow for graceful shutdown (if supported) before terminating all services

blockUntilStopped - wait until all servers are stopped

awaitServersState

public void awaitServersState(Collection<String> serverNames,
                              boolean started)

Description copied from interface: ServerInventory

Await for a group of servers to be either started or stopped.

Specified by:

awaitServersState in interface ServerInventory

Parameters:

serverNames - the server names in the group

started - whether to wait for the started, or the stopped notification

suspendServer

public void suspendServer(String serverName)

Description copied from interface: ServerInventory

Suspends a server, allowing current requests to finish and blocking any new requests from starting.

Specified by:

suspendServer in interface ServerInventory

Parameters:

serverName - The server name

resumeServer

public void resumeServer(String serverName)

Description copied from interface: ServerInventory

Resumes a server, allowing it to begin processing requests normally

Specified by:

resumeServer in interface ServerInventory

Parameters:

serverName - The server name

awaitServerSuspend

public boolean awaitServerSuspend(Set<String> waitForServers,
                                  int timeoutInSeconds)

Description copied from interface: ServerInventory

Suspends and waits for the given set of servers to suspend up to the timeout

Specified by:

awaitServerSuspend in interface ServerInventory

Parameters:

waitForServers - The servers to wait for

timeoutInSeconds - The maximum amount of time to wait in seconds, with -1 meaning indefinitly

Returns:

true if all the servers suspended in time

serverCommunicationRegistered

public ProxyController serverCommunicationRegistered(String serverProcessName,
                                                     ManagementChannelHandler channelAssociation)

Description copied from interface: ServerInventory

Notification that a channel for communication with a managed server process has been registered.

Specified by:

serverCommunicationRegistered in interface ServerInventory

Parameters:

serverProcessName - the name of the server process

channelAssociation - remoting channel to use for communicating with the server

Returns:

the server proxy

serverReconnected

public boolean serverReconnected(String serverProcessName,
                                 ManagementChannelHandler channelHandler)

Description copied from interface: ServerInventory

Notification that a server has been reconnected. This will also check whether a server is still in sync with the current domain model, or there were updates while the server was disconnected.

Specified by:

serverReconnected in interface ServerInventory

Parameters:

serverProcessName - the name of the server process

channelHandler - mgmt channel handler for communication with the server

Returns:

true if the server is still in sync, false otherwise

serverProcessStopped

public void serverProcessStopped(String serverProcessName)

Description copied from interface: ServerInventory

Notification that a server has stopped.

Specified by:

serverProcessStopped in interface ServerInventory

Parameters:

serverProcessName - the name of the server process

connectionFinished

public void connectionFinished()

Description copied from interface: ServerInventory

Signal the end of the PC connection, regardless of the reason.

Specified by:

connectionFinished in interface ServerInventory

serverStarted

public void serverStarted(String serverProcessName)

Description copied from interface: ServerInventory

Notification that the server is started.

Specified by:

serverStarted in interface ServerInventory

Parameters:

serverProcessName - the name of the server process

serverStartFailed

public void serverStartFailed(String serverProcessName)

Description copied from interface: ServerInventory

Notification that the start of a server process has failed.

Specified by:

serverStartFailed in interface ServerInventory

Parameters:

serverProcessName - the name of the server process

serverProcessAdded

public void serverProcessAdded(String serverProcessName)

Description copied from interface: ServerInventory

Notification that a server has been added to the process-controller.

Specified by:

serverProcessAdded in interface ServerInventory

Parameters:

serverProcessName - the process name

serverProcessStarted

public void serverProcessStarted(String serverProcessName)

Description copied from interface: ServerInventory

Notification that a server process has been started.

Specified by:

serverProcessStarted in interface ServerInventory

Parameters:

serverProcessName - the process name

serverProcessRemoved

public void serverProcessRemoved(String serverProcessName)

Description copied from interface: ServerInventory

Notification that a server has been removed from the process-controller.

Specified by:

serverProcessRemoved in interface ServerInventory

Parameters:

serverProcessName - the process name

operationFailed

public void operationFailed(String serverProcessName,
                            ProcessMessageHandler.OperationType type)

Description copied from interface: ServerInventory

Notification that an operation failed on the process-controller.

Specified by:

operationFailed in interface ServerInventory

Parameters:

serverProcessName - the process name

type - the operation type

processInventory

public void processInventory(Map<String,ProcessInfo> processInfos)

Description copied from interface: ServerInventory

Notification that managed server process information is available.

Specified by:

processInventory in interface ServerInventory

Parameters:

processInfos - map of process name to information about the process

getServerCallbackHandler

public CallbackHandler getServerCallbackHandler()

Description copied from interface: ServerInventory

Gets a callback handler security services can use for handling authentication data provided by a server attempting to connect with this host controller.

Specified by:

getServerCallbackHandler in interface ServerInventory

Returns:

the callback handler. Will not be null