public class RestDistributionQueue extends Object
RestDistributionQueue
class allows administrators to create REST
distribution queues (REST bridge out).
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 boolean |
async |
private boolean |
batch |
private String |
host |
private long |
idleTimeout |
private String |
password |
private int |
period |
private int |
port |
static String |
RESTDistribution
Class name of handler allowing to distribute messages to a foreign REST provider.
|
private boolean |
useOldAPI |
private String |
userName |
Constructor and Description |
---|
RestDistributionQueue() |
Modifier and Type | Method and Description |
---|---|
Queue |
create(int serverId,
String dest)
Administration method creating and deploying a REST distribution queue on a given server.
|
Queue |
create(int serverId,
String name,
String dest)
Administration method creating and deploying a REST distribution queue on a given server.
|
Queue |
create(int serverId,
String name,
String dest,
Properties props)
Administration method creating and deploying a REST distribution queue on a given server.
|
Queue |
create(String dest)
Administration method creating and deploying a REST distribution queue on the local server.
|
String |
getHost() |
long |
getIdleTimeout() |
String |
getPassword() |
int |
getPeriod() |
int |
getPort() |
String |
getUserName() |
boolean |
isAsync()
Gets the async parameter.
|
boolean |
isBatch()
Gets the batch parameter.
|
boolean |
isUseOldAPI() |
RestDistributionQueue |
setAsync(boolean async)
Sets the async parameter.
|
RestDistributionQueue |
setBatch(boolean batch)
Sets the batch parameter.
|
RestDistributionQueue |
setHost(String host) |
RestDistributionQueue |
setIdleTimeout(long idleTimeout) |
RestDistributionQueue |
setPassword(String password) |
RestDistributionQueue |
setPeriod(int period) |
RestDistributionQueue |
setPort(int port) |
RestDistributionQueue |
setUseOldAPI(boolean useOldAPI) |
RestDistributionQueue |
setUserName(String userName) |
public static final String RESTDistribution
private String host
private int port
private boolean useOldAPI
private String userName
private String password
private boolean batch
private boolean async
private int period
private long idleTimeout
public String getHost()
public RestDistributionQueue setHost(String host)
public int getPort()
public RestDistributionQueue setPort(int port)
port
- the port to setpublic boolean isUseOldAPI()
public RestDistributionQueue setUseOldAPI(boolean useOldAPI)
useOldAPI
- the useOldAPI to setpublic String getUserName()
public RestDistributionQueue setUserName(String userName)
userName
- the userName to setpublic String getPassword()
public RestDistributionQueue setPassword(String password)
password
- the password to setpublic boolean isBatch()
public RestDistributionQueue setBatch(boolean batch)
batch
- the batch to setpublic boolean isAsync()
public RestDistributionQueue setAsync(boolean async)
async
- the batch to setpublic int getPeriod()
public RestDistributionQueue setPeriod(int period)
period
- the period to setpublic long getIdleTimeout()
public RestDistributionQueue 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 distribution queues a set of specific properties allows to configure Rest/JMS distribution 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.