public interface BaseClient
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TIBCO_STATSVCS_SSL_ALLOW_ANY_CERTIFICATE
System property; set to true to disable server certificate verification.
|
Modifier and Type | Method and Description |
---|---|
ConfigurationInfo |
getConfigurationInfo()
Returns the current configuration of the server.
|
java.util.Properties |
getExtendedServerInfo()
Retrieves the detailed server information.
|
SplusDataResult |
getJobDetails(java.lang.String jobId)
Returns a
SplusDataResult object for the specified
jobId . |
NotificationListener |
getNotificationListener()
Retrieves the default notification listener, which is notified with
events for all jobs.
|
NotificationListener |
getNotificationListener(java.lang.String jobId)
Retrieves the notification listener associated with a specific job.
|
java.lang.String |
getPassword()
Retrieves the user's password.
|
java.lang.String |
getUserName()
Retrieves the user's name.
|
byte[] |
receiveBinaryObject(java.lang.String jobId,
SerializationType serializationType,
java.lang.String objectId)
This method allows a client application to retrieve an intermediate job execution result generated
by a job running on the server.
|
void |
removeNotificationListener()
Removes the default notification listener.
|
void |
removeNotificationListener(java.lang.String jobId)
Removes the notification listener associated with a specific job.
|
void |
setNotificationListener(NotificationListener listener)
Sets the default notification listener, which is notified with events for
all jobs.
|
void |
setNotificationListener(NotificationListener listener,
java.lang.String jobId)
Sets the notification listener associated with a specific job.
|
java.lang.String |
startSession()
Starts a session on the server.
|
void |
stopSession(java.lang.String sessionToken)
Stops a session.
|
static final java.lang.String TIBCO_STATSVCS_SSL_ALLOW_ANY_CERTIFICATE
SplusDataResult getJobDetails(java.lang.String jobId) throws JobDoesNotExistException, NotAuthenticatedException
SplusDataResult
object for the specified
jobId
.
An existing job can have a status of:
Deleted jobs are not considered existing jobs.
When you send an asynchronous evaluation to the server, the server
immediately returns an SplusDataResult
object containing the
jobId
and status. (The jobId
is a property of
SplusDataResult
.) Use this jobId
to retrieve the
job.
Note that the AdministrationClient
, the
ExpressionClient
, and the FunctionClient
all
contain getJob
methods that are identical. This design
allows you to retrieve a job using only the API object for that service
(that is, you do not have to create an AdministrationClient
object to get a job).
jobId
- A string containing the jobId for the specified existing job.SplusDataResult
object for the specified jobId.NotAuthenticatedException
- if the user name or password could not be authenticated.JobDoesNotExistException
- if the specified job is not found.java.lang.IllegalArgumentException
- if jobId format is invalid (not a number)FunctionClient
,
ExpressionClient
,
SplusDataResult
byte[] receiveBinaryObject(java.lang.String jobId, SerializationType serializationType, java.lang.String objectId) throws JobDoesNotExistException, NotAuthenticatedException
eNotificationMessageType.eJobObjectSent
.jobId
- job Id this result object is associated withserializationType
- serialization type used to encode this objectobjectId
- object Id received in the notification message.NotAuthenticatedException
- if the user name or password could not be authenticated.JobDoesNotExistException
- if the specified job is not found.void setNotificationListener(NotificationListener listener)
listener
- The default notification listener.NotificationListener getNotificationListener()
void setNotificationListener(NotificationListener listener, java.lang.String jobId)
listener
- The listener to register.jobId
- The ID of the job for which you want the notification
listener.NotificationListener getNotificationListener(java.lang.String jobId)
jobId
- The ID of the job associated with the notification listener.void removeNotificationListener()
void removeNotificationListener(java.lang.String jobId)
jobId
- The ID of the job for which you want to remove the notification
listener.java.lang.String getPassword()
java.lang.String getUserName()
userName
- A string containing the user's name.java.util.Properties getExtendedServerInfo() throws NotAuthenticatedException
Properties
object that contains key values pairs of
server information.NotAuthenticatedException
- if the user name or password could not be authenticated.ConfigurationInfo getConfigurationInfo() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- - if getting the list failed due to an internal failure.ConfigurationInfo
java.lang.String startSession() throws java.lang.IllegalStateException, NotAuthenticatedException, java.lang.IllegalArgumentException, UnableToAllocateSessionException
java.lang.IllegalStateException
NotAuthenticatedException
java.lang.IllegalArgumentException
UnableToAllocateSessionException
- if not enough free engines available on the servervoid stopSession(java.lang.String sessionToken) throws java.lang.IllegalStateException, NotAuthenticatedException, java.lang.IllegalArgumentException, SessionDoesNotExistException
sessionToken
- a session token (unique session Id)java.lang.IllegalStateException
NotAuthenticatedException
java.lang.IllegalArgumentException
SessionDoesNotExistException
- if session is not found