public class CollectorQueue extends Object
CollectorQueue
class allows administrators to create JMS
collector queues.
Collector queues are special destinations usable to collect a document from a specified URL. They can be used to periodically import a file from an URL to a Joram's message and store it in this queue.
Modifier and Type | Field and Description |
---|---|
static String |
URLAcquisition
Class name of handler allowing to acquire messages from a specified URL.
|
Constructor and Description |
---|
CollectorQueue() |
Modifier and Type | Method and Description |
---|---|
static Queue |
create(int serverId,
String url)
Administration method creating and deploying an URL acquisition queue on a given server.
|
static Queue |
create(int serverId,
String name,
String url)
Administration method creating and deploying an URL acquisition queue on a given server.
|
static Queue |
create(int serverId,
String name,
String url,
Properties props)
Administration method creating and deploying an URL acquisition queue on a given server.
|
static Queue |
create(String url)
Administration method creating and deploying an URL acquisition queue on the local server.
|
public static final String URLAcquisition
public static Queue create(String url) throws ConnectException, AdminException
The request fails if the destination deployment fails server side.
Be careful this method use the static AdminModule connection.
url
- the URL locating the element to collect.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String, String, Properties)
public static Queue create(int serverId, String url) 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.url
- the URL locating the element to collect.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String, String, Properties)
public static Queue create(int serverId, String name, String url) 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.url
- the URL locating the element to collect.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.create(int, String, String, Properties)
public static Queue create(int serverId, String name, String url, Properties props) throws ConnectException, AdminException
A set of properties is used to configure the 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.url
- the URL locating the element to collect.props
- A Properties object containing all needed parameters.ConnectException
- If the administration connection is closed or broken.AdminException
- If the request fails.Copyright © 2023 ScalAgent D.T.. All rights reserved.