public class YEngineConnection extends YConnection
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_HOST |
static int |
DEFAULT_PORT |
_handle, _url
Constructor and Description |
---|
YEngineConnection() |
YEngineConnection(java.lang.String urlStr) |
YEngineConnection(java.lang.String host,
int port) |
YEngineConnection(java.net.URL url) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
cancelAllCases(YSpecificationID specID) |
boolean |
cancelCase(java.lang.String caseID) |
boolean |
connect()
Opens a connection to the engine.
|
java.util.Set<YSpecificationID> |
getAllLoadedVersions(YSpecificationID specID) |
java.util.Set<java.lang.String> |
getAllRunningCases(YSpecificationID specID) |
InterfaceA_EnvironmentBasedClient |
getClient()
Gets the client object maintaining the current connection.
|
java.util.Map<java.lang.String,java.lang.String> |
getExternalDataGateways()
Gets a map of currently installed external data gateways from the engine, in
the form of [name, description]
|
InterfaceB_EnvironmentBasedClient |
getIbClient() |
YLogGatewayClient |
getIeClient() |
java.util.List<SpecificationData> |
getLoadedSpecificationList() |
YParameter[] |
getParametersForService(java.lang.String serviceURI)
Gets an array of required task-level parameters for a service from the engine.
|
java.util.Set<YAWLServiceReference> |
getRegisteredYAWLServices()
Gets the set of currently registered custom services from the engine.
|
YAWLServiceReference |
getService(java.lang.String uri)
Gets the corresponding service object for the URI passed
|
java.lang.String |
getSpecification(YSpecificationID specID) |
protected java.lang.String |
getURLFilePath() |
protected void |
init()
Called from the super class to do any initialisation tasks
|
boolean |
isConnected()
Checks that a connection is open.
|
java.lang.String |
launchCase(YSpecificationID specID,
java.lang.String caseParams,
YLogDataItemList logList) |
void |
unloadAllVersions(YSpecificationID specID,
boolean cancelCases) |
boolean |
unloadSpecification(YSpecificationID specID) |
java.lang.String |
uploadSpecification(YSpecification specification) |
connect, disconnect, disconnect, getHost, getPort, getURL, isConnected, setPassword, setURL, setURL, setURL, setUserID, testConnection
public static final java.lang.String DEFAULT_HOST
public static final int DEFAULT_PORT
public YEngineConnection()
public YEngineConnection(java.lang.String host, int port) throws java.net.MalformedURLException
java.net.MalformedURLException
public YEngineConnection(java.lang.String urlStr)
public YEngineConnection(java.net.URL url)
public boolean connect() throws java.io.IOException
java.io.IOException
- if there's a problem connection to the engine.public boolean isConnected()
public InterfaceA_EnvironmentBasedClient getClient()
getClient
in class YConnection
public java.util.Set<YAWLServiceReference> getRegisteredYAWLServices()
java.io.IOException
- If there is some problem retrieving a fresh set, and the
cache is empty.public YAWLServiceReference getService(java.lang.String uri)
uri
- the URI of the service to getpublic java.util.Map<java.lang.String,java.lang.String> getExternalDataGateways() throws java.io.IOException
java.io.IOException
- If there is some problem retrieving a fresh map, and the
cache is empty.public YParameter[] getParametersForService(java.lang.String serviceURI) throws java.io.IOException
serviceURI
- the URI of the service to get the parameters for.java.io.IOException
- If there is some problem retrieving a fresh array, and the
cache is empty.public java.lang.String uploadSpecification(YSpecification specification) throws java.io.IOException
java.io.IOException
public boolean unloadSpecification(YSpecificationID specID) throws java.io.IOException
java.io.IOException
public java.util.List<SpecificationData> getLoadedSpecificationList() throws java.io.IOException
java.io.IOException
public java.lang.String getSpecification(YSpecificationID specID) throws java.io.IOException
java.io.IOException
public java.util.Set<YSpecificationID> getAllLoadedVersions(YSpecificationID specID) throws java.io.IOException
java.io.IOException
public java.util.Set<java.lang.String> getAllRunningCases(YSpecificationID specID) throws java.io.IOException
java.io.IOException
public java.lang.String cancelAllCases(YSpecificationID specID) throws java.io.IOException
java.io.IOException
public void unloadAllVersions(YSpecificationID specID, boolean cancelCases) throws java.io.IOException
java.io.IOException
public java.lang.String launchCase(YSpecificationID specID, java.lang.String caseParams, YLogDataItemList logList) throws java.io.IOException
java.io.IOException
public boolean cancelCase(java.lang.String caseID) throws java.io.IOException
java.io.IOException
public InterfaceB_EnvironmentBasedClient getIbClient()
public YLogGatewayClient getIeClient()
protected void init()
init
in class YConnection
protected java.lang.String getURLFilePath()
getURLFilePath
in class YConnection