EngineAdmin (TIBCO Software, Inc.)

```
public interface EngineAdmin
```
Provides administrative access to the Engines on a Broker. Note that use of admin interfaces is limited according to a user's assigned role and account. See the Silver Fabric Developer's Guide for more details.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`applyPatch(long id, java.lang.String instance)` Applies patches associated with the currently running Enabler and Component to the Enabler running on Engine.
`boolean`	`capture(long id, java.lang.String instance)` Captures the state of currently running Component on the given Engine after deactivating the Component.
`boolean`	`captureWhileRunning(long id, java.lang.String instance)` Captures the state of currently running Component on the given Engine without deactivating the Component.
`FabricEngineInfo[]`	`getAllEngineInfo()` Retrieves information on the all Engines logged into the Broker.
`int`	`getBusyEngineCount()` Retrieves the total number of Engines logged into the Broker that are currently processing a Task.
`int`	`getEngineCount()` Retrieves the total number of Engines logged into the Broker.
`long[]`	`getEngineIds()` Retrieves the list of Engine IDs logged into the Broker.
`FabricEngineInfo`	`getEngineInfo(long id, java.lang.String instance)` Retrieves information on the given Engine.
`java.lang.String[]`	`getLogUrlList(long id, java.lang.String instance)` Retrieves the log file URLs on the given Engine.
`PatchStatusInfo[]`	`getPatchStatus(long id, java.lang.String instance)` Retrieves status of all the patches associated with the currently running Enabler and Component.
`FabricEngineInfo[]`	`getSelectedEngineInfo(long[] engineIds)` Retrieves information on the given Engines logged into the Broker.
`boolean`	`isAvailable()` Retrieves if the methods are available.
`void`	`killAllEngines()` Logs out all the Engines from the Broker.
`void`	`killEngine(long id, java.lang.String instance)` Logs out the given Engine from the Broker.
`void`	`restartComponent(long id, java.lang.String instance)` Restart the component running on the given Engine.
`void`	`restartOutOfDateComponents()` Restarts all components that are running on engines marked Out Of Date.

- Method Detail
  - isAvailable
```
boolean isAvailable()
                    throws java.lang.Exception
```
    Retrieves if the methods are available. True on a Broker, false otherwise.
    
    Returns:
    if the Service is available.
    
    Throws:
    
    AdminException - on error
    
    java.lang.Exception
  - getEngineCount
