Websphere MQ Everyplace

examples.administration.console
Class AdminModel

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--examples.administration.console.AdminModel
All Implemented Interfaces:
MQeExceptionCodes

public class AdminModel
extends MQe


Field Summary
protected  MQeClient client
           
protected  java.util.Vector msgFrames
           
protected  java.beans.PropertyChangeSupport propertyChange
           
protected  java.util.Vector qFrames
           
static java.lang.String requestQ
           
static short[] version
           
 
Fields inherited from class com.ibm.mqe.MQe
Admin_Queue_Name, Admin_Reply_Queue_Name, copyright, DeadLetter_Queue_Name, Event_Activate, Event_Attribute, Event_Authenticate, Event_Close, Event_Logoff, Event_Logon, Event_MiniCert_Validate, Event_Queue, Event_QueueManager, Event_UserBase, JMS_Version, MQ_Headers, MQe_Log_Audit_Failure, MQe_Log_Audit_Success, MQe_Log_Error, MQe_Log_Information, MQe_Log_Success, MQe_Log_Warning, Msg_BackoutCount, Msg_CorrelID, Msg_ExpireTime, Msg_LockID, Msg_MsgID, Msg_OriginQMgr, Msg_Priority, Msg_ReplyToQ, Msg_ReplyToQMgr, Msg_Resend, Msg_Style, Msg_Style_Datagram, Msg_Style_Reply, Msg_Style_Request, Msg_Time, Msg_WrapMsg, sccsid, System_Default_Queue_Name
 
Fields inherited from interface com.ibm.mqe.MQeExceptionCodes
Except_Active, Except_AdapterException, Except_AdapterMissingRemoteAddress, Except_Admin_ActionNotSupported, Except_Admin_InvalidField, Except_Admin_NotAdminMsg, Except_AdminAction, Except_Authenticate, Except_BadRequest, Except_BridgeListener, Except_Chnl_Attributes, Except_Chnl_ID, Except_Chnl_Limit, Except_Chnl_Overrun, Except_Closed, Except_Con_AdapterRequired, Except_Con_AliasAlreadyExists, Except_Con_AlreadyExists, Except_Con_InvalidName, Except_Connect_Failure, Except_ConnectonType, Except_Cryptor, Except_Data, Except_Duplicate, Except_JmxProperties, Except_Listener, Except_MessageStore, Except_MiniCertReg_ActivateFailed, Except_MiniCertReg_BadPIN, Except_MiniCertReg_NotOpen, Except_NotActive, Except_NotAllowed, Except_NotFound, Except_NotSupported, Except_PrivateReg_ActivateFailed, Except_PrivateReg_BadPIN, Except_PrivateReg_NotOpen, Except_PublicReg_ActivateFailed, Except_PublicReg_InvalidAddress, Except_PublicReg_InvalidRequest, Except_Q_Full, Except_Q_InvalidName, Except_Q_InvalidPriority, Except_Q_MsgTooLarge, Except_Q_NoMatchingMsg, Except_Q_TargetRegistryRequired, Except_QMgr_Activated, Except_QMgr_AlreadyExists, Except_QMgr_InvalidQMgrName, Except_QMgr_InvalidQName, Except_QMgr_NotActive, Except_QMgr_NotBridgeEnabled, Except_QMgr_NotConfigured, Except_QMgr_QDoesNotExist, Except_QMgr_QExists, Except_QMgr_QNotEmpty, Except_QMgr_RegistryDataVersion, Except_QMgr_UnknownQMgr, Except_QMgr_WrongQType, Except_Reg_AddFailed, Except_Reg_AlreadyExists, Except_Reg_AlreadyOpen, Except_Reg_CRTKeyDecFailed, Except_Reg_CRTKeySignFailed, Except_Reg_DeleteFailed, Except_Reg_DeleteRegistryFailed, Except_Reg_DoesNotExist, Except_Reg_InvalidSession, Except_Reg_ListFailed, Except_Reg_NotDefined, Except_Reg_NotSecure, Except_Reg_NullName, Except_Reg_OpenFailed, Except_Reg_ReadFailed, Except_Reg_RenameFailed, Except_Reg_ResetPINFailed, Except_Reg_SearchFailed, Except_Reg_UpdateFailed, Except_RemoteException, Except_Rule, Except_S_BadIntegrity, Except_S_BadSubject, Except_S_CertificateExpired, Except_S_Cipher, Except_S_InvalidAttribute, Except_S_InvalidSignature, Except_S_MiniCertNotAvailable, Except_S_MissingSection, Except_S_NoPresetKeyAvailable, Except_S_RegistryNotAvailable, Except_Stopped, Except_Syntax, Except_TimeOut, Except_Transporter, Except_TriggerTransmission, Except_Trnsport_QMgr, Except_Trnsport_Request, Except_Type, Except_UdpipAdapterStateException, Except_UdpipAdapterTimeOut, Except_UdpipAdapterUnableToConfirmSuccess, Except_UnCoded, Except_Uncontactable_DontTransmit
 
