HAAdmin (TIBCO StreamBase and Live Datamart Product Javadoc 10.3.0 API)

java.lang.Object
- com.streambase.sb.client.HAAdmin

All Implemented Interfaces:

Admin
```
class HAAdmin
extends Object
implements Admin
```
Interface describes the admin commands that pass from the client to the stream base server.
Currently, the lowest implementation layer uses XMLRPC for the protocol.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) static class HAAdmin.CommandOption

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`HAAdmin.CommandOption`

Constructor Summary

Constructors
Constructor and Description

HAAdmin(List<StreamBaseURI> uris)

Constructors
Constructor and Description
`HAAdmin(List<StreamBaseURI> uris)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`addContainer(long timeoutMS, String containerName, byte[] application, List<String> containerStreamMappings)` Add the given application to the given container in the StreamBaseServer
`String[]`	`addDeploy(long timeoutMS, byte[] deploy, List<String> args)` Add the given deploy file to the server.
`static List<Throwable>`	`addExceptions(List<Throwable> exceptions, Throwable current)` add the given exception to the list of exceptions
`boolean`	`checkLicense(long timeoutMS, String featureName)` Return true if a license for the specified feature is available and false otherwise.
`String`	`clearEvalCache(long timeoutMS, String containerName)` Clear evaluation cache
`static String`	`createBaseURIString(Collection<StreamBaseURI> uris)` Create a URI string of baseURI's from a list of uris
`String`	`describe(long timeoutMS, String entityName)` Return an XML description of a StreamBase entity
`void`	`drain(long timeoutMS, String containerName)` Drain a StreamBase container or if empty the entire Server
`void`	`enqueue(long timeoutMS, StreamProperties props, Collection<String> tuples)` Enqueue a list of CSV encoded tuples using connectionless XMLRPC
`void`	`fastForwardTime(long timeout, Object value)` Number of milliseconds to jump forward in time.
`ByteOrder`	`getByteOrder(long timeoutMS)` What is the byte order of the server?
`ByteString`	`getConnectionID()` Return the connection id (which may be null)
`Schema.Field`	`getDynamicVariableField(long timeoutMS, Path dynamicVariablePath)`
`Tuple`	`getDynamicVariables(long timeoutMS, Path modulePath)` Return the current value of the dynamic variables in the given module, as a Tuple of field name to Java value.
`String`	`getEvalCacheContent(long timeout, String containerName)` Get evaluation cache content
`Constants.LeadershipStatus`	`getLeadershipStatus(long timeoutMS)` Get the leadership status of the server.
`String`	`getMapperCacheContent(long timeoutMS, String containerName)` Get mapper cache content
`Map<Integer,String>`	`getNamesForContainer(long timeoutMS, int id)` Return a map of id and names for the given container id.
`String[]`	`getOperatorProperties(long timeoutMS, String operatorName)` For the given Operator, return its set of properties and their values.
`String`	`getOperatorProperty(long timeoutMS, String operatorName, String propertyName)` Return the value of the given property on the given Operator.
`Schema`	`getSchemaByHash(long timeoutMS, byte[] hash)` Return the Schema object for the given hash value
`Schema`	`getSchemaByName(long timeoutMS, String schemaName)` Return the Schema object for the given name
`StreamProperties`	`getStreamProperties(long timeoutMS, String streamName)` Return the StreamProperties for the given name.
`StreamProperties`	`getStreamProperties(long timeoutMS, String streamName, CaptureTransformStrategy strategy)` Return the StreamProperties for the given name
`StreamProperties`	`getStreamPropertiesByHash(long timeoutMS, byte[] hash)` Return the StreamProperties for the given hash
`String`	`getTargetTime(long timeout)` Get target time
`String[]`	`internalCommand(long timeoutMS, String... args)` Run the given internal command
`boolean`	`isHA()` Are we in HA mode
`String[]`	`killAllConnections(long timeoutMS)` Kill all of the connections on the server
`String[]`	`killConnection(long timeoutMS, byte[] connectionId)` Kill the connection with the given connectionId
`String[]`	`listConnections(long timeoutMS, StreamBaseAdminClient.ListConnectionArgument... args)` Return an array of client connections
`String[]`	`listEntities(long timeoutMS, String entityType, int flags, CaptureTransformStrategy strategy)` Return an array of entity names for the given entity type
`String[]`	`manageJdbcConnections(long timeoutMS, List<String> args)` Manage jdbc connections: count [name]Count the open JDBC connections to the named data source (or all data sources if ommitted) close [name]Close any open JDBC connections to the named data source (or all data sources if ommitted)
`void`	`modifyApplication(long timeoutMS, byte[] application)` Modify the StreamBase Server with the given StreamBase application.
`String[]`	`modifyContainer(long timeoutMS, String containerName, List<String> args)` Modify the given container
`String[]`	`operatorStatus(long timeoutMS, String containerName)` Return the status of each Operator present in the StreamBase server.
`static StreamBaseException`	`processExceptions(String message, List<Throwable> exceptions, String baseURIString, Class<?> exceptionsCheck)` Look through the exceptions; if we have one that isn't an XMLRPCException then throw that one otherwise bundle them all up into a list exception.
`List<Tuple>`	`readTable(long timeoutMS, String tablePath, int rowLimit, String predicate)` Return rows from the table.
`String[]`	`removeContainer(long timeoutMS, String containerName, List<String> args)` Remove the given container in the StreamBaseServer
`String[]`	`restartContainer(long timeoutMS, String containerName)` Restart the given container
`void`	`restartOperators(long timeoutMS, List<String> operatorNames)` Restart the given Operators on the StreamBase server.
`void`	`resume(long timeoutMS, String containerName)` Resume a paused StreamBase server
`void`	`resumeOperators(long timeoutMS, List<String> operatorsNames)` Resume the given Operators on the StreamBase server
`void`	`setConnectionID(ByteString _connectionid)` Set the Connection ID
`void`	`setDynamicVariable(long timeoutMS, Path dynamicVariablePath, Object value)` Set the value of the given dynamic variable to the given value.
`void`	`setLeadershipStatus(long timeoutMS, Constants.LeadershipStatus leadershipStatus)` Set the leadership status of the server.
`void`	`setOperatorProperty(long timeoutMS, String operatorName, String propertyName, String value)` On the given Operator, set the given property to the given value.
`void`	`setRuntimeParam(long timeoutMS, String paramName, String paramValue, String operator)` set the given runtime param
`String`	`shutdown(long timeoutMS, String containerName)` Shutdown a StreamBase container or if empty the whole server
`void`	`shutdownOperators(long timeoutMS, List<String> operatorNames)` Shut down the given Operators on the StreamBase server.
`String[]`	`status(long timeoutMS, boolean verbose)` Return the status of the StreamBase Server
`SubscriptionEntry`	`subscribe(long timeoutMS, SubscriptionEntry subscription, List<TupleConnections.StreamTupleConnection> connections)` Subscribe to an output stream with predicate
`void`	`suspend(long timeoutMS, String name)` Suspend (pause) a StreamBase container or operator
`void`	`suspendOperators(long timeoutMS, List<String> operatorNames)` Suspend the given Operators on the StreamBase Server
`StreamProperties[]`	`typecheck(long timeoutMS, String application, boolean full)` Typecheck (validate) the given StreamBase Application.
`void`	`unsubscribe(long timeoutMS, StreamProperties props, String logicalstream, List<TupleConnections.StreamTupleConnection> connections)` UnSubscribe to an output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HAAdmin
```
HAAdmin(List<StreamBaseURI> uris)
 throws StreamBaseException
```
    Throws:
    
    StreamBaseException
- Method Detail
  - isHA
```
public boolean isHA()
```
    Description copied from interface: Admin
    
    Are we in HA mode
    
    Specified by:
    
    isHA in interface Admin
    
    Returns:
    
    return if in HA mode
  - getByteOrder
```
public ByteOrder getByteOrder(long timeoutMS)
                       throws StreamBaseException
```
    Description copied from interface: Admin
    
    What is the byte order of the server?
    
    Specified by:
    
    getByteOrder in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    byte order of the server
    
    Throws:
    
    StreamBaseException
  - modifyApplication
```
public void modifyApplication(long timeoutMS,
                              byte[] application)
                       throws StreamBaseException
```
    Modify the StreamBase Server with the given StreamBase application.
    
    Parameters:
    
    application - the application
    
    Throws:
    
    StreamBaseException - thrown on typecheck and other errors
  - typecheck
```
public StreamProperties[] typecheck(long timeoutMS,
                                    String application,
                                    boolean full)
                             throws StreamBaseException
```
    Typecheck (validate) the given StreamBase Application. Return a list of StreamProperties for that Application
    
    Specified by:
    
    typecheck in interface Admin
    
    Parameters:
    
    application - the StreamBase Application to typecheck
    
    full - do a full typecheck
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    array of StreamProperties for the StreamBase application
    
    Throws:
    
    StreamBaseException - on network or typecheck error
  - shutdown
```
public String shutdown(long timeoutMS,
                       String containerName)
                throws StreamBaseException
