Websphere MQ Everyplace

com.ibm.mqe.attributes
Class MQeLocalSecure

java.lang.Object
  |
  +--com.ibm.mqe.MQe
        |
        +--com.ibm.mqe.attributes.MQeLocalSecure
All Implemented Interfaces:
MQeExceptionCodes

public class MQeLocalSecure
extends MQe

This class is used to create a LocalSecure object that provides a simple local security service enabling a using application to apply a given attribute’s ( cryptor and compressor) components to protect local data.

This class is a descendant of MQe.


Field Summary
 
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, version
 
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
MQeLocalSecure()
          Constructs an MQeLocalSecure object.
 
Method Summary
 void open(java.lang.String fileDesc, java.lang.Object fileName)
          Enables the using application to identify the target File.
 byte[] read(MQeAttribute attr, java.lang.String localCipherKey)
          Reads, unprotects and returns data from the target file.
static void setStorageAdapter(java.lang.String adapterName)
          Sets the storage adapter to be used by the Object
 void write(byte[] data, MQeAttribute attr, java.lang.String localCipherKey)
          Protects and writes the given data to the target file.
 
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
 

Constructor Detail

MQeLocalSecure

public MQeLocalSecure()

Constructs an MQeLocalSecure object.

See Also:
MQeAttribute
Example:
 MQeLocalSecure ls = new MQeLocalSecure();
 
 
Method Detail

setStorageAdapter

public static void setStorageAdapter(java.lang.String adapterName)

Sets the storage adapter to be used by the Object

Parameters:
adapterName - A string representing the adapter class or alias
Returns:
void

open

public void open(java.lang.String fileDesc,
                 java.lang.Object fileName)

Enables the using application to identify the target File.

Sets the target filename.

Parameters:
fileDesc - A string identifying the target file directory.
fileName - A string identifying the target file name.
Returns:
void
See Also:
write(byte[], com.ibm.mqe.MQeAttribute, java.lang.String), read(com.ibm.mqe.MQeAttribute, java.lang.String)

write

public void write(byte[] data,
                  MQeAttribute attr,
                  java.lang.String localCipherKey)
           throws java.lang.Exception

Protects and writes the given data to the target file.

Parameters:
data - Data to protect
attr - MQeAttribute to be applied to protect data
localCipherKey - Password or passphrase String to be used to protect data
Returns:
void
Throws:
MQeException -
  • Except_S_InvalidAttribute : "no cryptor"
  • Except_S_InvalidAttribute : "illegal cryptor"
  • Except_S_InvalidAttribute : "illegal authenticator or compressor"
java.lang.Exception - java.io
Example:
 try {
     MQeDESCryptor des = new MQeDESCryptor();
     MQeAttribute desA = new MQeAttribute(null, des, null);
     MQeLocalSecure ls = new MQeLocalSecure();
 
     ls.open(".\\", "TestSecureData.txt");
     ls.write(MQe.asciiToByte("0123456789abcdef..."), desA, "It_is_a_secret");
 
 } catch (Exception e) {// Handle the Exception here.
 }
 
 

read

public byte[] read(MQeAttribute attr,
                   java.lang.String localCipherKey)
            throws java.lang.Exception

Reads, unprotects and returns data from the target file.

Parameters:
attr - MQeAttribute to be applied to unprotect data
localCipherKey - Password or passphrase String to be used to unprotect data
Returns:
Data that was read in a byte []
Throws:
MQeException -
  • Except_S_InvalidAttribute : "no cryptor"
  • Except_S_InvalidAttribute : "illegal cryptor"
  • Except_S_InvalidAttribute : "illegal authenticator or compressor"
  • MQe.Except_Data : "wrong cipher"
java.lang.Exception - java.io
Example:
 public byte[] UseRead(MQeAttribute attr, String localCipherKey) throws Exception {
     byte[] data = null;
 
     try {
         MQeDESCryptor des = new MQeDESCryptor();
         MQeAttribute desA = new MQeAttribute(null, des, null);
         MQeLocalSecure ls = new MQeLocalSecure();
 
         ls.open(".\\", "TestSecureData.txt");
         data = ls.read(desA, "It_is_a_secret");
         String outData = MQe.byteToAscii(data);
 
         System.out.println("unprotected data =" + outData);
     } catch (Exception e) {// Handle the Exception here.
     }
     return data;
 
     }
 

Websphere MQ Everyplace