org.jboss.as.host.controller

Interface ServerInventory

All Known Implementing Classes:

ServerInventoryImpl

public interface 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.
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 processName, 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, boolean suspend) 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, boolean suspend) Restart the server with the given name.
List<org.jboss.dmr.ModelNode>	resumeServers(Set<String> serverNames, BlockingTimeout blockingTimeout) Resume the servers, allowing them to begin processing requests normally
ProxyController	serverCommunicationRegistered(String serverProcessName, ManagementChannelHandler channelHandler) Notification that a channel for communication with a managed server process has been registered.
void	serverProcessAdded(String processName) Notification that a server has been added to the process-controller.
void	serverProcessRemoved(String processName) Notification that a server has been removed from the process-controller.
void	serverProcessStarted(String processName) 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.
void	serverUnstable(String serverProcessName) Notification that a server process has become unstable.
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, boolean suspend) 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.
List<org.jboss.dmr.ModelNode>	suspendServers(Set<String> serverNames, BlockingTimeout blockingTimeout) Suspend the servers, allowing current requests to finish and blocking any new requests from starting.
List<org.jboss.dmr.ModelNode>	suspendServers(Set<String> serverNames, int timeoutInSeconds, BlockingTimeout blockingTimeout) Suspend the servers up to the timeout, allowing current requests to finish and blocking any new requests from starting.

Method Detail

getServerProcessName

String getServerProcessName(String serverName)

Gets the process name for a server

Parameters:

serverName - the name of a server in the model

Returns:

the server name

getProcessServerName

String getProcessServerName(String processName)

Gets the server model name for a process

Parameters:

processName - the name of the server process

Returns:

the server model name

determineRunningProcesses

Map<String,ProcessInfo> determineRunningProcesses()

Gets information on all the running processes

Returns:

map of all server process names to information about the process

determineRunningProcesses

Map<String,ProcessInfo> determineRunningProcesses(boolean serversOnly)

Gets information on all the running processes

Parameters:

serversOnly - true to only return the server processes

Returns:

map of server process names to information about the process

determineServerStatus

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

Get the status of the server with the given name.

Parameters:

serverName - the server name. Cannot be null

Returns:

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

startServer

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

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.

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

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

Start the server with the given name.

Parameters:

serverName - the name of the server

domainModel - the configuration model for the domain

blocking - whether to block until the server is started

suspend - If the server should start suspended

Returns:

the status of the server following the attempt to start

restartServer

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. 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.

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

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

Restart the server with the given name.

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

suspend - if the servers should restart in suspended mode

Returns:

the status of the server following the attempt to restart

stopServer

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

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.

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

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

Stop the server with the given name.

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

stopServers

void stopServers(int gracefulTimeout)

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.

Parameters:

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

stopServers

void stopServers(int gracefulTimeout,
                 boolean blockUntilStopped)

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

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

reconnectServer

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.

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

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

Reload a server with the given name.

Parameters:

serverName - the name of the server

destroyServer

void destroyServer(String serverName)

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.

Parameters:

serverName - the server name

killServer

void killServer(String serverName)

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.

Parameters:

serverName - the server name

getServerCallbackHandler

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.

Returns:

the callback handler. Will not be null

serverCommunicationRegistered

ProxyController serverCommunicationRegistered(String serverProcessName,
                                              ManagementChannelHandler channelHandler)

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

Parameters:

serverProcessName - the name of the server process

channelHandler - remoting channel to use for communicating with the server

Returns:

the server proxy

serverReconnected

boolean serverReconnected(String serverProcessName,
                          ManagementChannelHandler channelHandler)

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.

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

serverStarted

void serverStarted(String serverProcessName)

Notification that the server is started.

Parameters:

serverProcessName - the name of the server process

serverStartFailed

void serverStartFailed(String serverProcessName)

Notification that the start of a server process has failed.

Parameters:

serverProcessName - the name of the server process

serverUnstable

void serverUnstable(String serverProcessName)

Notification that a server process has become unstable.

Parameters:

serverProcessName - the name of the server process

serverProcessStopped

void serverProcessStopped(String serverProcessName)

Notification that a server has stopped.

Parameters:

serverProcessName - the name of the server process

connectionFinished

void connectionFinished()

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

serverProcessAdded

void serverProcessAdded(String processName)

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

Parameters:

processName - the process name

serverProcessStarted

void serverProcessStarted(String processName)

Notification that a server process has been started.

Parameters:

processName - the process name

serverProcessRemoved

void serverProcessRemoved(String processName)

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

Parameters:

processName - the process name

operationFailed

void operationFailed(String processName,
                     ProcessMessageHandler.OperationType type)

Notification that an operation failed on the process-controller.

Parameters:

processName - the process name

type - the operation type

processInventory

void processInventory(Map<String,ProcessInfo> processInfos)

Notification that managed server process information is available.

Parameters:

processInfos - map of process name to information about the process

awaitServersState

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

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

Parameters:

serverNames - the server names in the group

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

Throws:

InterruptedException

suspendServers

List<org.jboss.dmr.ModelNode> suspendServers(Set<String> serverNames,
                                             BlockingTimeout blockingTimeout)

Suspend the servers, allowing current requests to finish and blocking any new requests from starting.

Parameters:

serverNames - The server names to suspend, can be an immutable collection.

blockingTimeout - control for maximum period any blocking operations can block. Cannot be null

Returns:

An empty Collection if no errors were returned suspending the servers, otherwise it will contain all error responses. Will not be null

resumeServers

List<org.jboss.dmr.ModelNode> resumeServers(Set<String> serverNames,
                                            BlockingTimeout blockingTimeout)

Resume the servers, allowing them to begin processing requests normally

Parameters:

serverNames - The server names to resume. It allows an immutable collection.

blockingTimeout - control for maximum period any blocking operations can block. Cannot be null

Returns:

An empty Collection if no errors were returned resuming the servers, otherwise it will contain all error responses. Will not be null

suspendServers

List<org.jboss.dmr.ModelNode> suspendServers(Set<String> serverNames,
                                             int timeoutInSeconds,
                                             BlockingTimeout blockingTimeout)

Suspend the servers up to the timeout, allowing current requests to finish and blocking any new requests from starting.

Parameters:

serverNames - The servers to wait for, can be an immutable collection.

timeoutInSeconds - The maximum amount of time to wait in seconds, with -1 meaning wait indefinitely, 0 meaning return immediately and with a value bigger than 0 meaning wait n seconds.

blockingTimeout - control for maximum period any blocking operations can block. Cannot be null

Returns:

An empty Collection if no errors were returned suspending the servers, otherwise it will contain all error responses. Will not be null