ServerAdmin

All Known Implementing Classes:

ServerManager
```
public interface ServerAdmin
```
The main entry point for the UltraESB server runtime and programmatic management of proxy services, endpoints and sequences

An instance of the ServerAdmin can be acquired by calling ServerAdminImpl.getInstance() method, which can be used to do all exposed management operations programatically.

The ServerAdmin API in most of the cases is used with the AbstractServerInterceptor in-order to dynamically change the runtime configuration by provisioning the deployment units or updating the deployment units.

Since:

2.0.0

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addOrUpdateDeploymentUnit(DeploymentUnitDefinition def)` Switch deployment unit into a new version
`void`	`addOrUpdateDeploymentUnit(java.lang.String id, byte[] config)` Writes the configuration file ultra-unit.xml to the specified deployment unit from a byte stream
`void`	`defineNonPersistedAlertConfig(AlertConfigurationDefinition alertConfig)` Defines a new alert configuration into the alert configuration registry without persistence
`void`	`definePersistedAlertConfig(AlertConfigurationDefinition alertConfig)` Defines a new alert configuration into the alert configuration registry with persistence
`void`	`endMaintenance()` Resume normal operations from maintenance
`java.util.List`	`getActingServerNames()` Gives and unmodifiable list containing the names of the server this server is acting as
`java.lang.Object`	`getBean(java.lang.String id, java.lang.Class type)` Gets a spring bean of the given type from the root static context of the ESB
`java.lang.String`	`getInstallationName()` Gives the name of the installation which uniquely identifies a set of related nodes in a deployment
`java.util.List`	`getProxyServiceIds()` Retrieves the deployed proxy service id list (of all deployment units) in the UltraESB server
`java.lang.String`	`getServerName()` Gives the name of the server which has to be unique in a clustered deployment
`int`	`getUserDefinedStatusCode()` Get the user defined status code
`boolean`	`isActingAs(java.lang.String serverName)` Whether the server is acting as the given server name
`boolean`	`isClustered()` Used to check whether the server is in a clustered deployment
`boolean`	`isDeploymentUnitLoaded(java.lang.String id)` Whether there is a deployment unit loaded with the given identifier
`boolean`	`isStarted()` Return true if the system is currently running, and not begun a shutdown sequence
`boolean`	`purgeAllOutdatedDeploymentUnits()` Purge all outdated configuration fragments
`void`	`refresh()` Refreshes the server manager, this is only called by some human intervention and will only fire the `LifecycleEventType.ON_SERVER_REFRESH` event sending a signal to the server interceptors to act on if interested about this human initiated action
`boolean`	`removeNonPersistedAlertConfig(java.lang.String stream, long id)` Removes the custom alert configuration identified by the 'stream' and 'id'
`void`	`scheduleTask(java.util.TimerTask task, long[] timeout)` Ability to schedule a timer task in the ESB, the variable argument timeout accepts one or two arguments not passing a long value for the variable argument method or passing more than 2 arguments to the variable argument will cause a `BusRuntimeException`
`void`	`setUserDefinedStatusCode(int code)` Set the current value for the user defined status code
`void`	`shutdown()` Shutdown the UltraESB instance
`void`	`shutdown(long waitMillis)` Shutdown the UltraESB instance, giving a grace period of waitMillis
`void`	`startActingAs(java.lang.String actingNodeName)` Starts acting as the given server name, which means that all the pinned proxy services to the given node will be started in the current server, unless it also is pinned into the current server.
`void`	`startMaintenance()` Put the server into the maintenance mode
`void`	`stop()` Stop the UltraESB server instance (without entering the maintenance mode)
`void`	`stopActingAs(java.lang.String actingNodeName)` Stops acting as the given server name, which means that all the pinned proxy services to the given node will be stopped in the current server, unless it also is pinned into the current server.
`void`	`stopGracefully(long gracePeriod)` Stops the server gracefully within the specified grace period.
`void`	`unloadAllDeploymentUnits()` Unload all deployment units currently loaded
`void`	`unloadDeploymentUnit(java.lang.String id)` Unload deployment unit with the given id
`boolean`	`waitUntilIdle(long waitMillis, long endTime)` Wait and return when the server is idle, or at endTime

- Method Detail
  - isStarted
```
boolean isStarted()
```
    Return true if the system is currently running, and not begun a shutdown sequence
    
    Returns:
    true if system is running
  - isClustered
```
boolean isClustered()
```
    Used to check whether the server is in a clustered deployment
    
    Returns:
    whether the server is clustered or not
  - shutdown
```
void shutdown()
```
    Shutdown the UltraESB instance
  - shutdown
```
void shutdown(long waitMillis)
```
    Shutdown the UltraESB instance, giving a grace period of waitMillis
    
    Parameters:
    waitMillis - the grace period for shutdown
  - waitUntilIdle
```
boolean waitUntilIdle(long waitMillis,
                    long endTime)