Constructor Summary
AdminModel()
          AdminModel default constructor.
 
Method Summary
 void activate()
          activate - initialisation code.
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          The addPropertyChangeListener method was generated to support the propertyChange field.
 void checkConnected()
          Ensure connection state is set correctly.
 void closeMsgDisplay()
          Close any active msg display windows.
 void closeQueueDisplay()
          Close any active queue browser windows.
 void connectLocalQM()
          Connect to access the local queue manager.
 void disconnectLocalQM()
          Disconnect from the local queue manager.
 AdminFrame displayMsg(MQeAdminMsg msg, int action, AdminFrame redisplayFrame)
          Display the relavent GUI for an admin message.
 AdminQueueBrowser displayQueue(java.lang.String qMgrName, java.lang.String qName, java.lang.String browserType, AdminQueueBrowser redisplayFrame)
          Display the relavent GUI for a queue.
 void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
          The firePropertyChange method was generated to support the propertyChange field.
 boolean getConnected()
          Gets the state of the connection to the local QMgr.
 AdminLogBrowser getLogBrowser()
          Get the log queue browser object.
 java.lang.String getManageQM()
          Gets the name of the queue manager to be administered.
 java.lang.String getManageViaQM()
          Gets the name of the local queue manager.
 boolean getMode()
          Gets the mode property (boolean) value.
protected  java.beans.PropertyChangeSupport getPropertyChange()
          Accessor for the propertyChange field.
 MQeQueueManager getQM()
          Get a reference to the queue manager.
 java.lang.String getQMgrStartupIniFile()
          Gets the qMgrStartupIniFile property (java.lang.String) value.
 java.lang.String getReplyToQ()
          Gets the reply to queue name.
 java.lang.String getReplyToQM()
          Gets the reply to queue manager name.
 java.lang.String getStatus()
          Gets the status / last message.
 boolean isQMgrStarted()
          Is the local queue manager started?
 boolean isReplyRequired()
          Is a reply required ?
 void logMsg(MQeAdminMsg msg)
          Put a message to the reply to queue manager / queue.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          The removePropertyChangeListener method was generated to support the propertyChange field.
 void sendRequest(MQeAdminMsg requestMsg)
          Send an admin message to the queue manager to be administered.
 void setConnected(boolean connected)
          Sets the connected property (boolean) value.
 void setLogBrowser(AdminLogBrowser log)
          Sets the log property (Example.Admin.AdminLogModel) value.
 void setManageQM(java.lang.String manageQM)
          Sets the manageQM property (java.lang.String) value.
 void setManageViaQM(java.lang.String manageViaQM)
          Sets the manageViaQM property (java.lang.String) value.
 void setMode(boolean mode)
          Sets the mode property (boolean) value.
 void setQMgrStartupIniFile(java.lang.String qMgrStartupIniFile)
          Sets the qMgrStartupIniFile property (java.lang.String) value.
 void setReplyToQ(java.lang.String replyToQ)
          Sets the replyToQ property (java.lang.String) value.
 void setReplyToQM(java.lang.String replyToQM)
          Sets the replyToQM property (java.lang.String) value.
 void setStatus(java.lang.String status)
          Sets the status property (java.lang.String) value.
 void startLocalQM()
          Start the local queue manager.
 void stopLocalQM()
          Stop the local queue manager.
 
Methods inherited from class com.ibm.mqe.MQe
abbreviate, alias, asciiToByte, byteToAscii, byteToHex, byteToHex, byteToInt, byteToLong, byteToShort, byteToUnicode, fileSeparator, getEventLogHandler, hexToAscii, hexToByte, intToByte, isCLDC, loadClass, loadObject, log, setEventLogHandler, setLoader, sliceByteArray, type, unicodeToByte, uniqueValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

version

public static short[] version

propertyChange

protected transient java.beans.PropertyChangeSupport propertyChange

msgFrames

protected java.util.Vector msgFrames

qFrames

protected java.util.Vector qFrames

client

protected MQeClient client

requestQ

public static final java.lang.String requestQ
See Also:
Constant Field Values
Constructor Detail

AdminModel

public AdminModel()
AdminModel default constructor.

Method Detail

activate

public void activate()
activate - initialisation code.


addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
The addPropertyChangeListener method was generated to support the propertyChange field.


checkConnected

public void checkConnected()
Ensure connection state is set correctly.


closeMsgDisplay

public void closeMsgDisplay()
Close any active msg display windows.


closeQueueDisplay

public void closeQueueDisplay()
Close any active queue browser windows.


connectLocalQM

public void connectLocalQM()
                    throws java.lang.Exception
Connect to access the local queue manager.

java.lang.Exception

disconnectLocalQM

public void disconnectLocalQM()
Disconnect from the local queue manager.


displayMsg

public AdminFrame displayMsg(MQeAdminMsg msg,
                             int action,
                             AdminFrame redisplayFrame)
                      throws java.lang.Exception