```
int getEngineCount()
                   throws java.lang.Exception
```
    Retrieves the total number of Engines logged into the Broker.
    
    Returns:
    total number of Engines.
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - getBusyEngineCount
```
int getBusyEngineCount()
                       throws java.lang.Exception
```
    Retrieves the total number of Engines logged into the Broker that are currently processing a Task.
    
    Returns:
    total number of busy Engines.
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - getEngineIds
```
long[] getEngineIds()
                    throws java.lang.Exception
```
    Retrieves the list of Engine IDs logged into the Broker. Returns null when no Engines are logged into the Broker.
    
    Returns:
    the Engine ID list. Returns null when no Engines are logged into the Broker.
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - getSelectedEngineInfo
```
FabricEngineInfo[] getSelectedEngineInfo(long[] engineIds)
                                         throws java.lang.Exception
```
    Retrieves information on the given Engines logged into the Broker. This includes all instances for the given IDs. Returns null when none of the given Engines are logged into the Broker.
    
    Parameters:
    engineIds - the array of Engine IDs to fetch. Returns null when none of the given Engines are logged into the Broker.
    
    Returns:
    Engine information for all instances with the given IDs.
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - getEngineInfo
```
FabricEngineInfo getEngineInfo(long id,
                             java.lang.String instance)
                               throws java.lang.Exception
```
    Retrieves information on the given Engine.
    
    Parameters:
    id - the Engine ID
    instance - the Engine instance
    
    Returns:
    Engine information.
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - getAllEngineInfo
```
FabricEngineInfo[] getAllEngineInfo()
                                    throws java.lang.Exception
```
    Retrieves information on the all Engines logged into the Broker. Returns null when no Engines are logged into the Broker.
    
    Returns:
    all Engine information. Returns null when no Engines are logged into the Broker.
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - killEngine
```
void killEngine(long id,
              java.lang.String instance)
                throws java.lang.Exception
```
    Logs out the given Engine from the Broker.
    
    Parameters:
    id - the Engine ID
    instance - the Engine instance
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - killAllEngines
```
void killAllEngines()
                    throws java.lang.Exception
```
    Logs out all the Engines from the Broker.
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - getLogUrlList
```
java.lang.String[] getLogUrlList(long id,
                               java.lang.String instance)
                                 throws java.lang.Exception
```
    Retrieves the log file URLs on the given Engine. Engine logging must be enabled on the Manager. Returns null when no log file URLs are available for the given Engine instance.
    
    Parameters:
    id - the Engine ID
    instance - the Engine instance
    
    Returns:
    array of log URLs. Returns null when no log file URLs are available for the given Engine instance.
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - capture
```
boolean capture(long id,
              java.lang.String instance)
                throws java.lang.Exception
```
    Captures the state of currently running Component on the given Engine after deactivating the Component. Capture can't be performed on an Engine in draining mode. This method will update the original Component residing on the Broker with the captured configuration changes. Returns true if capture was attempted; false if capture was not even attempted because the Engine was in draining mode or not in running state.
    
    Parameters:
    id - the Engine ID
    instance - the Engine instance
    
    Returns:
    true if capture was attempted; false if capture was not even attempted because the Engine was in draining mode or not in running state
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - captureWhileRunning
```
boolean captureWhileRunning(long id,
                          java.lang.String instance)
                            throws java.lang.Exception
```
    Captures the state of currently running Component on the given Engine without deactivating the Component. Capture can't be performed on an Engine in draining mode. This method will update the original Component residing on the Broker with the captured configuration changes. Returns true if capture was attempted; false if capture was not even attempted because the Engine was in draining mode or not in running state.
    
    Parameters:
    id - the Engine ID
    instance - the Engine instance
    
    Returns:
    true if capture was attempted; false if capture was not even attempted because the Engine was in draining mode or not in running state
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - restartComponent
```
void restartComponent(long id,
                    java.lang.String instance)
                      throws java.lang.Exception
```
    Restart the component running on the given Engine. The component will be deactivated and then activated again on the same engine instance using the latest version of the gridlibs and engine libraries.
    
    Parameters:
    id - the Engine ID
    instance - the Engine instance
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - restartOutOfDateComponents
```
void restartOutOfDateComponents()
                                throws java.lang.Exception
```
    Restarts all components that are running on engines marked Out Of Date. Such components will be deactivated and then activated again on the same engine instances using the latest gridlibs and engine libraries.
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - applyPatch
```
void applyPatch(long id,
              java.lang.String instance)
                throws java.lang.Exception
```
    Applies patches associated with the currently running Enabler and Component to the Enabler running on Engine.
    
    Parameters:
    id - the Engine ID
    instance - the Engine instance
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception
  - getPatchStatus
```
PatchStatusInfo[] getPatchStatus(long id,
                               java.lang.String instance)
                                 throws java.lang.Exception
```
    Retrieves status of all the patches associated with the currently running Enabler and Component.
    
    Parameters:
    id - the Engine ID
    instance - the Engine instance
    
    Returns:
    information about status of all the associated patches
    
    Throws:
    
    NoServiceException - If the Service is not available
    
    AccessException - If the user does not have access to the operation
    
    AdminException - on error
    
    java.lang.Exception

Interface EngineAdmin

Method Summary

Method Detail

isAvailable

getEngineCount

getBusyEngineCount

getEngineIds

getSelectedEngineInfo

getEngineInfo

getAllEngineInfo

killEngine

killAllEngines

getLogUrlList

capture

captureWhileRunning

restartComponent

restartOutOfDateComponents

applyPatch

getPatchStatus