com.ibm.commerce.messaging.adapters.jcautil
Class JCATraceHelper

java.lang.Object
  |
  +--com.ibm.commerce.messaging.adapters.jcautil.JCATraceHelper
All Implemented Interfaces:
JCATracing

public class JCATraceHelper
extends java.lang.Object
implements JCATracing

This class implements the JCATracing interface. This utility class is used to provide tracing service to the J2EE JCA compliant outbound connectors.


Field Summary
static java.lang.String COPYRIGHT
          Copyright statement.
 
Fields inherited from interface com.ibm.commerce.messaging.adapters.jcautil. JCATracing
DBG_CONNECTOR_PROPERTY_SET, DBG_JM_EMAIL_SENTADDRESSES, ERR_CONFIG_NO_ERRQ, ERR_CONFIG_NO_INQ, ERR_CONFIG_NO_OUTQ, ERR_CONFIG_NO_Q, ERR_CONNECTOR_FILE_CLOSE, ERR_CONNECTOR_FILE_OPEN, ERR_CONNECTOR_FILE_WRITE, ERR_CONNECTOR_JM_CONTENTEMPTY, ERR_CONNECTOR_JM_MSGSENDMESSAGINGEXC, ERR_CONNECTOR_JM_NORECIPIENTSSPECIFIED, ERR_CONNECTOR_JM_NOTCONNECTED, ERR_JCA_NULL_JNDI, ERR_JCASAMPLE_INVALID_INPUT, ERR_JMS_CONNECT_CREATE, ERR_JMS_CONNECT_START, ERR_JMS_CONNECT_STOP, ERR_JMS_CREATE_BYTES, ERR_JMS_MESSAGEPRODUCER_CREATE, ERR_JMS_NO_CORRELATION_ID, ERR_JMS_QCF_LOOKUP, ERR_JMS_QTYPE_NOT_SUPPORTED, ERR_JMS_QUEUE_LOOKUP, ERR_JMS_RECEIVE_BYTES, ERR_JMS_REMOTE_RTQ_MGR_MISMATCH, ERR_JMS_RTQ_MGR_MISMATCH, ERR_JMS_SEND_BYTES, ERR_JMS_SESSION_CLOSE, ERR_JMS_SESSION_COMMIT, ERR_JMS_SESSION_CREATE, ERR_JMS_START_RECEIVE, ERR_MS_AUTO_COMMIT_FAIL, ERR_MS_CDATA_IOEXCEPTION, ERR_MS_CLASS_NOT_FOUND, ERR_MS_GENERIC_EXCEPTION, ERR_MS_ILLEGAL_STATE, ERR_MS_INVALID_CONNECTION_TYPE, ERR_MSG_RESOURCE_EXCEPTION, ERR_NAMING_EXCEPTION, JCAEMAIL_COMPONENT, JCAEMAIL_LOGGER, JCAFILE_COMPONENT, JCAFILE_LOGGER, JCAJMS_COMPONENT, JCAJMS_LOGGER, JCASAMPLE_COMPONENT, JCASAMPLE_LOGGER
 
Constructor Summary
JCATraceHelper()
           
 
Method Summary
static java.lang.String doubleTheApostrophy(java.lang.String theString)
          Insert an addition apostrophy if the message text contains a apostrophy.
static java.lang.Object[] generateMsgParms(java.lang.Object parm1)
          Create an object array to be used as parameters to be passed to a message
static java.lang.Object[] generateMsgParms(java.lang.Object parm1, java.lang.Object parm2)
          Create an object array to be used as parameters to be passed to a message.
static java.lang.Object[] generateMsgParms(java.lang.Object parm1, java.lang.Object parm2, java.lang.Object parm3)
          Create an object array to be used as parameters to be passed to a message.
static java.lang.Object[] generateMsgParms(java.lang.Object parm1, java.lang.Object parm2, java.lang.Object parm3, java.lang.Object parm4)
          Create an object array to be used as parameters to be passed to a message.
static java.lang.String getSystemMessage(java.lang.String loggerName, java.lang.String msgKey, java.lang.Object[] parms)
          Return the textual description of the system message passed as argument.
static java.lang.String getSystemMessage(java.lang.String loggerName, java.lang.String msgKey, java.lang.Object[] parms, java.util.Locale locale)
          Return the textual description of the system message passed as argument.
static java.lang.String getSystemResourceBundleName(java.lang.String loggerName)
          Retrieve the resource bundle associated with a system message.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
Copyright statement.
See Also:
Constant Field Values
Constructor Detail

JCATraceHelper

public JCATraceHelper()
Method Detail

generateMsgParms

public static java.lang.Object[] generateMsgParms(java.lang.Object parm1)
Create an object array to be used as parameters to be passed to a message
Parameters:
parm1 - Value of the first parameter to be substituted into the message text.
Returns:
Object[] The Object array that contains the input parameter.

generateMsgParms

public static java.lang.Object[] generateMsgParms(java.lang.Object parm1,
                                                  java.lang.Object parm2)
Create an object array to be used as parameters to be passed to a message.
Parameters:
parm1 - Value of the first parameter to be substituted into the message text.
parm2 - Value of the first parameter to be substituted into the message text.
Returns:
Object[] The Object array that contains the input parameters.

generateMsgParms

public static java.lang.Object[] generateMsgParms(java.lang.Object parm1,
                                                  java.lang.Object parm2,
                                                  java.lang.Object parm3)
Create an object array to be used as parameters to be passed to a message.
Parameters:
parm1 - Value of the first parameter to be substituted into the message text.
parm2 - Value of the second parameter to be substituted into the message text.
parm3 - Value of the third parameter to be substituted into the message text.
Returns:
Object[] The Object array that contains the input parameters.

generateMsgParms

public static java.lang.Object[] generateMsgParms(java.lang.Object parm1,
                                                  java.lang.Object parm2,
                                                  java.lang.Object parm3,
                                                  java.lang.Object parm4)
Create an object array to be used as parameters to be passed to a message.
Parameters:
parm1 - Value of the first parameter to be substituted into the message text.
parm2 - Value of the second parameter to be substituted into the message text.
parm3 - Value of the third parameter to be substituted into the message text.
parm4 - Value of the fourth parameter to be substituted into the message text.
Returns:
Object[] The Object array that contains the input parameters.

getSystemMessage

public static java.lang.String getSystemMessage(java.lang.String loggerName,
                                                java.lang.String msgKey,
                                                java.lang.Object[] parms)
Return the textual description of the system message passed as argument. Default local will be used.
Parameters:
loggerName - String The name of logger.
msgKey - String The message key.
parms - Object [] Array of objects used for placeholders replacement in the message text.
Returns:
java.lang.String

getSystemMessage

public static java.lang.String getSystemMessage(java.lang.String loggerName,
                                                java.lang.String msgKey,
                                                java.lang.Object[] parms,
                                                java.util.Locale locale)
Return the textual description of the system message passed as argument.
Parameters:
loggerName - The logger name.
msgKey - String The message key.
parms - Object [] Array of objects used for placeholders replacement in the message text.
locale - Locale Used to identify the resource bundle containing the translated message. If null, default locale is used.
Returns:
java.lang.String

getSystemResourceBundleName

public static java.lang.String getSystemResourceBundleName(java.lang.String loggerName)
Retrieve the resource bundle associated with a system message.
Returns:
java.lang.String

doubleTheApostrophy

public static java.lang.String doubleTheApostrophy(java.lang.String theString)
Insert an addition apostrophy if the message text contains a apostrophy. This method is used when message format is required.
Returns:
String