Display the relavent GUI for an admin message.

java.lang.Exception

displayQueue

public AdminQueueBrowser displayQueue(java.lang.String qMgrName,
                                      java.lang.String qName,
                                      java.lang.String browserType,
                                      AdminQueueBrowser redisplayFrame)
                               throws java.lang.Exception
Display the relavent GUI for a queue.

java.lang.Exception

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)
The firePropertyChange method was generated to support the propertyChange field.


getConnected

public boolean getConnected()
Gets the state of the connection to the local QMgr.

Returns:
The connected property value.
See Also:
setConnected(boolean)

getLogBrowser

public AdminLogBrowser getLogBrowser()
Get the log queue browser object.

Returns:
The log property value.
See Also:
setLogBrowser(examples.administration.console.AdminLogBrowser)

getManageQM

public java.lang.String getManageQM()
Gets the name of the queue manager to be administered.

Returns:
The manageQM property value.
See Also:
setManageQM(java.lang.String)

getManageViaQM

public java.lang.String getManageViaQM()
Gets the name of the local queue manager.

Returns:
The manageViaQM property value.
See Also:
setManageViaQM(java.lang.String)

getMode

public boolean getMode()
Gets the mode property (boolean) value.
 - false: manage a local queue manager
 - true:  manage a remote queue manager
 

Returns:
The mode property value.
See Also:
setMode(boolean)

getPropertyChange

protected java.beans.PropertyChangeSupport getPropertyChange()
Accessor for the propertyChange field.


getQM

public MQeQueueManager getQM()
Get a reference to the queue manager.


getQMgrStartupIniFile

public java.lang.String getQMgrStartupIniFile()
Gets the qMgrStartupIniFile property (java.lang.String) value.

Returns:
The qMgrStartupIniFile property value.
See Also:
setQMgrStartupIniFile(java.lang.String)

getReplyToQ

public java.lang.String getReplyToQ()
Gets the reply to queue name.

Returns:
The replyToQ property value.
See Also:
setReplyToQ(java.lang.String)

getReplyToQM

public java.lang.String getReplyToQM()
Gets the reply to queue manager name.

Returns:
The replyToQM property value.
See Also:
setReplyToQM(java.lang.String)

getStatus

public java.lang.String getStatus()
Gets the status / last message.

Returns:
The status property value.
See Also:
setStatus(java.lang.String)

isQMgrStarted

public boolean isQMgrStarted()
Is the local queue manager started?


isReplyRequired

public boolean isReplyRequired()
Is a reply required ?


logMsg

public void logMsg(MQeAdminMsg msg)
            throws java.lang.Exception
Put a message to the reply to queue manager / queue.

java.lang.Exception

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
The removePropertyChangeListener method was generated to support the propertyChange field.


sendRequest

public void sendRequest(MQeAdminMsg requestMsg)
                 throws MQeException
Send an admin message to the queue manager to be administered.

MQeException

setConnected

public void setConnected(boolean connected)
Sets the connected property (boolean) value.

Parameters:
connected - The new value for the property.
See Also:
getConnected()

setLogBrowser

public void setLogBrowser(AdminLogBrowser log)
Sets the log property (Example.Admin.AdminLogModel) value.

Parameters:
log - The new value for the property.
See Also:
getLogBrowser()

setManageQM

public void setManageQM(java.lang.String manageQM)
Sets the manageQM property (java.lang.String) value.

Parameters:
manageQM - The new value for the property.
See Also:
getManageQM()

setManageViaQM

public void setManageViaQM(java.lang.String manageViaQM)
Sets the manageViaQM property (java.lang.String) value.

Parameters:
manageViaQM - The new value for the property.
See Also:
getManageViaQM()

setMode

public void setMode(boolean mode)
Sets the mode property (boolean) value.

Parameters:
mode - The new value for the property.
See Also:
getMode()

setQMgrStartupIniFile

public void setQMgrStartupIniFile(java.lang.String qMgrStartupIniFile)
Sets the qMgrStartupIniFile property (java.lang.String) value.

Parameters:
qMgrStartupIniFile - The new value for the property.
See Also:
getQMgrStartupIniFile()

setReplyToQ

public void setReplyToQ(java.lang.String replyToQ)
Sets the replyToQ property (java.lang.String) value.

Parameters:
replyToQ - The new value for the property.
See Also:
getReplyToQ()

setReplyToQM

public void setReplyToQM(java.lang.String replyToQM)
Sets the replyToQM property (java.lang.String) value.

Parameters:
replyToQM - The new value for the property.
See Also:
getReplyToQM()

setStatus

public void setStatus(java.lang.String status)
Sets the status property (java.lang.String) value.

Parameters:
status - The new value for the property.
See Also:
getStatus()

startLocalQM

public void startLocalQM()
                  throws java.lang.Exception
Start the local queue manager.

java.lang.Exception

stopLocalQM

public void stopLocalQM()
Stop the local queue manager.


Websphere MQ Everyplace