Interface IExplorerNotify
- All Known Implementing Classes:
IExplorerNotifyAdapter
public interface IExplorerNotify
Event interface for notification of explorer events providing information on the explorer being
initialised and closed. Queue managers being removed, show and hidden. The explorer view being
opened and closed, and the plugin being enabled and disabled.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
Called when the Explorer starts to close.void
Called when Explorer initialisation is completevoid
Called when an Explorer preference is changed which may effect a plug-in.boolean
Called when a local queue manager is about to be deleted by the Explorer, the plugin can veto the deletion by returning true.boolean
Called when the connection to a remote queue manager is about to be removed from the Explorer, the plugin can veto the removal by returning true.boolean
Called when a local queue manager is about to be stopped by the Explorer, the plugin can veto the stopping by returning true.void
Called when a plug-in is disabled on the preferences page.void
pluginEnabled
(ExplorerNotifyEvent event) Called when a plug-in is enabled on the preferences page.void
Called when a Queue Manager is added to the Explorervoid
Called when a local Queue Manager is about to be deleted.void
Called when a Queue Manager is hidden from the Explorer.void
Called when a remote Queue Manager is about to be removed.void
Called when a Queue Manager is shown in the Explorer.void
Called when a local Queue Manager is about to be started.void
Called when a local Queue Manager is about to be stopped.void
viewClosed
(ExplorerNotifyEvent event) Called when an Explorer view is closedvoid
viewOpened
(ExplorerNotifyEvent event) Called when an Explorer view is opened
-
Field Details
-
SCCSID
SCCS id - expanded when file is extracted from CMVC- See Also:
-
COPYRIGHT_NOTICE
Copyright notice- See Also:
-
-
Method Details
-
explorerInitialised
void explorerInitialised()Called when Explorer initialisation is complete -
queueManagerAdded
Called when a Queue Manager is added to the Explorer- Parameters:
event
- event.getOject() specifies the MQQmgrExtObject for the Queue Manager
-
isPreventRemoveQueueManager
Called when the connection to a remote queue manager is about to be removed from the Explorer, the plugin can veto the removal by returning true. It is the plugins responsibility to inform the user that removal has been veto'd. It is the plugins responsibility to ensure that the UI thread is not blocked, and that user feedback is provided as appropriate. Note: this does not apply to the deletion of a local queue manager.- Parameters:
event
- event.getOject() specifies the MQQmgrExtObject for the Queue Manager- Returns:
- true to stop removal, false to allow.
-
isPreventDeleteQueueManager
Called when a local queue manager is about to be deleted by the Explorer, the plugin can veto the deletion by returning true. It is the plugins responsibility to inform the user that removal has been veto'd. It is the plugins responsibility to ensure that the UI thread is not blocked, and that user feedback is provided as appropriate. This event only applies to deletion via the Explorer, command line deletion may still cause a queue manager to disappear without warning. Note: this does not apply to the removal of a remote queue manager.- Parameters:
event
- event.getObject() specified the MQQmgrExtObject for the Queue Manager- Returns:
- true to stop deletion, false to allow.
-
isPreventStopQueueManager
Called when a local queue manager is about to be stopped by the Explorer, the plugin can veto the stopping by returning true. It is the plugins responsibility to inform the user that removal has been veto'd. It is the plugins responsibility to ensure that the UI thread is not blocked, and that user feedback is provided as appropriate. This event only applies to a queue manager being stopped via the Explorer, command line endmqm may still cause a queue manager to stop without warning.- Parameters:
event
- event.getObject() specified the MQQmgrExtObject for the Queue Manager- Returns:
- true to stop deletion, false to allow.
-
queueManagerRemoved
Called when a remote Queue Manager is about to be removed. Once all plugins have returned from this interface call, the remote Queue Manager will be removed from the explorer. This allows plugins to perform any appropriate actions prior to the removal. It is the plugins responsibility to ensure that the UI thread is not blocked, and that user feedback is provided as appropriate.- Parameters:
event
- event.getOject() spcifies the MQQmgrExtObject for the Queue Manager
-
queueManagerDeleted
Called when a local Queue Manager is about to be deleted. Once all plugins have returned from this interface call, the local Queue Manager will be deleted. This allows plugins to perform any appropriate actions prior to the deletion. It is the plugins responsibility to ensure that the UI thread is not blocked, and that user feedback is provided as appropriate.- Parameters:
event
- event.getOject() spcifies the MQQmgrExtObject for the Queue Manager
-
queueManagerStopped
Called when a local Queue Manager is about to be stopped. Once all plugins have returned from this interface call, the local Queue Manager will be stopped. This allows plugins to perform any appropriate actions prior to the stopping. This event only applies to a queue manager being stopped via the Explorer, command line endmqm may still cause a queue manager to stop without warning. It is the plugins responsibility to ensure that the UI thread is not blocked, and that user feedback is provided as appropriate.- Parameters:
event
- event.getOject() spcifies the MQQmgrExtObject for the Queue Manager
-
queueManagerStarted
Called when a local Queue Manager is about to be started. Once all plugins have returned from this interface call, the local Queue Manager will be started. This allows plugins to perform any appropriate actions prior to the starting. This event only applies to a queue manager being started via the Explorer, command line strmqm may still cause a queue manager to start without warning. It is the plugins responsibility to ensure that the UI thread is not blocked, and that user feedback is provided as appropriate.- Parameters:
event
- event.getOject() spcifies the MQQmgrExtObject for the Queue Manager
-
queueManagerShown
Called when a Queue Manager is shown in the Explorer.- Parameters:
event
- event.getOject() spcifies the MQQmgrExtObject for the Queue Manager
-
queueManagerHidden
Called when a Queue Manager is hidden from the Explorer.- Parameters:
event
- event.getOject() spcifies the MQQmgrExtObject for the Queue Manager
-
viewOpened
Called when an Explorer view is opened- Parameters:
event
- event.getId() specifies the id of the View that has been opened
-
viewClosed
Called when an Explorer view is closed- Parameters:
event
- event.getId() specifies the id of the View that has been opened
-
pluginEnabled
Called when a plug-in is enabled on the preferences page.- Parameters:
event
- event.getId() specifies the id of the plug-in that has been enabled
-
pluginDisabled
Called when a plug-in is disabled on the preferences page.- Parameters:
event
- event.getId() specifies the id of the plug-in that was disabled
-
explorerPreferenceChanged
Called when an Explorer preference is changed which may effect a plug-in.- Parameters:
event
- event.getId() specifies the id of the preference that has changed event.getObject() specifies the new value of the preference
-
explorerClosing
void explorerClosing()Called when the Explorer starts to close.
-