public class StepClient extends Object implements Closeable
Modifier and Type | Field and Description |
---|---|
protected step.client.credentials.ControllerCredentials |
credentials |
Constructor and Description |
---|
StepClient()
Creates a new
StepClient and logins to the controller
using the controller host and credentials provided by SyspropCredendialsBuilder |
StepClient(step.client.credentials.ControllerCredentials controllerCredentials)
Creates a new
StepClient and logins to the controller
using the credentials provided as argument |
StepClient(String controllerUrl)
Creates a new
StepClient and logins to the controller
without credentials (for controller that have disabled authentication) |
StepClient(String controllerUrl,
String username,
String password)
Creates a new
StepClient and logins to the controller
using the credentials provided as argument |
Modifier and Type | Method and Description |
---|---|
void |
close() |
List<Tenant> |
getAvailableTenants() |
step.client.controller.ControllerServicesClient |
getControllerServicesClient() |
Tenant |
getCurrentTenant() |
RemoteEventBrokerClient |
getEventBrokerClient() |
step.client.executions.RemoteExecutionManager |
getExecutionManager() |
step.functions.execution.FunctionExecutionService |
getFunctionExecutionService() |
step.client.functions.RemoteFunctionManager |
getFunctionManager() |
FunctionPackageClient |
getFunctionPackageClient() |
MultitenancyClient |
getMultitenancyClient() |
PlanBuilders |
getPlanBuilders()
Deprecated.
This method will be removed in future releases. To create a Plan programmatically use
PlanBuilder.create() instead. To parse a plain text plan
use PlanParser directly |
PlanRunners |
getPlanRunners()
Deprecated.
This method will be removed in future releases. To run a plan
locally use
ExecutionEngine directly. To run a plan
located on your controller use RemoteExecutionManager |
step.client.accessors.RemotePlanAccessor |
getPlans() |
step.client.accessors.RemoteAccessors |
getRemoteAccessors() |
step.client.resources.RemoteResourceManager |
getResourceManager() |
step.client.repository.StagingRepositoryClient |
getStagingRepositoryClient()
Deprecated.
The staging client is deprecated and will be removed in future
releases. All executions are now providing an isolated context
thus making the Staging repository useless.
|
void |
selectTenant(String tenantName)
Select a specific tenant.
|
public StepClient()
StepClient
and logins to the controller
using the controller host and credentials provided by SyspropCredendialsBuilder
public StepClient(String controllerUrl)
StepClient
and logins to the controller
without credentials (for controller that have disabled authentication)controllerUrl
- the URL of the controller (for instance: http://mycontroller.com)public StepClient(String controllerUrl, String username, String password)
StepClient
and logins to the controller
using the credentials provided as argumentcontrollerUrl
- the URL of the controller (for instance: http://mycontroller.com)username
- the username to be used to login to the controllerpassword
- the password to be used to login to the controllerpublic StepClient(step.client.credentials.ControllerCredentials controllerCredentials)
StepClient
and logins to the controller
using the credentials provided as argumentcontrollerCredentials
- the complex object already containing all of the login informationpublic void selectTenant(String tenantName) throws Exception
tenantName
- the name of the tenant to be selected. In the GUI this is the name of
tenant as displayed in the dropdownException
public List<Tenant> getAvailableTenants()
public Tenant getCurrentTenant()
public MultitenancyClient getMultitenancyClient()
MultitenancyClient
. Use this client for advanced tenant operationspublic PlanBuilders getPlanBuilders()
PlanBuilder.create()
instead. To parse a plain text plan
use PlanParser
directlypublic step.client.accessors.RemotePlanAccessor getPlans()
public PlanRunners getPlanRunners()
ExecutionEngine
directly. To run a plan
located on your controller use RemoteExecutionManager
public FunctionPackageClient getFunctionPackageClient()
FunctionPackageClient
to add/delete FunctionPackage
s and thus
add/delete Function
s aka Keywords in batchpublic step.client.functions.RemoteFunctionManager getFunctionManager()
public step.functions.execution.FunctionExecutionService getFunctionExecutionService()
public step.client.resources.RemoteResourceManager getResourceManager()
public step.client.executions.RemoteExecutionManager getExecutionManager()
public RemoteEventBrokerClient getEventBrokerClient()
public step.client.accessors.RemoteAccessors getRemoteAccessors()
public step.client.repository.StagingRepositoryClient getStagingRepositoryClient()
public step.client.controller.ControllerServicesClient getControllerServicesClient()
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
IOException
Copyright © 2020. All rights reserved.