Namespace "ems"

Using bmm/ems/Admin, you can script the management of TIBCO EMS based objects, including queues, channels, topics, etc. While scripting management of TIBCO EMS objects can be simple and easy using the MainView Middleware Administrator TIBCO EMS API, you must still understand the TIBCO EMS object properties which you want to specify. This can be made easier by reading and understanding AttrDefs.ems.xml that comes with MainView Middleware Administrator. AttrDefs contains a schema for all possible properties of TIBCO EMS objects. For instance, it contains specifications for properties of Queues, Channels, Servers, etc.

AttrDefs is used by the MainView Middleware Administrator user interface to aid in deciding what type of editor to be used for a value (text box vs. combo box), which values should be displayed for selection (e.g. Queue overflow policy allows "Default", "Discard Old", or "Reject New"), etc.

As a scripter, you must know and understand these properties and how you specify them in your script. For instance, to specify that a queue should have an overflow policy set to "Reject New", you need to know the property name (overflow_policy) and that you would use the integer value 2 to specify that the queue should reject new messages when it is full.

For instance:

admin.createLocalQueue({
name: "TEST_REJECT",
overflow_policy: 2
});

Is an example of how you would create a new local queue with a default persistence of "persistent." The REST equivalent would be to POST the following JSON to /ems/queues:

{
"name": "TEST_REJECT",
"overflow_policy": 2
}

So it is required that you understand AttrDefs.

AttrDefs.ems.xml

AttrDefs.ems.xml is an XML file located in the etc folder in the install directory that contains a schema for all possible properties for any type of object within TIBCO EMS.
Object types are specified in a "Type" element with the "name" attribute, e.g. here is the Type element for "Queue":

<Type name="QUEUE">
... Queue properties go here ...
</Type>

Properties of TIBCO EMS objects are specified in "Attribute" elements. The following example shows the Attribute element for "overflow policy":

<Attributename="overflow_policy"
display="Overflow Policy"
category="General"
required="false"
indexed="true"
writable="true">
... properties of the attribute go here
</Attribute>

CM Ledger Subject Operations

Get CM Ledger Subjects

REST

GET /ems/connections/[conn]/ledgersubjects?type=list

JavaScript

getCMLedgers()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all CM ledgers on the TIBCO EMS server connection

Get CM Ledger Subjects Properties

REST

GET /ems/connections/[conn]/ledgersubjects/

JavaScript

getCMLedgersAttrs()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the properties for all CM ledger subjects on the TIBCO EMS server connection

Get CM Ledger Subject Properties

REST

GET /ems/connections/[conn]/ledgersubjects/[transport]/subjects/[subject]

JavaScript

getCMLedgerAttrs()

Parameters

conn – An argument specifying the connection name (REST only)
transport – A string representing the transport
subject – A string representing the subject

Returns

A JavaScript object containing the properties for the specified CM ledger subject on the TIBCO EMS server connection

Get CM Ledger Subjects Statistics

REST

GET /ems/connections/[conn]/ledgersubjects?type=status

JavaScript

getCMLedgersStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all CM ledger subjects on the TIBCO EMS server connection

CM Listener Operations

Get CM Listeners

REST

GET /ems/connections/[conn]/cmlisteners?type=list

JavaScript

getCMListeners()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all CM listeners on the TIBCO EMS server connection

Get CM Listeners Properties

REST

GET /ems/connections/[conn]/cmlisteners/

JavaScript

getCMListenersAttrs()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the properties for all CM listeners on the TIBCO EMS server connection

Get CM Listener Properties

REST

GET /ems/connections/[conn]/cmlisteners/[name]/subjects/[subject]/transports/[transport]

JavaScript

getCMListenerAttrs(name, subject, transport)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the CM listener
subject – A string representing the subject
transport – A string representing the transport

Returns

A JavaScript object containing the properties for the specified CM listener on the TIBCO EMS server

Create CM Listener

REST

POST o to /ems/connections/[conn]/cmlisteners/

JavaScript