```
    Description copied from interface: Admin
    
    Shutdown a StreamBase container or if empty the whole server
    
    Specified by:
    
    shutdown in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    containerName - optional containerName
    
    Returns:
    
    message describing the shutdown outcome
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - shutdownOperators
```
public void shutdownOperators(long timeoutMS,
                              List<String> operatorNames)
                       throws StreamBaseException
```
    Description copied from interface: Admin
    
    Shut down the given Operators on the StreamBase server.
    
    Specified by:
    
    shutdownOperators in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    operatorNames - The Operators to shut down
    
    Throws:
    
    StreamBaseException - throws on network or other errors
  - restartOperators
```
public void restartOperators(long timeoutMS,
                             List<String> operatorNames)
                      throws StreamBaseException
```
    Description copied from interface: Admin
    
    Restart the given Operators on the StreamBase server. The Operators must currently be shut down.
    
    Specified by:
    
    restartOperators in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    operatorNames - The Operators to shut down
    
    Throws:
    
    StreamBaseException - throws on network or other errors
  - suspendOperators
```
public void suspendOperators(long timeoutMS,
                             List<String> operatorNames)
                      throws StreamBaseException
```
    Description copied from interface: Admin
    
    Suspend the given Operators on the StreamBase Server
    
    Specified by:
    
    suspendOperators in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    operatorNames - the operators to suspend
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - suspend
```
public void suspend(long timeoutMS,
                    String name)
             throws StreamBaseException
```
    Suspend (pause) a StreamBase container or operator
    
    Specified by:
    
    suspend in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    name - container or operator name
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - resumeOperators
```
public void resumeOperators(long timeoutMS,
                            List<String> operatorsNames)
                     throws StreamBaseException
```
    Description copied from interface: Admin
    
    Resume the given Operators on the StreamBase server
    
    Specified by:
    
    resumeOperators in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    operatorsNames - the operators to suspend
    
    Throws:
    
    StreamBaseException
  - resume
```
public void resume(long timeoutMS,
                   String containerName)
            throws StreamBaseException
```
    Resume a paused StreamBase server
    
    Specified by:
    
    resume in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    containerName - optional containerName
    
    Throws:
    
    StreamBaseException
  - describe
```
public String describe(long timeoutMS,
                       String entityName)
                throws StreamBaseException
```
    Return an XML description of a StreamBase entity
    
    Specified by:
    
    describe in interface Admin
    
    Parameters:
    
    entityName - the name of the entity to describe
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    an XML description of a StreamBase entity
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - checkLicense
```
public boolean checkLicense(long timeoutMS,
                            String featureName)
                     throws StreamBaseException
```
    Return true if a license for the specified feature is available and false otherwise.
    
    Specified by:
    
    checkLicense in interface Admin
    
    Parameters:
    
    featureName - the name of the licensed feature
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    true if a license for the specified feature is available and false otherwise
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - getStreamProperties
```
public StreamProperties getStreamProperties(long timeoutMS,
                                            String streamName,
                                            CaptureTransformStrategy strategy)
                                     throws StreamBaseException