```
    Wait and return when the server is idle, or at endTime
    
    Parameters:
    waitMillis - maximum wait time
    endTime - actual deadline
    
    Returns:
    true if instance reached idle state in the given time period
  - startMaintenance
```
void startMaintenance()
```
    Put the server into the maintenance mode
  - endMaintenance
```
void endMaintenance()
```
    Resume normal operations from maintenance
  - stopGracefully
```
void stopGracefully(long gracePeriod)
```
    Stops the server gracefully within the specified grace period. If the server failed to reach the idle state within the grace period, hard stop at that point
    
    Parameters:
    gracePeriod - the maximum time period the stop action will wait for the server to idle after entering the maintenance mode
  - stop
```
void stop()
```
    Stop the UltraESB server instance (without entering the maintenance mode)
  - refresh
```
void refresh()
```
    Refreshes the server manager, this is only called by some human intervention and will only fire the LifecycleEventType.ON_SERVER_REFRESH event sending a signal to the server interceptors to act on if interested about this human initiated action
  - getServerName
```
java.lang.String getServerName()
```
    Gives the name of the server which has to be unique in a clustered deployment
    
    Returns:
    the name of the server
  - getInstallationName
```
java.lang.String getInstallationName()
```
    Gives the name of the installation which uniquely identifies a set of related nodes in a deployment
    
    Returns:
    the name of the installation
  - getUserDefinedStatusCode
```
int getUserDefinedStatusCode()
```
    Get the user defined status code
    
    Returns:
    current status code set by the user via JMX, UTerm or UConsole
  - getProxyServiceIds
```
java.util.List getProxyServiceIds()
```
    Retrieves the deployed proxy service id list (of all deployment units) in the UltraESB server
    
    Returns:
    the list of proxy service ids deployed on the server
  - setUserDefinedStatusCode
```
void setUserDefinedStatusCode(int code)
```
    Set the current value for the user defined status code
    
    Parameters:
    code - the status code value
  - getActingServerNames
```
java.util.List getActingServerNames()
```
    Gives and unmodifiable list containing the names of the server this server is acting as
    
    Returns:
    and unmodifiable list of server names that his server is currently acting as
  - isActingAs
```
boolean isActingAs(java.lang.String serverName)
```
    Whether the server is acting as the given server name
    
    Parameters:
    serverName - to check for whether the server is acting as it
    
    Returns:
    true if the server is acting as the given server name, false otherwise
  - startActingAs
```
void startActingAs(java.lang.String actingNodeName)
```
    Starts acting as the given server name, which means that all the pinned proxy services to the given node will be started in the current server, unless it also is pinned into the current server.
    
    Parameters:
    actingNodeName - the name of the server to act as, in addition to self
  - stopActingAs
```
void stopActingAs(java.lang.String actingNodeName)
```
    Stops acting as the given server name, which means that all the pinned proxy services to the given node will be stopped in the current server, unless it also is pinned into the current server.
    
    Parameters:
    actingNodeName - the name of the server to stop acting as
  - addOrUpdateDeploymentUnit
```
void addOrUpdateDeploymentUnit(DeploymentUnitDefinition def)
```
    Switch deployment unit into a new version
    
    Parameters:
    def - deployment unit definition to be added or switched
  - addOrUpdateDeploymentUnit
```
void addOrUpdateDeploymentUnit(java.lang.String id,
                             byte[] config)