createCMListener(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the CM listener

Returns

None

Delete CM Listener

REST

DELETE /ems/connections/[conn]/cmlisteners/[name]/subjects/[subject]/transports/[transport]

JavaScript

deleteCMListener(name, subject, transport)

Parameters

Returns

None

Get CM Listeners Statistics

REST

GET /ems/connections/[conn]/cmlisteners?type=status

JavaScript

getCMListenersStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all CM listeners on the TIBCO EMS server connection

Channel Operations

Get Channels

REST

GET /ems/connections/[conn]/channels?type=list

JavaScript

getChannels()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all channels on the TIBCO EMS server connection

Get Channels Properties

REST

GET /ems/connections/[conn]/channels/

JavaScript

getChannelsAttrs()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the properties for all channels on the TIBCO EMS server connection

Get Channel Properties

REST

GET /ems/connections/[conn]/channels/[name]

JavaScript

getChannelAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the channel

Returns

A JavaScript object containing the properties for the specified channel on the TIBCO EMS server

Get Channels Statistics

REST

GET /ems/connections/[conn]/channels?type=status

JavaScript

getChannelsStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all channels on the TIBCO EMS server connection

Client Connection Operations

Get Client Connections

REST

GET /ems/connections/[conn]/clientconnections?type=list

JavaScript

getClientConnections()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all client connections on the TIBCO EMS server connection

Get Client Connections Properties

REST

GET /ems/connections/[conn]/clientconnections/[?summarize=true&filter=[expr]]

JavaScript

getClientConnectionsAttrs({
summarize:true,
filter:[expr]
})

Parameters

conn – An argument specifying the connection name (REST only)
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument

Returns

A JavaScript array containing the properties for all client connections on the TIBCO EMS server connection

Get Client Connection Properties

REST

GET /ems/connections/[conn]/clientconnections/[name]

JavaScript

getClientConnectionAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the client connection

Returns

A JavaScript object containing the properties for the specified client connection on the TIBCO EMS server

Get Client Connections Statistics

REST

GET /ems/connections/[conn]/clientconnections?type=status

JavaScript

getClientConnectionsStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all client connections on the TIBCO EMS server connection

Delete Client Connection

REST

DELETE /ems/connections/[conn]/clientconnection/[name]

JavaScript

deleteClientConnection(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the client connection

Returns

None

Connection Factory Operations

Get Connection Factories

REST

GET /ems/connections/[conn]/connectionfactories?type=list

JavaScript

getConnectionFactories()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all connection factories on the TIBCO EMS server connection

Get Connection Factories Properties

REST

GET /ems/connections/[conn]/connectionfactories/[?summarize=true&filter=[expr]]

JavaScript

getConnectionFactoriesAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all connection factories on the TIBCO EMS server connection

Get Connection Factory Properties

REST

GET /ems/connections/[conn]/connectionfactories/[name]

JavaScript

getConnectionFactoryAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the connection factory

Returns

A JavaScript object containing the properties for the specified connection factory on the TIBCO EMS server

Get Connection Factories Statistics

REST

GET /ems/connections/[conn]/connectionfactories?type=status

JavaScript

getConnectionFactoriesStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all connection factories on the TIBCO EMS server connection

Create Connection Factory

REST

POST o to /ems/connections/[conn]/connectionfactories/

JavaScript

createConnectionFactory(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the connection factory

Returns

None

Modify Connection Factory

REST

PUT o to /ems/connections/[conn]/connectionfactories/[name]

JavaScript

modifyConnectionFactory(o, name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the connection factory
name – A string representing the name of the connection factory

Returns

None

Delete Connection Factory

REST

DELETE /ems/connections/[conn]/connectionfactories/[name]

JavaScript

deleteConnectionFactory(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the connection factory

Returns

None

Consumer Operations

Get Consumers

REST

GET /ems/connections/[conn]/consumers?type=list

JavaScript

getConsumers()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all consumers on the TIBCO EMS server connection

Get Consumers Properties

REST

GET /ems/connections/[conn]/consumers/[?summarize=true&filter=[expr]]

JavaScript

getConsumersAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all consumers on the TIBCO EMS server connection

Get Consumer Properties

REST

GET /ems/connections/[conn]/consumers/[id]

JavaScript

getConsumerAttrs(id)

Parameters

conn – An argument specifying the connection name (REST only)
id – A string representing the identifier of the consumer

Returns

A JavaScript object containing the properties for the specified consumer on the TIBCO EMS server

Get Consumers Statistics

REST

GET /ems/connections/[conn]/consumers?type=status

JavaScript

getConsumersStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all consumers on the TIBCO EMS server connection

Database Store Operations

Get Database Stores

REST

GET /ems/connections/[conn]/databasestores?type=list

JavaScript

getDbStores()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all database stores on the TIBCO EMS server connection

Get Database Stores Properties

REST

GET /ems/connections/[conn]/databasestores/[?summarize=true&filter=[expr]]

JavaScript

getDbStoresAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all database stores on the TIBCO EMS server connection

Get Database Store Properties

REST

GET /ems/connections/[conn]/databasestores/[name]

JavaScript

getDbStoreAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the database store

Returns

A JavaScript object containing the properties for the specified database store on the TIBCO EMS server

Get Database Stores Statistics

REST

GET /ems/connections/[conn]/databasestores?type=status

JavaScript

getDbStoresStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all database stores on the TIBCO EMS server connection

Compact Database Store

REST

PUT o to /ems/connections/[conn]/databasestores/[name]?type=status

JavaScript

compactDbStore(name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JSON object with the contents {"status":"compact"} (REST only)
name – A string representing the name of the database store

Returns

None

Destination Bridge Operations

Get Destination Bridges

REST

GET /ems/connections/[conn]/bridges?type=list

JavaScript

getDestinationBridges()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all destination bridges on the TIBCO EMS server connection

Get Destination Bridges Properties

REST

GET /ems/connections/[conn]/bridges/[?summarize=true&filter=[expr]]

JavaScript

getDestinationBridgesAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all destination bridges on the TIBCO EMS server connection

Get Destination Bridge Properties

REST

GET /ems/connections/[conn]/bridges/[source]/targets/[target]

JavaScript

getDestinationBridgeAttrs(source, target)

Parameters

conn – An argument specifying the connection name (REST only)
source – A string representing the source of the destination bridges
target – A string representing the target of the destination bridges

Returns

A JavaScript object containing the properties for the specified destination bridge on the TIBCO EMS server

Get Destination Bridges Statistics

REST

GET /ems/connections/[conn]/bridges?type=status

JavaScript

getDestinationBridgesStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all destination bridges on the TIBCO EMS server connection

Create Destination Bridge

REST

POST o to /ems/connections/[conn]/bridges/

JavaScript

createDestinationBridge(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the destination bridge

Returns

None

Delete Destination Bridge

REST

DELETE /ems/connections/[conn]/bridges/[source]/target/[target]

JavaScript

deleteDestinationBridge(source, target)

Parameters

Returns

None

Durable Operations

Get Durables

REST

GET /ems/connections/[conn]/durables?type=list

JavaScript

getDurables()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all durables on the TIBCO EMS server connection

Get Durables Properties

REST

GET /ems/connections/[conn]/durables/[?summarize=true&filter=[expr]]

JavaScript

getDurablesAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all durables on the TIBCO EMS server connection

Get Durable Properties

REST

GET /ems/connections/[conn]/durables/[name]

JavaScript

getDurableAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the durable

Returns

A JavaScript object containing the properties for the specified durable on the TIBCO EMS server

Create Durable

REST

POST o to /ems/connections/[conn]/durables/

JavaScript

createDurable(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the durable

Returns

None

Modify Durable

REST

PUT o to /ems/connections/[conn]/durables/[name]

JavaScript

modifyDurable(o, name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the durable
name – A string representing the name of the durable

Returns

None

Delete Durable

REST

DELETE /ems/connections/[conn]/durables/[name]

JavaScript

deleteDurable(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the durable

Returns

None

Purge Durable

REST

PUT o to /ems/connections/[conn]/durables/[name]?type=status

JavaScript

purgeDurable(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the durable
o – A JSON object with the contents {"status":"purge"} (REST only)

Returns

None

Get Durables Statistics

REST

GET /ems/connections/[conn]/durables?type=status

JavaScript

getDurablesStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all durables on the TIBCO EMS server connection

File Store Operations

Get File Stores

REST

GET /ems/connections/[conn]/filestores?type=list

JavaScript

getFileStores()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all file stores on the TIBCO EMS server connection

Get File Stores Properties

REST

GET /ems/connections/[conn]/filestores/[?summarize=true&filter=[expr]]

JavaScript

getFileStoresAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all file stores on the TIBCO EMS server connection

Get File Store Properties

REST

GET /ems/connections/[conn]/filestores/[name]

JavaScript

getFileStoreAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the file store

Returns

A JavaScript object containing the properties for the specified file store on the TIBCO EMS server

Get File Stores Statistics

REST

GET /ems/connections/[conn]/filestores?type=status

JavaScript

getFileStoresStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all file stores on the TIBCO EMS server connection

Compact File Store

REST

PUT o to /ems/connections/[conn]/filestores/[name]?type=status

JavaScript

compactFileStore(name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JSON object with the contents {"status":"compact"} (REST only)
name – A string representing the name of the file store

Returns

None

Group Operations

Get Groups

REST

GET /ems/connections/[conn]/groups?type=list

JavaScript

getGroups()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all groups on the TIBCO EMS server connection

Get Groups Properties

REST

GET /ems/connections/[conn]/groups/[?summarize=true&filter=[expr]]

JavaScript

getGroupsAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all groups on the TIBCO EMS server connection

Get Group Properties

REST

GET /ems/connections/[conn]/groups/[name]

JavaScript

getGroupAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the group

Returns

A JavaScript object containing the properties for the specified group on the TIBCO EMS server

Create Group

REST

POST o to /ems/connections/[conn]/groups/

JavaScript

createGroup(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the group

Returns

None

Modify Group

REST

PUT o to /ems/connections/[conn]/groups/[name]

JavaScript

modifyGroup(o, name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the group
name – A string representing the name of the group

Returns

None

Delete Group

REST

DELETE /ems/connections/[conn]/groups/[name]

JavaScript

deleteGroup(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the group

Returns

None

Incoming Route Selector Operations

Get Incoming Route Selectors

REST

GET /ems/connections/[conn]/routes/[route]/incomingselectors?type=list

JavaScript

getIncomingRouteSelectors(route)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing the name of a route

Returns

A JavaScript array containing strings with the topic name of all incoming route selectors for the specified route on the TIBCO EMS server connection

Get Incoming Route Selectors Properties

REST

GET /ems/connections/[conn]/routes/[route]/incomingselectors/[?summarize=true&filter=[expr]]

JavaScript

getIncomingRouteSelectorsAttrs(route, {
summarize:true,
filter:[expr]
})

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name
summarize:true – An optional argument specifying that a summarized list of properties should be returned.
filter:[expr] – An optional filter argument

Returns

A JavaScript array containing the properties for all incoming route selectors for the specified route on the TIBCO EMS server connection

Get Incoming Route Selector Properties

REST

GET /ems/connections/[conn]/routes/[route]/incomingselectors/[topic]

JavaScript

getIncomingRouteSelectorAttrs(route, topic)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name
topic – A string representing the name of the topic

Returns

A JavaScript object containing the properties for the specified incoming route selector for the specified route on the TIBCO EMS server

Get Incoming Route Selectors Statistics

REST

GET /ems/connections/[conn]/routes/[route]/incomingselectors?type=status

JavaScript

getIncomingRouteSelectorsStatistics(route)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name

Returns

A JavaScript array containing the statistics for all incoming route selectors for the specified route on the TIBCO EMS server connection

Create Incoming Route Selector

REST

POST o to /ems/connections/[conn]/routes/[route]/incomingselectors/

JavaScript

createIncomingRouteSelector(route, o)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name
o – A JavaScript object representing the selector

Returns

None

Modify Incoming Route Selector

REST

PUT o to /ems/connections/[conn]/routes/[route]/incomingselectors/[topic]

JavaScript

modifyIncomingRouteSelector(route, o, topic)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name
o – A JavaScript object representing the selector
topic – A string representing the name of the topic

Returns

None

Delete Incoming Route Selector

REST

DELETE /ems/connections/[conn]/routes/[route]/incomingselectors/[topic]

JavaScript

deleteIncomingRouteSelector(route, topic)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name
topic – A string representing the name of the topic

Returns

None

JACI Cache Operations

Get JACI Cache Statistics

REST

GET /ems/connections/[conn]/jacicache?type=status

JavaScript

getJACICacheStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the JACI cache statistics on the TIBCO EMS server connection

Reset JACI Cache Statistics

REST

PUT o to /ems/connections/[conn]/jacicache?type=status

JavaScript

resetJACICacheStatistics()

Parameters

conn – An argument specifying the connection name (REST only)
o – A JSON object with the contents {"status":"reset"} (REST only)

Returns

None

Clear JACI Cache

REST

DELETE /ems/connections/[conn]/jacicache/

JavaScript

clearJACICache()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

None

Outgoing Route Selector Operations

Get Outgoing Route Selectors

REST

GET /ems/connections/[conn]/routes/[route]/outgoingselectors?type=list

JavaScript

getOutgoingRouteSelectors(route)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing the name of a route

Returns

A JavaScript array containing strings with the topic name of all outgoing route selectors for the specified route on the TIBCO EMS server connection

Get Outgoing Route Selectors Properties

REST

GET /ems/connections/[conn]/routes/[route]/outgoingselectors/[?summarize=true&filter=[expr]]

JavaScript

getOutgoingRouteSelectorsAttrs(route, {
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all outgoing route selectors for the specified route on the TIBCO EMS server connection

Get Outgoing Route Selector Properties

REST

GET /ems/connections/[conn]/routes/[route]/outgoingselectors/[topic]

JavaScript

getOutgoingRouteSelectorAttrs(route, topic)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name
topic – A string representing the name of the topic

Returns

A JavaScript object containing the properties for the specified outgoing route selector for the specified route on the TIBCO EMS server

Get Outgoing Route Selectors Statistics

REST

GET /ems/connections/[conn]/routes/[route]/outgoingselectors?type=status

JavaScript

getOutgoingRouteSelectorsStatistics(route)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name

Returns

A JavaScript array containing the statistics for all outgoing route selectors for the specified route on the TIBCO EMS server connection

Create Outgoing Route Selector

REST

POST o to /ems/connections/[conn]/routes/[route]/outgoingselectors/

JavaScript

createOutgoingRouteSelector(route, o)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name
o – A JavaScript object representing the selector

Returns

None

Modify Outgoing Route Selector

REST

PUT o to /ems/connections/[conn]/routes/[route]/outgoingselectors/[topic]

JavaScript

modifyOutgoingRouteSelector(route, o, topic)

Parameters

Returns

None

Delete Outgoing Route Selector

REST

DELETE /ems/connections/[conn]/routes/[route]/outgoingselectors/[topic]

JavaScript

deleteOutgoingRouteSelector(route, topic)

Parameters

conn – An argument specifying the connection name (REST only)
route – A string representing a route name
topic – A string representing the name of the topic

Returns

None

Producer Operations

Get Producers

REST

GET /ems/connections/[conn]/producers?type=list

JavaScript

getProducers()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all producers on the TIBCO EMS server connection

Get Producers Properties

REST

GET /ems/connections/[conn]/producers/[?summarize=true&filter=[expr]]

JavaScript

getProducersAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all producers on the TIBCO EMS server connection

Get Producer Properties

REST

GET /ems/connections/[conn]/producers/[id]

JavaScript

getProducerAttrs(id)

Parameters

conn – An argument specifying the connection name (REST only)
id – A string representing the identifier of the producer

Returns

A JavaScript object containing the properties for the specified producer on the TIBCO EMS server

Get Producers Statistics

REST

GET /ems/connections/[conn]/producers?type=status

JavaScript

getProducersStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all producers on the TIBCO EMS server connection

Queue Operations

Get Queues

REST

GET /ems/connections/[conn]/queues?type=list

JavaScript

getQueues()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all queues on the TIBCO EMS server connection

Get Queues Properties

REST

GET /ems/connections/[conn]/queues/[?summarize=true&filter=[expr]]

JavaScript

getQueuesAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all queues on the TIBCO EMS server connection

Get Queue Properties

REST

GET /ems/connections/[conn]/queues/[name]

JavaScript

getQueueAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the queue

Returns

A JavaScript object containing the properties for the specified queue on the TIBCO EMS server

Get Queues Statistics

REST

GET /ems/connections/[conn]/queues?type=status

JavaScript

getQueuesStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all queues on the TIBCO EMS server connection

Create Queue

REST

POST o to /ems/connections/[conn]/queues/

JavaScript

createQueue(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the queue

Returns

None

Modify Queue

REST

PUT o to /ems/connections/[conn]/queues/[name]

JavaScript

modifyQueue(o, name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the queue
name – A string representing the name of the queue

Returns

None

Delete Queue

REST

DELETE /ems/connections/[conn]/queues/[name]

JavaScript

deleteQueue(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the queue

Returns

None

Purge Queue

REST

PUT o to /ems/connections/[conn]/queues/[name]?type=status

JavaScript

purgeQueue(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the queue
o – A JSON object with the contents {"status":"purge"} (REST only)

Returns

None

RVCM Transport Operations

Get RVCM Transports

REST

GET /ems/connections/[conn]/rvcmtransports?type=list

JavaScript

getRVCMTransports()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all RVCM transports on the TIBCO EMS server connection

Get RVCM Transports Properties

REST

GET /ems/connections/[conn]/rvcmtransports/

JavaScript

getRVCMTransportsAttrs()

Parameters

Returns

A JavaScript array containing the properties for all RVCM transports on the TIBCO EMS server connection

Get RVCM Transports Statistics

REST

GET /ems/connections/[conn]/rvcmtransports?type=status

JavaScript

getRVCMTransportsStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all RVCM transports on the TIBCO EMS server connection

RV Transport Operations

Get RV Transports

REST

GET /ems/connections/[conn]/rvtransports?type=list

JavaScript

getRVTransports()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all RV transports on the TIBCO EMS server connection

Get RV Transports Properties

REST

GET /ems/connections/[conn]/rvtransports/

JavaScript

getRVTransportsAttrs()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the properties for all RV transports on the TIBCO EMS server connection

Get RV Transports Statistics

REST

GET /ems/connections/[conn]/rvtransports?type=status

JavaScript

getRVTransportsStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all RV transports on the TIBCO EMS server connection

Route Operations

Get Routes

REST

GET /ems/connections/[conn]/routes?type=list

JavaScript

getRoutes()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all routes on the TIBCO EMS server connection

Get Routes Properties

REST

GET /ems/connections/[conn]/routes/[?summarize=true&filter=[expr]]

JavaScript

getRoutesAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all routes on the TIBCO EMS server connection

Get Route Properties

REST

GET /ems/connections/[conn]/routes/[name]

JavaScript

getRouteAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the route

Returns

A JavaScript object containing the properties for the specified route on the TIBCO EMS server

Get Routes Statistics

REST

GET /ems/connections/[conn]/routes?type=status

JavaScript

getRoutesStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all routes on the TIBCO EMS server connection

Create Route

REST

POST o to /ems/connections/[conn]/routes/

JavaScript

createRoute(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the route

Returns

None

Modify Route

REST

PUT o to /ems/connections/[conn]/routes/[name]

JavaScript

modifyRoute(o, name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the route
name – A string representing the name of the route

Returns

None

Delete Route

REST

DELETE /ems/connections/[conn]/routes/[name]

JavaScript

deleteRoute(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the route

Returns

None

SS Transport Operations

Get SS Transports

REST

GET /ems/connections/[conn]/sstransports?type=list

JavaScript

getSSTransports()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all SS transports on the TIBCO EMS server connection

Get SS Transports Properties

REST

GET /ems/connections/[conn]/sstransports/

JavaScript

getSSTransportsAttrs()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the properties for all SS transports on the TIBCO EMS server connection

Get SS Transports Statistics

REST

GET /ems/connections/[conn]/sstransports?type=status

JavaScript

getSSTransportsStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all SS transports on the TIBCO EMS server connection

Server Operations

Get Server Properties

REST

GET /ems/connections/[conn]/server/

JavaScript

getServerAttrs()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript object containing the properties for the specified TIBCO EMS server

Get Server Statistics

REST

GET /ems/connections/[conn]/server?type=status

JavaScript

getServerStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript object containing the statistics for the TIBCO EMS server connection

Modify Server

REST

PUT o to /ems/connections/[conn]/server/

JavaScript

modifyServer(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the server

Returns

None

Shutdown Server

REST

PUT o to /ems/connections/[conn]/server?type=status

JavaScript

shutdownServer()

Parameters

conn – An argument specifying the connection name (REST only)
o – A JSON object with the contents {"status":"shutdown"} (REST only)

Returns

None

Rotate Server Log

REST

PUT o to /ems/connections/[conn]/server?type=status

JavaScript

rotateServerLog()

Parameters

conn – An argument specifying the connection name (REST only)
o – A JSON object with the contents {"status":"rotatelog"} (REST only)

Returns

None

Store Operations

Get Stores

REST

GET /ems/connections/[conn]/stores?type=list

JavaScript

getStores()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all stores on the TIBCO EMS server connection

Get Stores Properties

REST

GET /ems/connections/[conn]/stores/[?summarize=true&filter=[expr]]

JavaScript

getStoresAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all stores on the TIBCO EMS server connection

Get Store Properties

REST

GET /ems/connections/[conn]/stores/[name]

JavaScript

getStoreAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the file store

Returns

A JavaScript object containing the properties for the specified store on the TIBCO EMS server

Get Stores Statistics

REST

GET /ems/connections/[conn]/stores?type=status

JavaScript

getStoresStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all stores on the TIBCO EMS server connection

Compact Store

REST

PUT o to /ems/connections/[conn]/stores/[name]?type=status

JavaScript

compactStore(name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JSON object with the contents {"status":"compact"} (REST only)
name – A string representing the name of the store

Returns

None

Topic Operations

Get Topics

REST

GET /ems/connections/[conn]/topics?type=list

JavaScript

getTopics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all topics on the TIBCO EMS server connection

Get Topics Properties

REST

GET /ems/connections/[conn]/topics/[?summarize=true&filter=[expr]]

JavaScript

getTopicsAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all topics on the TIBCO EMS server connection

Get Topic Properties

REST

GET /ems/connections/[conn]/topics/[name]

JavaScript

getTopicAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the topic

Returns

A JavaScript object containing the properties for the specified topic on the TIBCO EMS server

Get Topics Statistics

REST

GET /ems/connections/[conn]/topics?type=status

JavaScript

getTopicsStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all topics on the TIBCO EMS server connection

Create Topic

REST

POST o to /ems/connections/[conn]/topics/

JavaScript

createTopic(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the topic

Returns

None

Modify Topic

REST

PUT o to /ems/connections/[conn]/topics/[name]

JavaScript

modifyTopic(o, name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the topic
name – A string representing the name of the topic

Returns

None

Delete Topic

REST

DELETE /ems/connections/[conn]/topics/[name]

JavaScript

deleteTopic(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the topic

Returns

None

Purge Topic

REST

PUT o to /ems/connections/[conn]/topics/[name]?type=status

JavaScript

purgeTopic(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the topic
o – A JSON object with the contents {"status":"purge"} (REST only)

Returns

None

Transport Operations

Get Transports

REST

GET /ems/connections/[conn]/transports?type=list

JavaScript

getTransports()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all transports on the TIBCO EMS server connection

Get Transports Properties

REST

GET /ems/connections/[conn]/transports/

JavaScript

getTransportsAttrs()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the properties for all transports on the TIBCO EMS server connection

Get Transports Statistics

REST

GET /ems/connections/[conn]/transports?type=status

JavaScript

getTransportsStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all transports on the TIBCO EMS server connection

User Operations

Get Users

REST

GET /ems/connections/[conn]/users?type=list

JavaScript

getUsers()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing strings with the name of all users on the TIBCO EMS server connection

Get Users Properties

REST

GET /ems/connections/[conn]/users/[?summarize=true&filter=[expr]]

JavaScript

getUsersAttrs({
summarize:true,
filter:[expr]
})

Parameters

Returns

A JavaScript array containing the properties for all users on the TIBCO EMS server connection

Get User Properties

REST

GET /ems/connections/[conn]/users/[name]

JavaScript

getUserAttrs(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the user

Returns

A JavaScript object containing the properties for the specified user on the TIBCO EMS server

Get Users Statistics

REST

GET /ems/connections/[conn]/users?type=status

JavaScript

getUsersStatistics()

Parameters

conn – An argument specifying the connection name (REST only)

Returns

A JavaScript array containing the statistics for all users on the TIBCO EMS server connection

Create User

REST

POST o to /ems/connections/[conn]/users/

JavaScript

createUser(o)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the user

Returns

None

Modify User

REST

PUT o to /ems/connections/[conn]/users/[name]

JavaScript

modifyUser(o, name)

Parameters

conn – An argument specifying the connection name (REST only)
o – A JavaScript object representing the user
name – A string representing the name of the user

Returns

None

Delete User

REST

DELETE /ems/connections/[conn]/users/[name]

JavaScript

deleteUser(name)

Parameters

conn – An argument specifying the connection name (REST only)
name – A string representing the name of the user

Returns

None

Messaging Operations

Browse Messages

REST

GET /ems/connections/[conn]/queues/[queue]/messages/?fromIndex=[idx]&toIndex=[idx][ &maxdata=[bytes]]

JavaScript

getQueueMessages(queue, fromIndex, toIndex)

Parameters

conn – An argument specifying the connection name (REST only)

queue – A string representing the name of the queue

fromIndex - The index of the message to start browsing from

toIndex - The index of last message to include in browse results

idx – a numeric message index (starting from 0)

maxdata - the amount of message data to return with browse results (in bytes) (REST only)

Returns

A JavaScript array containing the properties for all messages browsed from the queue

Browse Message

REST

GET /ems/connections/[conn]/queues/[queue]/messages/[msgid] =[true|false]

JavaScript

getQueueMessageAttrs(queue, msgId)

Parameters

conn – An argument specifying the connection name (REST only)

queue – A string representing the name of the queue

msgid – A string representing the message id

Returns

A JavaScript object with the message properties

Put Message

REST

POST o to /ems/connections/[conn]/queues/[queue]/messages/

JavaScript

createQueueMessage(queue, o)

Parameters

conn – An argument specifying the connection name (REST only)

queue - A string representing the name of the queue

o – A JavaScript object with the message properties for the message to be created

Returns

None

Modify Message

REST

PUT o to /ems/connections/[conn]/queues/[queue]/messages/[msgid]

JavaScript

modifyQueueMessage (queue, msgid, o)

Parameters

conn – An argument specifying the connection name (REST only)

queue - A string representing the name of the queue

msgid – A string representing the message id

o – A JavaScript object with the message properties for the message to be modified

Returns

None

Delete Message

REST

DELETE /ems/connections/[conn]/queues/[queue]/messages/[msgid]

JavaScript

deleteQueueMessage(queue, msgid)

Parameters

conn – An argument specifying the connection name (REST only)

queue - A string representing the name of the queue

msgid – A string representing the message id

Returns

None

Delete Messages (by Index)

REST

DELETE /ems/connections/[conn]/queues/[queue]/msgsets/[list]

JavaScript

deleteQueueMessageSet(queue, list)

Parameters

conn – An argument specifying the connection name (REST only)

queue - A string representing the name of the queue

list – A comma-separated list of indices addressing the messages to be removed (starting with 0 for the first message)

Returns

None

Delete Messages (by Range)

REST

DELETE /ems/connections/[conn]/queues/[queue]/msgsets/[range]

JavaScript

deleteQueueMessageSet(queue, range)

Parameters

conn – An argument specifying the connection name (REST only)

queue - A string representing the name of the queue

range – A range of messages to be deleted consisting of the lowest index to consider (starting by 0) and the highest index separated by ‘-‘. For example, a range of ‘0-9’ would delete the first ten messages on the queue.

Returns

None

Copy Messages (by Index)

REST

POST o to /ems/connections/[conn]/queues/[queue]/msgsets/[list]

JavaScript

copyQueueMessageSet(queue, list, o)

Parameters

conn – An argument specifying the connection name (REST only)

queue - A string representing the name of the queue

list – A comma-separated list of indices addressing the messages to be copied where an index of ‘0’ is relating to the first message on the queue. For example, a list of ‘0,2,4’ would copy messages 1, 3 and 5.

o – A JavaScript object with the following keys representing the options for this operation:

dest_conn – A string representing the name of the destination connection to copy the messages to

dest_name – A string representing the name of the destination object (queue or topic) on the destination connection to copy the messages to

dest_type – A string representing the destination type (‘Q’ for queue or ‘T’ for topic) of this operation

keep_corrid – A Boolean (true or false) indicating whether to preserve the origin’s message correlation in the message copy

keep_grouping – A Boolean (true or false) indicating whether to preserve the origin’s message id in the message copy

keep_emsprops – A Boolean (true or false) indicating whether to preserve the origin’s message EMS properties in the message copy

keep_jmsprops – A Boolean (true or false) indicating whether to preserve the origin’s message JMS properties in the message copy

keep_userprops – A Boolean (true or false) indicating whether to preserve the origin’s message user properties in the message copy

Returns

None

Copy Messages (by Range)

REST

POST o to /ems/connections/[conn]/queues/[queue]/msgsets/[range]

JavaScript

copyQueueMessageSet(queue, range, o)

Parameters

conn – An argument specifying the source connection name (REST only)

queue – A string representing the name of the source queue

range – A range of messages to be copied consisting of the lowest index to consider (starting by 0) and the highest index separated by ‘-‘. For example, a range of ‘0-9’ would copy the first ten messages on the queue.