```
    Return the StreamProperties for the given name
    
    Specified by:
    
    getStreamProperties in interface Admin
    
    Parameters:
    
    streamName - the stream name to lookup
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    strategy - the CaptureTransformStrategy to use if the target stream has capture fields.
    
    Returns:
    
    The StreamProperties object for the given name
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - getStreamProperties
```
public StreamProperties getStreamProperties(long timeoutMS,
                                            String streamName)
                                     throws StreamBaseException
```
    Description copied from interface: Admin
    
    Return the StreamProperties for the given name. Uses CaptureTransformStrategy.FLATTEN
    
    Specified by:
    
    getStreamProperties in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    streamName - the stream name to lookup
    
    Returns:
    
    The StreamProperties object for the given name
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - getStreamPropertiesByHash
```
public StreamProperties getStreamPropertiesByHash(long timeoutMS,
                                                  byte[] hash)
                                           throws StreamBaseException
```
    Return the StreamProperties for the given hash
    
    Specified by:
    
    getStreamPropertiesByHash in interface Admin
    
    Parameters:
    
    hash - The Hash to lookup
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    The StreamProperties object for the given name
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - listEntities
```
public String[] listEntities(long timeoutMS,
                             String entityType,
                             int flags,
                             CaptureTransformStrategy strategy)
                      throws StreamBaseException
```
    Return an array of entity names for the given entity type
    
    Specified by:
    
    listEntities in interface Admin
    
    Parameters:
    
    entityType - the entity type to do the lookup
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    flags - FULLY_QUALIFIED_NAMES and INCLUDE_MODULES flags
    
    strategy - the capture transform strategy
    
    Returns:
    
    an array of entity names for the given entity type
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - getSchemaByHash
```
public Schema getSchemaByHash(long timeoutMS,
                              byte[] hash)
                       throws StreamBaseException
```
    Return the Schema object for the given hash value
    
    Specified by:
    
    getSchemaByHash in interface Admin
    
    Parameters:
    
    hash - a byte array that contains a hash value
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    The Schema object associated with the given hash value
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - getSchemaByName
```
public Schema getSchemaByName(long timeoutMS,
                              String schemaName)
                       throws StreamBaseException
```
    Return the Schema object for the given name
    
    Specified by:
    
    getSchemaByName in interface Admin
    
    Parameters:
    
    schemaName - the name of the Schema to lookup
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    the Schema for the given name
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - drain
```
public void drain(long timeoutMS,
                  String containerName)
           throws StreamBaseException
```
    Description copied from interface: Admin
    
    Drain a StreamBase container or if empty the entire Server
    
    Specified by:
    
    drain in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    containerName - optional containerName
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - getOperatorProperties
```
public String[] getOperatorProperties(long timeoutMS,
                                      String operatorName)
                               throws StreamBaseException
```
    Description copied from interface: Admin
    
    For the given Operator, return its set of properties and their values.
    
    Specified by:
    
    getOperatorProperties in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    operatorName - The operator whose properties are retrieved.
    
    Returns:
    
    set of operator properties and values
    
    Throws:
    
    StreamBaseException
  - getOperatorProperty
```
public String getOperatorProperty(long timeoutMS,
                                  String operatorName,
                                  String propertyName)
                           throws StreamBaseException
```
    Return the value of the given property on the given Operator.
    
    Specified by:
    
    getOperatorProperty in interface Admin
    
    Parameters:
    
    operatorName - The operator whose property value is retrieved.
    
    propertyName - The property whose value is retrieved.
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    set of operator properties and values
    
    Throws:
    
    StreamBaseException
  - setOperatorProperty
```
public void setOperatorProperty(long timeoutMS,
                                String operatorName,
                                String propertyName,
                                String value)
                         throws StreamBaseException
