@Operation(desc = "Add security settings for addresses matching the addressMatch", impact = MBeanOperationInfo.ACTION) void addSecuritySettings(@Parameter(desc = "an address match", name = "addressMatch") String addressMatch, @Parameter(desc = "a comma-separated list of roles allowed to send messages", name = "send") String sendRoles, @Parameter(desc = "a comma-separated list of roles allowed to consume messages", name = "consume") String consumeRoles, @Parameter(desc = "a comma-separated list of roles allowed to create durable queues", name = "createDurableQueueRoles") String createDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to delete durable queues", name = "deleteDurableQueueRoles") String deleteDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to create non durable queues", name = "createNonDurableQueueRoles") String createNonDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to delete non durable queues", name = "deleteNonDurableQueueRoles") String deleteNonDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to send management messages messages", name = "manage") String manageRoles, @Parameter(desc = "a comma-separated list of roles allowed to browse queues", name = "browse") String browseRoles, @Parameter(desc = "a comma-separated list of roles allowed to create addresses", name = "createAddressRoles") String createAddressRoles, @Parameter(desc = "a comma-separated list of roles allowed to delete addresses", name = "deleteAddressRoles") String deleteAddressRoles) throws Exception;
@Operation(desc = "Add security settings for addresses matching the addressMatch", impact = MBeanOperationInfo.ACTION) void addSecuritySettings(@Parameter(desc = "an address match", name = "addressMatch") String addressMatch, @Parameter(desc = "a comma-separated list of roles allowed to send messages", name = "send") String sendRoles, @Parameter(desc = "a comma-separated list of roles allowed to consume messages", name = "consume") String consumeRoles, @Parameter(desc = "a comma-separated list of roles allowed to create durable queues", name = "createDurableQueueRoles") String createDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to delete durable queues", name = "deleteDurableQueueRoles") String deleteDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to create non durable queues", name = "createNonDurableQueueRoles") String createNonDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to delete non durable queues", name = "deleteNonDurableQueueRoles") String deleteNonDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to send management messages messages", name = "manage") String manageRoles, @Parameter(desc = "a comma-separated list of roles allowed to browse queues", name = "browse") String browseRoles) throws Exception;
@Operation(desc = "Create a Divert", impact = MBeanOperationInfo.ACTION) void createDivert(@Parameter(name = "name", desc = "Name of the divert") String name, @Parameter(name = "routingName", desc = "Routing name of the divert") String routingName, @Parameter(name = "address", desc = "Address to divert from") String address, @Parameter(name = "forwardingAddress", desc = "Address to divert to") String forwardingAddress, @Parameter(name = "exclusive", desc = "Is the divert exclusive?") boolean exclusive, @Parameter(name = "filterString", desc = "Filter of the divert") String filterString, @Parameter(name = "transformerClassName", desc = "Class name of the divert's transformer") String transformerClassName, @Parameter(name = "transformerProperties", desc = "Configuration properties of the divert's transformer") Map<String, String> transformerProperties, @Parameter(name = "routingType", desc = "How should the routing-type on the diverted messages be set?") String routingType) throws Exception;
@Operation(desc = "Add security settings for addresses matching the addressMatch", impact = MBeanOperationInfo.ACTION) void addSecuritySettings(@Parameter(desc = "an address match", name = "addressMatch") String addressMatch, @Parameter(desc = "a comma-separated list of roles allowed to send messages", name = "send") String sendRoles, @Parameter(desc = "a comma-separated list of roles allowed to consume messages", name = "consume") String consumeRoles, @Parameter(desc = "a comma-separated list of roles allowed to create durable queues", name = "createDurableQueueRoles") String createDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to delete durable queues", name = "deleteDurableQueueRoles") String deleteDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to create non durable queues", name = "createNonDurableQueueRoles") String createNonDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to delete non durable queues", name = "deleteNonDurableQueueRoles") String deleteNonDurableQueueRoles, @Parameter(desc = "a comma-separated list of roles allowed to send management messages messages", name = "manage") String manageRoles) throws Exception;
@Operation(desc = "Create a Divert", impact = MBeanOperationInfo.ACTION) void createDivert(@Parameter(name = "name", desc = "Name of the divert") String name, @Parameter(name = "routingName", desc = "Routing name of the divert") String routingName, @Parameter(name = "address", desc = "Address to divert from") String address, @Parameter(name = "forwardingAddress", desc = "Address to divert to") String forwardingAddress, @Parameter(name = "exclusive", desc = "Is the divert exclusive?") boolean exclusive, @Parameter(name = "filterString", desc = "Filter of the divert") String filterString, @Parameter(name = "transformerClassName", desc = "Class name of the divert's transformer") String transformerClassName, @Parameter(name = "routingType", desc = "How should the routing-type on the diverted messages be set?") String routingType) throws Exception;
@Operation(desc = "Create a Divert", impact = MBeanOperationInfo.ACTION) void createDivert(@Parameter(name = "name", desc = "Name of the divert") String name, @Parameter(name = "routingName", desc = "Routing name of the divert") String routingName, @Parameter(name = "address", desc = "Address to divert from") String address, @Parameter(name = "forwardingAddress", desc = "Address to divert to") String forwardingAddress, @Parameter(name = "exclusive", desc = "Is the divert exclusive?") boolean exclusive, @Parameter(name = "filterString", desc = "Filter of the divert") String filterString, @Parameter(name = "transformerClassName", desc = "Class name of the divert's transformer") String transformerClassName, @Parameter(name = "transformerPropertiesAsJSON", desc = "Configuration properties of the divert's transformer in JSON form") String transformerPropertiesAsJSON, @Parameter(name = "routingType", desc = "How should the routing-type on the diverted messages be set?") String routingType) throws Exception;
@Operation(desc = "Create a Divert", impact = MBeanOperationInfo.ACTION) void createDivert(@Parameter(name = "name", desc = "Name of the divert") String name, @Parameter(name = "routingName", desc = "Routing name of the divert") String routingName, @Parameter(name = "address", desc = "Address to divert from") String address, @Parameter(name = "forwardingAddress", desc = "Address to divert to") String forwardingAddress, @Parameter(name = "exclusive", desc = "Is the divert exclusive?") boolean exclusive, @Parameter(name = "filterString", desc = "Filter of the divert") String filterString, @Parameter(name = "transformerClassName", desc = "Class name of the divert's transformer") String transformerClassName) throws Exception;
@Operation(desc = "Move the messages corresponding to the given filter (and returns the number of moved messages)", impact = MBeanOperationInfo.ACTION) int moveMessages(@Parameter(name = "flushLimit", desc = "Limit to flush transactions during the operation to avoid OutOfMemory") int flushLimit, @Parameter(name = "filter", desc = "A message filter (can be empty)") String filter, @Parameter(name = "otherQueueName", desc = "The name of the queue to move the messages to") String otherQueueName, @Parameter(name = "rejectDuplicates", desc = "Reject messages identified as duplicate by the duplicate message") boolean rejectDuplicates) throws Exception;
@Operation(desc = "Create a Bridge", impact = MBeanOperationInfo.ACTION) void createBridge(@Parameter(name = "name", desc = "Name of the bridge") String name, @Parameter(name = "queueName", desc = "Name of the source queue") String queueName, @Parameter(name = "forwardingAddress", desc = "Forwarding address") String forwardingAddress, @Parameter(name = "filterString", desc = "Filter of the bridge") String filterString, @Parameter(name = "transformerClassName", desc = "Class name of the bridge transformer") String transformerClassName, @Parameter(name = "retryInterval", desc = "Connection retry interval") long retryInterval, @Parameter(name = "retryIntervalMultiplier", desc = "Connection retry interval multiplier") double retryIntervalMultiplier, @Parameter(name = "initialConnectAttempts", desc = "Number of initial connection attempts") int initialConnectAttempts, @Parameter(name = "reconnectAttempts", desc = "Number of reconnection attempts") int reconnectAttempts, @Parameter(name = "useDuplicateDetection", desc = "Use duplicate detection") boolean useDuplicateDetection, @Parameter(name = "confirmationWindowSize", desc = "Confirmation window size") int confirmationWindowSize, @Parameter(name = "clientFailureCheckPeriod", desc = "Period to check client failure") long clientFailureCheckPeriod, @Parameter(name = "staticConnectorNames", desc = "comma separated list of connector names or name of discovery group if 'useDiscoveryGroup' is set to true") String connectorNames, @Parameter(name = "useDiscoveryGroup", desc = "use discovery group") boolean useDiscoveryGroup, @Parameter(name = "ha", desc = "Is it using HA") boolean ha, @Parameter(name = "user", desc = "User name") String user, @Parameter(name = "password", desc = "User password") String password) throws Exception;
@Operation(desc = "Create a Bridge", impact = MBeanOperationInfo.ACTION) void createBridge(@Parameter(name = "name", desc = "Name of the bridge") String name, @Parameter(name = "queueName", desc = "Name of the source queue") String queueName, @Parameter(name = "forwardingAddress", desc = "Forwarding address") String forwardingAddress, @Parameter(name = "filterString", desc = "Filter of the bridge") String filterString, @Parameter(name = "transformerClassName", desc = "Class name of the bridge transformer") String transformerClassName, @Parameter(name = "transformerPropertiesAsJSON", desc = "Configuration properties of the bridge transformer in JSON form") String transformerPropertiesAsJSON, @Parameter(name = "retryInterval", desc = "Connection retry interval") long retryInterval, @Parameter(name = "retryIntervalMultiplier", desc = "Connection retry interval multiplier") double retryIntervalMultiplier, @Parameter(name = "initialConnectAttempts", desc = "Number of initial connection attempts") int initialConnectAttempts, @Parameter(name = "reconnectAttempts", desc = "Number of reconnection attempts") int reconnectAttempts, @Parameter(name = "useDuplicateDetection", desc = "Use duplicate detection") boolean useDuplicateDetection, @Parameter(name = "confirmationWindowSize", desc = "Confirmation window size") int confirmationWindowSize, @Parameter(name = "producerWindowSize", desc = "Producer window size") int producerWindowSize, @Parameter(name = "clientFailureCheckPeriod", desc = "Period to check client failure") long clientFailureCheckPeriod, @Parameter(name = "staticConnectorNames", desc = "comma separated list of connector names or name of discovery group if 'useDiscoveryGroup' is set to true") String connectorNames, @Parameter(name = "useDiscoveryGroup", desc = "use discovery group") boolean useDiscoveryGroup, @Parameter(name = "ha", desc = "Is it using HA") boolean ha, @Parameter(name = "user", desc = "User name") String user, @Parameter(name = "password", desc = "User password") String password) throws Exception;
@Operation(desc = "Create a Bridge", impact = MBeanOperationInfo.ACTION) void createBridge(@Parameter(name = "name", desc = "Name of the bridge") String name, @Parameter(name = "queueName", desc = "Name of the source queue") String queueName, @Parameter(name = "forwardingAddress", desc = "Forwarding address") String forwardingAddress, @Parameter(name = "filterString", desc = "Filter of the bridge") String filterString, @Parameter(name = "transformerClassName", desc = "Class name of the bridge transformer") String transformerClassName, @Parameter(name = "retryInterval", desc = "Connection retry interval") long retryInterval, @Parameter(name = "retryIntervalMultiplier", desc = "Connection retry interval multiplier") double retryIntervalMultiplier, @Parameter(name = "initialConnectAttempts", desc = "Number of initial connection attempts") int initialConnectAttempts, @Parameter(name = "reconnectAttempts", desc = "Number of reconnection attempts") int reconnectAttempts, @Parameter(name = "useDuplicateDetection", desc = "Use duplicate detection") boolean useDuplicateDetection, @Parameter(name = "confirmationWindowSize", desc = "Confirmation window size") int confirmationWindowSize, @Parameter(name = "producerWindowSize", desc = "Producer window size") int producerWindowSize, @Parameter(name = "clientFailureCheckPeriod", desc = "Period to check client failure") long clientFailureCheckPeriod, @Parameter(name = "staticConnectorNames", desc = "comma separated list of connector names or name of discovery group if 'useDiscoveryGroup' is set to true") String connectorNames, @Parameter(name = "useDiscoveryGroup", desc = "use discovery group") boolean useDiscoveryGroup, @Parameter(name = "ha", desc = "Is it using HA") boolean ha, @Parameter(name = "user", desc = "User name") String user, @Parameter(name = "password", desc = "User password") String password) throws Exception;
/** * Moves the message corresponding to the specified message ID to the specified other queue. * * @return {@code true} if the message was moved, {@code false} else */ @Operation(desc = "Move the message corresponding to the given messageID to another queue", impact = MBeanOperationInfo.ACTION) boolean moveMessage(@Parameter(name = "messageID", desc = "A message ID") long messageID, @Parameter(name = "otherQueueName", desc = "The name of the queue to move the message to") String otherQueueName, @Parameter(name = "rejectDuplicates", desc = "Reject messages identified as duplicate by the duplicate message") boolean rejectDuplicates) throws Exception;
/** * @param headers the message headers and properties to set. Can only * container Strings maped to primitive types. * @param body the text to send * @param durable * @param user * @param password @return * @throws Exception */ @Operation(desc = "Sends a TextMessage to a password-protected destination.", impact = MBeanOperationInfo.ACTION) String sendMessage(@Parameter(name = "headers", desc = "The headers to add to the message") Map<String, String> headers, @Parameter(name = "type", desc = "A type for the message") int type, @Parameter(name = "body", desc = "The body (byte[]) of the message encoded as a string using Base64") String body, @Parameter(name = "durable", desc = "Whether the message is durable") boolean durable, @Parameter(name = "user", desc = "The user to authenticate with") String user, @Parameter(name = "password", desc = "The users password to authenticate with") String password) throws Exception;
/** * Moves all the message corresponding to the specified filter to the specified other queue. * <br> * Using {@code null} or an empty filter will move <em>all</em> messages from this queue. * * @return the number of moved messages */ @Operation(desc = "Move the messages corresponding to the given filter (and returns the number of moved messages)", impact = MBeanOperationInfo.ACTION) int moveMessages(@Parameter(name = "filter", desc = "A message filter (can be empty)") String filter, @Parameter(name = "otherQueueName", desc = "The name of the queue to move the messages to") String otherQueueName, @Parameter(name = "rejectDuplicates", desc = "Reject messages identified as duplicate by the duplicate message") boolean rejectDuplicates) throws Exception;
@Operation(desc = "Create a Bridge", impact = MBeanOperationInfo.ACTION) void createBridge(@Parameter(name = "name", desc = "Name of the bridge") String name, @Parameter(name = "queueName", desc = "Name of the source queue") String queueName, @Parameter(name = "forwardingAddress", desc = "Forwarding address") String forwardingAddress, @Parameter(name = "filterString", desc = "Filter of the bridge") String filterString, @Parameter(name = "transformerClassName", desc = "Class name of the bridge transformer") String transformerClassName, @Parameter(name = "transformerProperties", desc = "Configuration properties of the bridge transformer") Map<String, String> transformerProperties, @Parameter(name = "retryInterval", desc = "Connection retry interval") long retryInterval, @Parameter(name = "retryIntervalMultiplier", desc = "Connection retry interval multiplier") double retryIntervalMultiplier, @Parameter(name = "initialConnectAttempts", desc = "Number of initial connection attempts") int initialConnectAttempts, @Parameter(name = "reconnectAttempts", desc = "Number of reconnection attempts") int reconnectAttempts, @Parameter(name = "useDuplicateDetection", desc = "Use duplicate detection") boolean useDuplicateDetection, @Parameter(name = "confirmationWindowSize", desc = "Confirmation window size") int confirmationWindowSize, @Parameter(name = "producerWindowSize", desc = "Producer window size") int producerWindowSize, @Parameter(name = "clientFailureCheckPeriod", desc = "Period to check client failure") long clientFailureCheckPeriod, @Parameter(name = "staticConnectorNames", desc = "comma separated list of connector names or name of discovery group if 'useDiscoveryGroup' is set to true") String connectorNames, @Parameter(name = "useDiscoveryGroup", desc = "use discovery group") boolean useDiscoveryGroup, @Parameter(name = "ha", desc = "Is it using HA") boolean ha, @Parameter(name = "user", desc = "User name") String user, @Parameter(name = "password", desc = "User password") String password) throws Exception;
/** * Destroys the queue corresponding to the specified name and delete it's address if there are no other queues */ @Operation(desc = "Destroy a queue", impact = MBeanOperationInfo.ACTION) void destroyQueue(@Parameter(name = "name", desc = "Name of the queue to destroy") String name, @Parameter(name = "removeConsumers", desc = "Remove consumers of this queue") boolean removeConsumers, @Parameter(name = "autoDeleteAddress", desc = "Automatically delete the address if this was the last queue") boolean autoDeleteAddress) throws Exception;
@Operation(desc = "Create a connector service", impact = MBeanOperationInfo.ACTION) void createConnectorService(@Parameter(name = "name", desc = "Name of the connector service") String name, @Parameter(name = "factoryClass", desc = "Class name of the connector service factory") String factoryClass, @Parameter(name = "parameters", desc = "Parameter specific to the connector service") Map<String, Object> parameters) throws Exception;
@Operation(desc = "Search for Consumers", impact = MBeanOperationInfo.INFO) String listConsumers(@Parameter(name = "options", desc = "Options") String options, @Parameter(name = "pageNumber", desc = "Page Number") int page, @Parameter(name = "pageSize", desc = "Page Size") int pageSize) throws Exception;
@Operation(desc = "Search for Addresses", impact = MBeanOperationInfo.INFO) String listAddresses(@Parameter(name = "options", desc = "Options") String options, @Parameter(name = "pageNumber", desc = "Page Number") int page, @Parameter(name = "pageSize", desc = "Page Size") int pageSize) throws Exception;