public interface Project extends DispatchableEntity<ProjectEvent.Type,ProjectEvent>
| Modifier and Type | Interface and Description |
|---|---|
static interface |
Project.Deployment
Project deployment properties - describe where and how the project is running
in the cluster.
|
| Modifier and Type | Method and Description |
|---|---|
void |
close()
The project is deregistered with the SDK and is not available for interaction anymore.
|
void |
connect(int milliseconds)
In DIRECT access mode tries to connect to a running project and returns if connection succeeds.
|
Publisher |
createPublisher()
Calls createPublisher(PublisherOptions) internally with default PublisherOptions.
|
Publisher |
createPublisher(PublisherOptions options)
Creates a new Publisher to the server.
|
Subscriber |
createSubscriber()
Calls createSubscriber(SubscriberOptions) internally with default SubscriberOptions.
|
Subscriber |
createSubscriber(SubscriberOptions options)
Creates a new Subscriber to read data from the project.
|
void |
disconnect()
Disconnects from the backend project.
|
AdapterController |
getAdapterController()
Retrieve a
AdapterController instance. |
Project.Deployment |
getCurrentDeployment()
Retrieve the deployment details for this project.
|
Debugger |
getDebugger()
Retrieves a Debugger object that can be used to debug this instance of the project.
|
java.lang.String[] |
getErrorStreamNames()
Retrieve the names of all error streams defined in the project.
|
java.lang.String[] |
getIntermediateStreamNames()
Retrieve the names of all transient streams that are generated internally by the
project.
|
int |
getLatency(java.lang.String streamName)
Returns the latency of a specified stream
|
java.lang.String |
getLog()
Retrieve the full contents of the project's log file.
|
java.lang.String |
getLogfileLines(int n)
Retrieve the specified number of lines from the project's log file
|
java.lang.String[] |
getModelledStreamNames()
Retrieve the names of all streams that are part of the model being run in the
connected project.
|
java.lang.String |
getName()
Retrieve the project's name.
|
Server |
getServer()
Retrieve the parent Server object
|
java.util.HashMap |
getStatistics(java.lang.String streamName)
Returns the statistics of a specified stream by name on a project
|
Stream |
getStream(java.lang.String streamName)
Retrieve the
Stream object corresponding to the stream name. |
java.lang.String[] |
getSystemStreamNames()
Retrieve the names of all system streams in the project.
|
Server.Application.Type |
getType()
Retrieve the type of the project.
|
Uri |
getUri()
Retrieve the project's Uri.
|
java.lang.String |
getWorkspace()
Retrieve the workspace name this project is deployed under
|
boolean |
isClosed()
Check if the Project is closed.
|
boolean |
isConnected()
Check if the Project instance is currently connected to a running project.
|
boolean |
isQuiesced()
Check if the backend project on the cluster is quiesced.
|
deregisterSelection, dispatch, removeCallback, selectWith, setCallback, updateUri getUri()
java.lang.String getName()
java.lang.String getWorkspace()
Server getServer()
Server.Application.Type getType()
Application.Type}java.lang.String[] getModelledStreamNames()
throws java.io.IOException
java.io.IOExceptionjava.lang.String[] getIntermediateStreamNames()
throws java.io.IOException
java.io.IOExceptionjava.lang.String[] getSystemStreamNames()
throws java.io.IOException
java.io.IOExceptionjava.lang.String[] getErrorStreamNames()
throws java.io.IOException
java.io.IOExceptionStream getStream(java.lang.String streamName) throws java.io.IOException
Stream object corresponding to the stream name. Can be called
in all access modes.
NOTE: This call verifies connectivity with the backed cluster and can be costly. It if advisable to query and cache this object. Frequent retrieval may result in degraded performance on the backend.
streamName - stream to query forStream object corresponding to the stream namejava.io.IOExceptionjava.lang.String getLog()
throws java.io.IOException
java.io.IOExceptionjava.lang.String getLogfileLines(int n)
throws java.io.IOException
n - Number of lines to returnjava.io.IOExceptionjava.util.HashMap getStatistics(java.lang.String streamName)
throws java.io.IOException
streamName - The name of the stream to get the statistics forjava.io.IOExceptionProject.Deployment getCurrentDeployment() throws java.io.IOException
java.io.IOExceptionboolean isConnected()
boolean isClosed()
boolean isQuiesced()
throws java.io.IOException
java.io.IOExceptionvoid connect(int milliseconds)
throws java.io.IOException,
javax.security.auth.login.LoginException
milliseconds - time to wait for the project to be started if not already running.java.io.IOException - if connection failsjavax.security.auth.login.LoginException - if authentication failsvoid disconnect()
void close()
throws java.io.IOException
java.io.IOExceptionSubscriber createSubscriber() throws java.io.IOException
Subscriberjava.io.IOExceptionSubscriber createSubscriber(SubscriberOptions options) throws java.io.IOException
options - options for the SubcriberSubscriberjava.io.IOExceptionPublisher createPublisher() throws java.io.IOException
java.io.IOExceptionPublisher createPublisher(PublisherOptions options) throws java.io.IOException
options - java.io.IOExceptionDebugger getDebugger() throws java.io.IOException
java.io.IOExceptionAdapterController getAdapterController() throws java.io.IOException
AdapterController instance.AdapterControllerjava.io.IOExceptionint getLatency(java.lang.String streamName)
throws java.lang.Exception
streamName - The name of the stream to get the latency forjava.lang.Exception