|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.mirth.connect.server.userutil.ChannelUtil
public class ChannelUtil
This utility class allows the user to query information from channels or to perform actions on channels.
Method Summary | |
---|---|
static void |
deployChannel(java.lang.String channelIdOrName)
Deploy a channel. |
static DeployedState |
getChannelState(java.lang.String channelIdOrName)
Get the current state of a deployed channel. |
static DeployedState |
getConnectorState(java.lang.String channelIdOrName,
java.lang.Number metaDataId)
Get the current state of a deployed connector. |
static java.lang.String |
getDeployedChannelName(java.lang.String channelId)
Get the name for a specified channel. |
static java.lang.Long |
getErrorCount(java.lang.String channelIdOrName)
Get the error count statistic for a specific channel. |
static java.lang.Long |
getErrorCount(java.lang.String channelIdOrName,
java.lang.Number metaDataId)
Get the error count statistic for a specific connector. |
static java.lang.Long |
getFilteredCount(java.lang.String channelIdOrName)
Get the filtered count statistic for a specific channel. |
static java.lang.Long |
getFilteredCount(java.lang.String channelIdOrName,
java.lang.Number metaDataId)
Get the filtered count statistic for a specific connector. |
static java.lang.Long |
getQueuedCount(java.lang.String channelIdOrName)
Get the queued count statistic for a specific channel. |
static java.lang.Long |
getQueuedCount(java.lang.String channelIdOrName,
java.lang.Number metaDataId)
Get the queued count statistic for a specific connector. |
static java.lang.Long |
getReceivedCount(java.lang.String channelIdOrName)
Get the received count statistic for a specific channel. |
static java.lang.Long |
getReceivedCount(java.lang.String channelIdOrName,
java.lang.Number metaDataId)
Get the received count statistic for a specific connector. |
static java.lang.Long |
getSentCount(java.lang.String channelIdOrName)
Get the sent count statistic for a specific channel. |
static java.lang.Long |
getSentCount(java.lang.String channelIdOrName,
java.lang.Number metaDataId)
Get the sent count statistic for a specific connector. |
static void |
haltChannel(java.lang.String channelIdOrName)
Halt a deployed channel. |
static boolean |
isChannelDeployed(java.lang.String channelIdOrName)
Check if a channel is currently deployed. |
static void |
pauseChannel(java.lang.String channelIdOrName)
Pause a deployed channel. |
static void |
resumeChannel(java.lang.String channelIdOrName)
Resume a deployed channel. |
static void |
startChannel(java.lang.String channelIdOrName)
Start a deployed channel. |
static void |
startConnector(java.lang.String channelIdOrName,
java.lang.Integer metaDataId)
Start a connector on a given channel. |
static void |
stopChannel(java.lang.String channelIdOrName)
Stop a deployed channel. |
static void |
stopConnector(java.lang.String channelIdOrName,
java.lang.Integer metaDataId)
Stop a connector on a given channel. |
static void |
undeployChannel(java.lang.String channelIdOrName)
Undeploy a channel. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static java.lang.String getDeployedChannelName(java.lang.String channelId)
channelId
- The channel id of the deployed channel.
public static void startChannel(java.lang.String channelIdOrName) throws java.lang.Exception
channelIdOrName
- The channel id or current name of the deployed channel.
java.lang.Exception
public static void stopChannel(java.lang.String channelIdOrName) throws java.lang.Exception
channelIdOrName
- The channel id or current name of the deployed channel.
java.lang.Exception
public static void pauseChannel(java.lang.String channelIdOrName) throws java.lang.Exception
channelIdOrName
- The channel id or current name of the deployed channel.
java.lang.Exception
public static void resumeChannel(java.lang.String channelIdOrName) throws java.lang.Exception
channelIdOrName
- The channel id or current name of the deployed channel.
java.lang.Exception
public static void haltChannel(java.lang.String channelIdOrName) throws java.lang.Exception
channelIdOrName
- The channel id or current name of the deployed channel.
java.lang.Exception
public static DeployedState getChannelState(java.lang.String channelIdOrName)
channelIdOrName
- The channel id or current name of the deployed channel.
public static void deployChannel(java.lang.String channelIdOrName)
channelIdOrName
- The channel id or current name of the channel.public static void undeployChannel(java.lang.String channelIdOrName)
channelIdOrName
- The channel id or current name of the deployed channel.public static boolean isChannelDeployed(java.lang.String channelIdOrName)
channelIdOrName
- The channel id or current name of the channel.
public static void startConnector(java.lang.String channelIdOrName, java.lang.Integer metaDataId) throws java.lang.Exception
channelIdOrName
- The channel id or current name of the channel.metaDataId
- The metadata id of the connector. Note that the source connector has a metadata id
of 0.
java.lang.Exception
public static void stopConnector(java.lang.String channelIdOrName, java.lang.Integer metaDataId) throws java.lang.Exception
channelIdOrName
- The channel id or current name of the channel.metaDataId
- The metadata id of the connector. Note that the source connector has a metadata id
of 0.
java.lang.Exception
public static DeployedState getConnectorState(java.lang.String channelIdOrName, java.lang.Number metaDataId)
channelIdOrName
- The channel id or current name of the deployed channel.metaDataId
- The metadata id of the connector. Note that the source connector has a metadata id
of 0.
public static java.lang.Long getReceivedCount(java.lang.String channelIdOrName)
channelIdOrName
- The channel id or current name of the deployed channel.
public static java.lang.Long getReceivedCount(java.lang.String channelIdOrName, java.lang.Number metaDataId)
channelIdOrName
- The channel id or current name of the deployed channel.metaDataId
- The metadata id of the connector. Note that the source connector has a metadata id
of 0.
public static java.lang.Long getFilteredCount(java.lang.String channelIdOrName)
channelIdOrName
- The channel id or current name of the deployed channel.
public static java.lang.Long getFilteredCount(java.lang.String channelIdOrName, java.lang.Number metaDataId)
channelIdOrName
- The channel id or current name of the deployed channel.metaDataId
- The metadata id of the connector. Note that the source connector has a metadata id
of 0.
public static java.lang.Long getQueuedCount(java.lang.String channelIdOrName)
channelIdOrName
- The channel id or current name of the deployed channel.
public static java.lang.Long getQueuedCount(java.lang.String channelIdOrName, java.lang.Number metaDataId)
channelIdOrName
- The channel id or current name of the deployed channel.metaDataId
- The metadata id of the connector. Note that the source connector has a metadata id
of 0.
public static java.lang.Long getSentCount(java.lang.String channelIdOrName)
channelIdOrName
- The channel id or current name of the deployed channel.
public static java.lang.Long getSentCount(java.lang.String channelIdOrName, java.lang.Number metaDataId)
channelIdOrName
- The channel id or current name of the deployed channel.metaDataId
- The metadata id of the connector. Note that the source connector has a metadata id
of 0.
public static java.lang.Long getErrorCount(java.lang.String channelIdOrName)
channelIdOrName
- The channel id or current name of the deployed channel.
public static java.lang.Long getErrorCount(java.lang.String channelIdOrName, java.lang.Number metaDataId)
channelIdOrName
- The channel id or current name of the deployed channel.metaDataId
- The metadata id of the connector. Note that the source connector has a metadata id
of 0.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |