interface Admin
Currently, the lowest implementation layer uses XMLRPC for the protocol.
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.
|
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
|
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 timeoutMS,
Object msecs)
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)
|
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 timeoutMS,
String containerName)
Get evaluation cache content
|
Constants.LeadershipStatus |
getLeadershipStatus(long timeoutMS)
Deprecated.
Legacy high-availability service, migrate to SB 10 high-availability service.
|
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 timeoutMS)
Get target time
|
String[] |
internalCommand(long timeoutMS,
String... args)
run an 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... arg)
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)
|
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.
|
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> operators)
Restart the given Operators on the StreamBase server.
|
void |
resume(long timeoutMS,
String containerName)
Resume a paused StreamBase container of if empty the whole Server
|
void |
resumeOperators(long timeoutMS,
List<String> operators)
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)
Deprecated.
Legacy high-availability service, migrate to SB 10 high-availability service.
|
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> operators)
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.
|
void |
suspend(long timeoutMS,
String name)
Suspend (pause) a StreamBase container or operator
|
void |
suspendOperators(long timeoutMS,
List<String> operators)
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.
|
String[] addContainer(long timeoutMS, String containerName, byte[] application, List<String> containerStreamMappings) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completecontainerName
- the containerNameapplication
- contents of an application. Text sbapp, ssql or binary contents of a jar filecontainerStreamMappings
- stream mappings between containers. Each member of
the list should contain a mapping. For example:
newContainer.newStream=oldContainer.oldStreamStreamBaseException
- thrown on typecheck and other errorsString[] addDeploy(long timeoutMS, byte[] deploy, List<String> args) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completedeploy
- contents of deploy file. XML text or binary contents of an sbar file made from a deploy file.args
- command argumentsStreamBaseException
- thrown on typecheck and other errorsStreamBaseException
- thrown on typecheck and other errorsString[] removeContainer(long timeoutMS, String containerName, List<String> args) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completecontainerName
- the containerNameargs
- command argumentsStreamBaseException
- thrown on typecheck and other errorsString[] modifyContainer(long timeoutMS, String containerName, List<String> args) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completecontainerName
- args
- list of argumentsStreamBaseException
String[] restartContainer(long timeoutMS, String containerName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completecontainerName
- the name of the container to restartStreamBaseException
StreamProperties[] typecheck(long timeoutMS, String application, boolean full) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeapplication
- contents of an application. Text sbapp or ssql.full
- do a full typecheckStreamBaseException
- on network or typecheck errorString shutdown(long timeoutMS, String containerName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completecontainerName
- optional containerNameStreamBaseException
- thrown on network or other errorsTuple getDynamicVariables(long timeoutMS, Path modulePath) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completemodulePath
- the path to the moduleStreamBaseException
- on nonexistence of the path, network, if the module contains
no dynamic variables, or other errors.void setDynamicVariable(long timeoutMS, Path dynamicVariablePath, Object value) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completedynamicVariablePath
- the path to the dynamic variablevalue
- the value to set the variable toStreamBaseException
void fastForwardTime(long timeoutMS, Object msecs) throws StreamBaseException
timeoutMS
- Timeout in milliseconds to wait for completionmsecs
- number of milliseconds to jump forward in timeStreamBaseException
- Error forwarding timeString getTargetTime(long timeoutMS) throws StreamBaseException
timeoutMS
- Timeout in milliseconds to wait for completionStreamBaseException
- Error getting timeString getEvalCacheContent(long timeoutMS, String containerName) throws StreamBaseException
timeoutMS
- Timeout in milliseconds to wait for completioncontainerName
- Container nameStreamBaseException
- Error reading cacheString clearEvalCache(long timeoutMS, String containerName) throws StreamBaseException
timeoutMS
- Timeout in milliseconds to wait for completioncontainerName
- Container nameStreamBaseException
- Error clearing cacheString getMapperCacheContent(long timeoutMS, String containerName) throws StreamBaseException
timeoutMS
- Timeout in milliseconds to wait for completioncontainerName
- Container nameStreamBaseException
- Error reading cacheString[] getOperatorProperties(long timeoutMS, String operatorName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeoperatorName
- The operator whose properties are retrieved.StreamBaseException
String getOperatorProperty(long timeoutMS, String operatorName, String propertyName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeoperatorName
- The operator whose property value is retrieved.propertyName
- The property whose value is retrieved.StreamBaseException
void setOperatorProperty(long timeoutMS, String operatorName, String propertyName, String value) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeoperatorName
- The operator whose property value is set.propertyName
- The property whose value is set.value
- The value set.StreamBaseException
void shutdownOperators(long timeoutMS, List<String> operators) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeoperators
- The Operators to shut downStreamBaseException
- throws on network or other errorsvoid restartOperators(long timeoutMS, List<String> operators) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeoperators
- The Operators to shut downStreamBaseException
- throws on network or other errorsvoid suspendOperators(long timeoutMS, List<String> operators) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeoperators
- the operators to suspendStreamBaseException
- thrown on network or other errorsvoid suspend(long timeoutMS, String name) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completename
- container or operator nameStreamBaseException
- thrown on network or other errorsvoid resumeOperators(long timeoutMS, List<String> operators) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeoperators
- the operators to suspendStreamBaseException
void resume(long timeoutMS, String containerName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completecontainerName
- optional containerNameStreamBaseException
String describe(long timeoutMS, String entityName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeentityName
- the name of the entity to describeStreamBaseException
- thrown on network or other errorsboolean checkLicense(long timeoutMS, String featureName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completefeatureName
- the name of the licensed featureStreamBaseException
- thrown on network or other errorsStreamProperties getStreamProperties(long timeoutMS, String streamName) throws StreamBaseException
CaptureTransformStrategy.FLATTEN
timeoutMS
- the timeout in milliseconds to wait for the command to completestreamName
- the stream name to lookupStreamBaseException
- thrown on network or other errorsStreamProperties getStreamProperties(long timeoutMS, String streamName, CaptureTransformStrategy strategy) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completestreamName
- the stream name to lookupstrategy
- the CaptureTransformStrategy
to use if the target stream has capture fields.StreamBaseException
- thrown on network or other errorsStreamProperties getStreamPropertiesByHash(long timeoutMS, byte[] hash) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completehash
- The Hash to lookupStreamBaseException
- thrown on network or other errorsString[] listEntities(long timeoutMS, String entityType, int flags, CaptureTransformStrategy strategy) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeentityType
- the entity type to do the lookupflags
- FULLY_QUALIFIED_NAMES and INCLUDE_MODULES flagsstrategy
- the capture transform strategyStreamBaseException
- thrown on network or other errorsSchema getSchemaByHash(long timeoutMS, byte[] hash) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completehash
- a byte array that contains a hash valueStreamBaseException
- thrown on network or other errorsSchema getSchemaByName(long timeoutMS, String schemaName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeschemaName
- the name of the Schema to lookupStreamBaseException
- thrown on network or other errorsvoid drain(long timeoutMS, String containerName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completecontainerName
- optional containerNameStreamBaseException
- thrown on network or other errorsString[] operatorStatus(long timeoutMS, String containerName) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completecontainerName
- name of the containerStreamBaseException
String[] status(long timeoutMS, boolean verbose) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeverbose
- return a verbose statusStreamBaseException
- thrown on network and other errorsSubscriptionEntry subscribe(long timeoutMS, SubscriptionEntry subscription, List<TupleConnections.StreamTupleConnection> connections) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completesubscription
- 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.connections
- the list of tupleconnections on which to subscribe toStreamBaseException
- server errors, or network errors.void unsubscribe(long timeoutMS, StreamProperties props, String logicalstream, List<TupleConnections.StreamTupleConnection> connections) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeprops
- the streamlogicalstream
- name of the logical streamconnections
- the list of tupleconnections on which to subscribe toStreamBaseException
- server errors, or network errors.String[] internalCommand(long timeoutMS, String... args) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeargs
- the arguments for the commandStreamBaseException
- thrown on network or other errorsString[] listConnections(long timeoutMS, StreamBaseAdminClient.ListConnectionArgument... arg) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completearg
- arguments for the commandStreamBaseException
- thrown on network or other errorsString[] killConnection(long timeoutMS, byte[] connectionId) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeconnectionId
- StreamBaseException
String[] killAllConnections(long timeoutMS) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeStreamBaseException
String[] manageJdbcConnections(long timeoutMS, List<String> args) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeargs
- 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.close
, one string containing the number of connections closed
for count
, one string containing the number of open connectionsStreamBaseException
- throw on network or other errorsvoid enqueue(long timeoutMS, StreamProperties props, Collection<String> tuples) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeprops
- StreamProperties for streamtuples
- list of tuplesStreamBaseException
void setRuntimeParam(long timeoutMS, String paramName, String paramValue, String operator) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeparamName
- the name of the paramparamValue
- the value of the commandoperator
- the operator for the paramStreamBaseException
boolean isHA()
ByteOrder getByteOrder(long timeoutMS) throws StreamBaseException
timeoutMS
- the timeout in milliseconds to wait for the command to completeStreamBaseException
void setConnectionID(ByteString connectionid)
connectionid
- @Deprecated void setLeadershipStatus(long timeoutMS, Constants.LeadershipStatus leadershipStatus) throws StreamBaseException
This method is no longer supported since the StreamBase 10 platform release. Please consult the documentation.
timeoutMS
- the timeout in milliseconds to wait for the command to completeleadershipStatus
- new leadership statusStreamBaseException
@Deprecated Constants.LeadershipStatus getLeadershipStatus(long timeoutMS) throws StreamBaseException
This method is no longer supported since the StreamBase 10 platform release. Please consult the documentation.
timeoutMS
- the timeout in milliseconds to wait for the command to completeStreamBaseException
ByteString getConnectionID()
List<Tuple> readTable(long timeoutMS, String tablePath, int rowLimit, String predicate) throws StreamBaseException
timeoutMS
- timeout in millisecondstablePath
- Path to the table.rowLimit
- Limit on number of rows to return, or -1 for all rows.predicate
- StreamBaseException
- If the connection is not valid or the server cannot be contacted.Map<Integer,String> getNamesForContainer(long timeoutMS, int id) throws StreamBaseException
timeoutMS
- id
- StreamBaseException
Copyright © 2015–2018 Cloud Software Group, Inc.. All rights reserved.