public class RestAcquisitionQueue extends Object
RestAcquisitionQueue
class allows administrators to create REST
acquisition queues (Rest bridge in).
The Rest bridge destinations rely on a particular Joram service which purpose is to maintain valid connections with the foreign REST Joram servers. The valid properties define by this destination are:
Modifier and Type | Field and Description |
---|---|
private int |
acquisitionPeriod |
private String |
host |
private long |
idleTimeout |
private boolean |
mediaTypeJson |
private String |
password |
private int |
port |
static String |
RESTAcquisition
Class name of handler allowing to acquire messages to a foreign REST provider.
|
private long |
timeout |
private boolean |
useOldAPI |
private String |
username |
Constructor and Description |
---|
RestAcquisitionQueue() |
Modifier and Type | Method and Description |
---|---|
Queue |
create(int serverId,
String dest)
Administration method creating and deploying a REST acquisition queue on a given server.
|
Queue |
create(int serverId,
String name,
String dest)
Administration method creating and deploying a REST acquisition queue on a given server.
|
Queue |
create(int serverId,
String name,
String dest,
Properties props)
Administration method creating and deploying a REST acquisition queue on a given server.
|
Queue |
create(String dest)
Administration method creating and deploying a REST acquisition queue on the local server.
|
long |
getAcquisitionPeriod() |
String |
getHost() |
long |
getIdleTimeout() |
String |
getPassword() |
int |
getPort() |
long |
getTimeout() |
String |
getUsername() |
boolean |
isMediaTypeJson() |
boolean |
isUseOldAPI() |
RestAcquisitionQueue |
setAcquisitionPeriod(int acquisitionPeriod) |
RestAcquisitionQueue |
setHost(String host) |
RestAcquisitionQueue |
setIdleTimeout(long idleTimeout) |
RestAcquisitionQueue |
setMediaTypeJson(boolean mediaTypeJson) |
RestAcquisitionQueue |
setPassword(String password) |
RestAcquisitionQueue |
setPort(int port) |
RestAcquisitionQueue |
setTimeout(long timeout) |
RestAcquisitionQueue |
setUseOldAPI(boolean useOldAPI) |
RestAcquisitionQueue |
setUsername(String userName) |
public static final String RESTAcquisition
private String host
private int port
private boolean useOldAPI
private String username
private String password
private boolean mediaTypeJson
private long timeout
private int acquisitionPeriod
private long idleTimeout
public String getHost()
public RestAcquisitionQueue setHost(String host)
public int getPort()
public RestAcquisitionQueue setPort(int port)
port
- the port to setpublic boolean isUseOldAPI()
public RestAcquisitionQueue setUseOldAPI(boolean useOldAPI)
useOldAPI
- the useOldAPI to setpublic String getUsername()
public RestAcquisitionQueue setUsername(String userName)
userName
- the userName to setpublic String getPassword()
public RestAcquisitionQueue setPassword(String password)
password
- the password to setpublic boolean isMediaTypeJson()
public RestAcquisitionQueue setMediaTypeJson(boolean mediaTypeJson)
mediaTypeJson
- the mediaTypeJson to setpublic long getTimeout()
public RestAcquisitionQueue setTimeout(long timeout)
timeout
- the timeout to setpublic long getAcquisitionPeriod()
public RestAcquisitionQueue setAcquisitionPeriod(int acquisitionPeriod)
acquisitionPeriod
- the acquisitionPeriod to setpublic long getIdleTimeout()
public RestAcquisitionQueue setIdleTimeout(long idleTimeout)
public Queue create(String dest) throws ConnectException, AdminException
The request fails if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
dest
- The name of the foreign destination.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String, String, Properties)
public Queue create(int serverId, String dest) throws ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
serverId
- The identifier of the server where deploying the queue.dest
- The name of the foreign destination.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String, String, Properties)
public Queue create(int serverId, String name, String dest) throws ConnectException, AdminException
The request fails if the target server does not belong to the platform, or if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
serverId
- The identifier of the server where deploying the queue.name
- The name of the created queue.dest
- The name of the foreign destination.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String, String, Properties)
public Queue create(int serverId, String name, String dest, Properties props) throws ConnectException, AdminException
In addition to properties used to configure acquisition queues a set of specific properties allows to configure Rest/JMS acquisition destination:
Be careful this method use the static AdminModule connection.
serverId
- The identifier of the server where deploying the queue.name
- The name of the created queue.dest
- The name of the foreign destination.props
- A Properties object containing all needed parameters.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.Copyright © 2020 ScalAgent D.T.. All rights reserved.