```
    On the given Operator, set the given property to the given value.
    
    Specified by:
    
    setOperatorProperty in interface Admin
    
    Parameters:
    
    operatorName - The operator whose property value is set.
    
    propertyName - The property whose value is set.
    
    value - The value set.
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Throws:
    
    StreamBaseException
  - operatorStatus
```
public String[] operatorStatus(long timeoutMS,
                               String containerName)
                        throws StreamBaseException
```
    Return the status of each Operator present in the StreamBase server.
    
    Specified by:
    
    operatorStatus in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    containerName - name of the container
    
    Returns:
    
    An array of Strings, each String hold the status of an Operator present in the server.
    
    Throws:
    
    StreamBaseException
  - status
```
public String[] status(long timeoutMS,
                       boolean verbose)
                throws StreamBaseException
```
    Return the status of the StreamBase Server
    
    Specified by:
    
    status in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    verbose - return a verbose status
    
    Returns:
    
    the status
    
    Throws:
    
    StreamBaseException - thrown on network and other errors
  - subscribe
```
public SubscriptionEntry subscribe(long timeoutMS,
                                   SubscriptionEntry subscription,
                                   List<TupleConnections.StreamTupleConnection> connections)
                            throws StreamBaseException
```
    Subscribe to an output stream with predicate
    
    Specified by:
    
    subscribe in interface Admin
    
    Parameters:
    
    connections - the list of tupleconnections on which to subscribe to
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    subscription - a SubscriptionEntry describing the desired subscription. Contains the StreamProperties of the desired stream, an optional predicate, and an optional logical stream to associate with the predicate.
    
    Returns:
    
    a subscription entry
    
    Throws:
    
    StreamBaseException - server errors, or network errors.
  - unsubscribe
```
public void unsubscribe(long timeoutMS,
                        StreamProperties props,
                        String logicalstream,
                        List<TupleConnections.StreamTupleConnection> connections)
                 throws StreamBaseException
```
    UnSubscribe to an output stream.
    
    Specified by:
    
    unsubscribe in interface Admin
    
    Parameters:
    
    props - the stream
    
    logicalstream - the name of the logical stream.
    
    connections - the list of tupleconnections on which to subscribe to
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Throws:
    
    StreamBaseException - server errors, or network errors.
  - listConnections
```
public String[] listConnections(long timeoutMS,
                                StreamBaseAdminClient.ListConnectionArgument... args)
                         throws StreamBaseException
```
    Return an array of client connections
    
    Specified by:
    
    listConnections in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    args - arguments for the command
    
    Returns:
    
    an array of client connections
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - internalCommand
```
public String[] internalCommand(long timeoutMS,
                                String... args)
                         throws StreamBaseException
```
    Run the given internal command
    
    Specified by:
    
    internalCommand in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    args - the arguments for the command
    
    Returns:
    
    an array of client connections
    
    Throws:
    
    StreamBaseException - thrown on network or other errors
  - enqueue
```
public void enqueue(long timeoutMS,
                    StreamProperties props,
                    Collection<String> tuples)
             throws StreamBaseException
```
    Description copied from interface: Admin
    
    Enqueue a list of CSV encoded tuples using connectionless XMLRPC
    
    Specified by:
    
    enqueue in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    props - StreamProperties for stream
    
    tuples - list of tuples
    
    Throws:
    
    StreamBaseException
  - setRuntimeParam
```
public void setRuntimeParam(long timeoutMS,
                            String paramName,
                            String paramValue,
                            String operator)
                     throws StreamBaseException
```
    Description copied from interface: Admin
    
    set the given runtime param
    
    Specified by:
    
    setRuntimeParam in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    paramName - the name of the param
    
    paramValue - the value of the command
    
    operator - the operator for the param
    
    Throws:
    
    StreamBaseException
  - addContainer
```
public String[] addContainer(long timeoutMS,
                             String containerName,
                             byte[] application,
                             List<String> containerStreamMappings)
                      throws StreamBaseException