```
    Writes the configuration file ultra-unit.xml to the specified deployment unit from a byte stream
    
    Parameters:
    id - the deployment unit identifier which the configuration file is written to
    config - the byte array containing file contents TODO change the byte stream to a compressed stream for better efficiency
  - isDeploymentUnitLoaded
```
boolean isDeploymentUnitLoaded(java.lang.String id)
```
    Whether there is a deployment unit loaded with the given identifier
    
    Parameters:
    id - the identifier to be checked for existence
    
    Returns:
    whether a deployment unit with the given identifier loaded
  - unloadDeploymentUnit
```
void unloadDeploymentUnit(java.lang.String id)
```
    Unload deployment unit with the given id
    
    Parameters:
    id - deployment unit identifier
  - unloadAllDeploymentUnits
```
void unloadAllDeploymentUnits()
```
    Unload all deployment units currently loaded
  - purgeAllOutdatedDeploymentUnits
```
boolean purgeAllOutdatedDeploymentUnits()
```
    Purge all outdated configuration fragments
    
    Returns:
    true if all outdated configs were purged successfully
  - definePersistedAlertConfig
```
void definePersistedAlertConfig(AlertConfigurationDefinition alertConfig)
```
    Defines a new alert configuration into the alert configuration registry with persistence
    
    Parameters:
    alertConfig - the alert configuration to be added to the registry
  - defineNonPersistedAlertConfig
```
void defineNonPersistedAlertConfig(AlertConfigurationDefinition alertConfig)
```
    Defines a new alert configuration into the alert configuration registry without persistence
    
    Parameters:
    alertConfig - the alert configuration to be added to the registry
  - removeNonPersistedAlertConfig
```
boolean removeNonPersistedAlertConfig(java.lang.String stream,
                                    long id)
```
    Removes the custom alert configuration identified by the 'stream' and 'id'
    
    Parameters:
    stream - stream for the policy alert configuration
    id - id for the steam
  - scheduleTask
```
void scheduleTask(java.util.TimerTask task,
                long[] timeout)
```
    Ability to schedule a timer task in the ESB, the variable argument timeout accepts one or two arguments not passing a long value for the variable argument method or passing more than 2 arguments to the variable argument will cause a BusRuntimeException
    
    Parameters:
    task - the timer task to be scheduled, this will be wrapped in an internal timer task implementation to make sure none of the tasks are causing the global ESB timer any issues
    timeout - if one argument is provided, it uses the Timer.schedule(java.util.TimerTask, long) method while 2 arguments will invoke the Timer.schedule(java.util.TimerTask, long, long)
  - getBean
```
java.lang.Object getBean(java.lang.String id,
                       java.lang.Class type)
```
    Gets a spring bean of the given type from the root static context of the ESB
    
    Parameters:
    id - the bean identifier of the spring bean to be retrieved
    type - the class of the bean to be retrieved
    
    Returns:
    the bean with the given id if it is of the given type

Interface ServerAdmin

Method Summary

Method Detail

isStarted

isClustered

shutdown

shutdown

waitUntilIdle

startMaintenance

endMaintenance

stopGracefully

stop

refresh

getServerName

getInstallationName

getUserDefinedStatusCode

getProxyServiceIds

setUserDefinedStatusCode

getActingServerNames

isActingAs

startActingAs

stopActingAs

addOrUpdateDeploymentUnit

addOrUpdateDeploymentUnit

isDeploymentUnitLoaded

unloadDeploymentUnit

unloadAllDeploymentUnits

purgeAllOutdatedDeploymentUnits

definePersistedAlertConfig

defineNonPersistedAlertConfig

removeNonPersistedAlertConfig

scheduleTask

getBean