```
    Description copied from interface: Admin
    
    Add the given application to the given container in the StreamBaseServer
    
    Specified by:
    
    addContainer in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    containerName - the containerName
    
    application - contents of an application. Text sbapp, ssql or binary contents of a jar file
    
    containerStreamMappings - stream mappings between containers. Each member of the list should contain a mapping. For example: newContainer.newStream=oldContainer.oldStream
    
    Returns:
    
    results if any
    
    Throws:
    
    StreamBaseException - thrown on typecheck and other errors
  - addDeploy
```
public String[] addDeploy(long timeoutMS,
                          byte[] deploy,
                          List<String> args)
                   throws StreamBaseException
```
    Description copied from interface: Admin
    
    Add the given deploy file to the server. This will add all containers and all container connections defined in the deploy file. At that point, they are treated as any other container or container connection, and may be manipulated by modifyContainer and removeContainer. The given bytes may either be UTF-8 XML that conforms to the deploy file xsd, or a StreamBase Archive that was produced by running the sbargen command on an XML deploy file.
    
    Specified by:
    
    addDeploy in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    deploy - contents of deploy file. XML text or binary contents of an sbar file made from a deploy file.
    
    args - command arguments
    
    Returns:
    
    results if any
    
    Throws:
    
    StreamBaseException - thrown on typecheck and other errors
  - restartContainer
```
public String[] restartContainer(long timeoutMS,
                                 String containerName)
                          throws StreamBaseException
```
    Description copied from interface: Admin
    
    Restart the given container
    
    Specified by:
    
    restartContainer in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    containerName - the name of the container to restart
    
    Returns:
    
    results if any
    
    Throws:
    
    StreamBaseException
  - removeContainer
```
public String[] removeContainer(long timeoutMS,
                                String containerName,
                                List<String> args)
                         throws StreamBaseException
```
    Description copied from interface: Admin
    
    Remove the given container in the StreamBaseServer
    
    Specified by:
    
    removeContainer in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    containerName - the containerName
    
    args - command arguments
    
    Returns:
    
    results if any
    
    Throws:
    
    StreamBaseException - thrown on typecheck and other errors
  - modifyContainer
```
public String[] modifyContainer(long timeoutMS,
                                String containerName,
                                List<String> args)
                         throws StreamBaseException
```
    Modify the given container
    
    Specified by:
    
    modifyContainer in interface Admin
    
    Parameters:
    
    containerName -
    
    args - list of arguments
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    results if any
    
    Throws:
    
    StreamBaseException
  - killConnection
```
public String[] killConnection(long timeoutMS,
                               byte[] connectionId)
                        throws StreamBaseException
```
    Description copied from interface: Admin
    
    Kill the connection with the given connectionId
    
    Specified by:
    
    killConnection in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    status of kill command
    
    Throws:
    
    StreamBaseException
  - killAllConnections
```
public String[] killAllConnections(long timeoutMS)
                            throws StreamBaseException
```
    Description copied from interface: Admin
    
    Kill all of the connections on the server
    
    Specified by:
    
    killAllConnections in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    status of kill command
    
    Throws:
    
    StreamBaseException
  - manageJdbcConnections
```
public String[] manageJdbcConnections(long timeoutMS,
                                      List<String> args)
                               throws StreamBaseException
```
    Description copied from interface: Admin
    
    Manage jdbc connections:
    
    count [name]
    Count the open JDBC connections to the named data source (or all data sources if ommitted)
    
    close [name]
    Close any open JDBC connections to the named data source (or all data sources if ommitted)
    
    Specified by:
    
    manageJdbcConnections in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    args - a list that must contain at least one command string (close or count), and may contain an optional second argument string (the name of a data source). When no argument string is given, the command will apply to all data sources.
    
    Returns:
    
    for close, one string containing the number of connections closed for count, one string containing the number of open connections
    
    Throws:
    
    StreamBaseException - throw on network or other errors
  - setLeadershipStatus
```
public void setLeadershipStatus(long timeoutMS,
                                Constants.LeadershipStatus leadershipStatus)
                         throws StreamBaseException
```
    Description copied from interface: Admin
    
    Set the leadership status of the server.
    This method is no longer supported since the StreamBase 10 platform release. Please consult the documentation.
    
    Specified by:
    
    setLeadershipStatus in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    leadershipStatus - new leadership status
    
    Throws:
    
    StreamBaseException
  - getLeadershipStatus
```
public Constants.LeadershipStatus getLeadershipStatus(long timeoutMS)
                                               throws StreamBaseException
```
    Description copied from interface: Admin
    
    Get the leadership status of the server.
    This method is no longer supported since the StreamBase 10 platform release. Please consult the documentation.
    
    Specified by:
    
    getLeadershipStatus in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    Returns:
    
    the leadership status of the server
    
    Throws:
    
    StreamBaseException
  - addExceptions
```
public static List<Throwable> addExceptions(List<Throwable> exceptions,
                                            Throwable current)
```
    add the given exception to the list of exceptions
    
    Parameters:
    
    exceptions - list of possibly exceptions (possibly null)
    
    current - exception to add
    
    Returns:
    
    list of exceptions
  - processExceptions
```
public static StreamBaseException processExceptions(String message,
                                                    List<Throwable> exceptions,
                                                    String baseURIString,
                                                    Class<?> exceptionsCheck)
```
    Look through the exceptions; if we have one that isn't an XMLRPCException then throw that one otherwise bundle them all up into a list exception.
    
    Parameters:
    
    message - the message to use when throwing a new exception
    
    exceptions - the list of exceptions from the call
    
    baseURIString -
    
    exceptionsCheck - the list of exceptions to check against
    
    Returns:
    
    a meaningful exception
  - setConnectionID
```
public void setConnectionID(ByteString _connectionid)
```
    Description copied from interface: Admin
    
    Set the Connection ID
    
    Specified by:
    
    setConnectionID in interface Admin
  - getConnectionID
```
public ByteString getConnectionID()
```
    Description copied from interface: Admin
    
    Return the connection id (which may be null)
    
    Specified by:
    
    getConnectionID in interface Admin
    
    Returns:
    
    connection id (which may be null)
  - createBaseURIString
```
public static String createBaseURIString(Collection<StreamBaseURI> uris)
```
    Create a URI string of baseURI's from a list of uris
    
    Parameters:
    
    uris -
    
    Returns:
    
    a base URI string
  - getDynamicVariables
```
public Tuple getDynamicVariables(long timeoutMS,
                                 Path modulePath)
                          throws StreamBaseException
```
    Description copied from interface: Admin
    
    Return the current value of the dynamic variables in the given module, as a Tuple of field name to Java value.
    
    Specified by:
    
    getDynamicVariables in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    modulePath - the path to the module
    
    Returns:
    
    a Tuple of all the module's dynamic variables. The field names are the names of the dynamic variables, and the values are their current values.
    
    Throws:
    
    StreamBaseException - on nonexistence of the path, network, if the module contains no dynamic variables, or other errors.
  - setDynamicVariable
```
public void setDynamicVariable(long timeoutMS,
                               Path dynamicVariablePath,
                               Object value)
                        throws StreamBaseException
```
    Description copied from interface: Admin
    
    Set the value of the given dynamic variable to the given value.
    
    Specified by:
    
    setDynamicVariable in interface Admin
    
    Parameters:
    
    timeoutMS - the timeout in milliseconds to wait for the command to complete
    
    dynamicVariablePath - the path to the dynamic variable
    
    value - the value to set the variable to
    
    Throws:
    
    StreamBaseException
  - fastForwardTime
```
public void fastForwardTime(long timeout,
                            Object value)
                     throws StreamBaseException
```
    Description copied from interface: Admin
    
    Number of milliseconds to jump forward in time. Note that if you specify a negative number for msecs, the behavior could vary depending on the TimeService implementation. (no guaranteed what could happen!)
    
    Specified by:
    
    fastForwardTime in interface Admin
    
    Parameters:
    
    timeout - Timeout in milliseconds to wait for completion
    
    value - number of milliseconds to jump forward in time
    
    Throws:
    
    StreamBaseException - Error forwarding time
  - getEvalCacheContent
```
public String getEvalCacheContent(long timeout,
                                  String containerName)
                           throws StreamBaseException
```
    Description copied from interface: Admin
    
    Get evaluation cache content
    
    Specified by:
    
    getEvalCacheContent in interface Admin
    
    Parameters:
    
    timeout - Timeout in milliseconds to wait for completion
    
    containerName - Container name
    
    Returns:
    
    Cache contents
    
    Throws:
    
    StreamBaseException - Error reading cache
  - getTargetTime
```
public String getTargetTime(long timeout)
                     throws StreamBaseException
```
    Description copied from interface: Admin
    
    Get target time
    
    Specified by:
    
    getTargetTime in interface Admin
    
    Parameters:
    
    timeout - Timeout in milliseconds to wait for completion
    
    Returns:
    
    Target time
    
    Throws:
    
    StreamBaseException - Error getting time
  - getDynamicVariableField
```
public Schema.Field getDynamicVariableField(long timeoutMS,
                                            Path dynamicVariablePath)
                                     throws StreamBaseException
```
    Throws:
    
    StreamBaseException
  - readTable
```
public List<Tuple> readTable(long timeoutMS,
                             String tablePath,
                             int rowLimit,
                             String predicate)
                      throws StreamBaseException
```
    Description copied from interface: Admin
    
    Return rows from the table.
    
    Specified by:
    
    readTable in interface Admin
    
    Parameters:
    
    timeoutMS - timeout in milliseconds
    
    tablePath - Path to the table.
    
    rowLimit - Limit on number of rows to return, or -1 for all rows.
    
    Returns:
    
    A list of rows from the table.
    
    Throws:
    
    StreamBaseException - If the connection is not valid or the server cannot be contacted.
  - clearEvalCache
```
public String clearEvalCache(long timeoutMS,
                             String containerName)
                      throws StreamBaseException
```
    Description copied from interface: Admin
    
    Clear evaluation cache
    
    Specified by:
    
    clearEvalCache in interface Admin
    
    Parameters:
    
    timeoutMS - Timeout in milliseconds to wait for completion
    
    containerName - Container name
    
    Returns:
    
    Cache contents
    
    Throws:
    
    StreamBaseException - Error clearing cache
  - getMapperCacheContent
```
public String getMapperCacheContent(long timeoutMS,
                                    String containerName)
                             throws StreamBaseException
```
    Description copied from interface: Admin
    
    Get mapper cache content
    
    Specified by:
    
    getMapperCacheContent in interface Admin
    
    Parameters:
    
    timeoutMS - Timeout in milliseconds to wait for completion
    
    containerName - Container name
    
    Returns:
    
    Cache contents
    
    Throws:
    
    StreamBaseException - Error reading cache
  - getNamesForContainer
```
public Map<Integer,String> getNamesForContainer(long timeoutMS,
                                                int id)
                                         throws StreamBaseException
```
    Description copied from interface: Admin
    
    Return a map of id and names for the given container id.
    
    Specified by:
    
    getNamesForContainer in interface Admin
    
    Returns:
    
    a map of id and names for the given container id
    
    Throws:
    
    StreamBaseException

Class HAAdmin

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HAAdmin

Method Detail

isHA

getByteOrder

modifyApplication

typecheck

shutdown

shutdownOperators

restartOperators

suspendOperators

suspend

resumeOperators

resume

describe

checkLicense

getStreamProperties

getStreamProperties

getStreamPropertiesByHash

listEntities

getSchemaByHash

getSchemaByName

drain

getOperatorProperties

getOperatorProperty

setOperatorProperty

operatorStatus

status

subscribe

unsubscribe

listConnections

internalCommand

enqueue

setRuntimeParam

addContainer

addDeploy

restartContainer

removeContainer

modifyContainer

killConnection

killAllConnections

manageJdbcConnections

setLeadershipStatus

getLeadershipStatus

addExceptions

processExceptions

setConnectionID

getConnectionID

createBaseURIString

getDynamicVariables

setDynamicVariable

fastForwardTime

getEvalCacheContent

getTargetTime

getDynamicVariableField

readTable

clearEvalCache

getMapperCacheContent

getNamesForContainer