public class MMessageBundle
extends java.lang.Object
Constructor and Description |
---|
MMessageBundle() |
Modifier and Type | Method and Description |
---|---|
static void |
addMessage(java.lang.String messageCode,
java.lang.String role,
java.lang.String category,
java.lang.String message)
Add message codes and associated information to the
MMessageBundle object. |
static void |
addResourceBundle(java.lang.String subSystem,
java.util.ResourceBundle resBundle) |
static void |
addResourceBundle(java.lang.String subSystem,
java.util.ResourceBundle resBundle,
java.util.Locale locale) |
static void |
addResourceBundle(java.lang.String subSystem,
java.lang.String filename)
Load messages for a custom adapter from a resouce file.
|
static void |
addResourceBundle(java.lang.String subSystem,
java.lang.String filename,
java.lang.ClassLoader resourceClassLoader)
Load messages for a custom adapter from a resouce file.
|
static void |
addResourceBundle(java.lang.String subSystem,
java.lang.String filename,
java.util.Locale locale) |
static void |
addXMLResourceBundle(java.lang.String subSystem,
java.lang.String filename) |
static java.lang.String |
getCategory(java.lang.String messageCode)
Get the category for the specified code.
|
static java.lang.String |
getErrorCode(java.lang.String rsErrorCode) |
static java.lang.String |
getMessage(java.lang.String messageCode)
Return the message associated with this messageCode.
|
static java.lang.String |
getMessage(java.lang.String errorCode,
java.util.Locale locale) |
static java.lang.String |
getMessage(java.lang.String messageCode,
java.lang.Object param1)
Return the message associated with this messageCode.
|
static java.lang.String |
getMessage(java.lang.String messageCode,
java.lang.Object[] args)
Return the message associated with this messageCode.
|
static java.lang.String |
getMessage(java.lang.String errorCode,
java.lang.Object[] args,
java.util.Locale locale) |
static java.lang.String |
getMessage(java.lang.String messageCode,
java.lang.Object param1,
java.lang.Object param2)
Return the message associated with this messageCode.
|
static java.lang.String |
getMessage(java.lang.String messageCode,
java.lang.Object param1,
java.lang.Object param2,
java.lang.Object param3)
Return the message associated with this messageCode.
|
static java.lang.String |
getMessage(java.lang.String messageCode,
java.lang.Object param1,
java.lang.Object param2,
java.lang.Object param3,
java.lang.Object param4)
Return the message associated with this messageCode.
|
static java.lang.String |
getMessage(java.lang.String messageCode,
java.lang.Object param1,
java.lang.Object param2,
java.lang.Object param3,
java.lang.Object param4,
java.lang.Object param5)
Return the message associated with this messageCode.
|
static java.lang.String |
getMessage(java.lang.String messageCode,
java.lang.Object param1,
java.lang.Object param2,
java.lang.Object param3,
java.lang.Object param4,
java.lang.Object param5,
java.lang.Object param6)
Return the message associated with this messageCode.
|
static java.lang.String |
getMessage(java.lang.String messageCode,
java.lang.Object param1,
java.lang.Object param2,
java.lang.Object param3,
java.lang.Object param4,
java.lang.Object param5,
java.lang.Object param6,
java.lang.Object param7)
Return the message associated with this messageCode.
|
static java.lang.String |
getMessage(java.lang.String messageCode,
java.lang.Object param1,
java.lang.Object param2,
java.lang.Object param3,
java.lang.Object param4,
java.lang.Object param5,
java.lang.Object param6,
java.lang.Object param7,
java.lang.Object param8)
Return the message associated with this messageCode.
|
static java.lang.String |
getRole(java.lang.String messageCode)
Get the role name for this error code.
|
static java.lang.String |
getSubsystem(java.lang.String rsErrorCode) |
static boolean |
isValidMessage(java.lang.String rsErrorCode)
Deprecated.
Internal use only
|
static boolean |
isValidMessage(java.lang.String rsErrorCode,
java.util.Locale locale)
Deprecated.
Internal use only
|
static java.lang.String |
toXMLString() |
public static boolean isValidMessage(java.lang.String rsErrorCode)
public static boolean isValidMessage(java.lang.String rsErrorCode, java.util.Locale locale)
public static java.lang.String getSubsystem(java.lang.String rsErrorCode)
public static java.lang.String getErrorCode(java.lang.String rsErrorCode)
public static java.lang.String getMessage(java.lang.String messageCode)
messageCode
- Use this message code to find the message.public static java.lang.String getMessage(java.lang.String errorCode, java.util.Locale locale)
public static java.lang.String getMessage(java.lang.String messageCode, java.lang.Object[] args)
messageCode
- Use this message code to find the message.public static java.lang.String getMessage(java.lang.String errorCode, java.lang.Object[] args, java.util.Locale locale)
public static java.lang.String getMessage(java.lang.String messageCode, java.lang.Object param1)
messageCode
- Use this message code to find the message.param1
- value for substituting %1 that is contained in the message description.
For each param(n), substitutes on %1, %2, %3, values contained in the message description.public static java.lang.String getMessage(java.lang.String messageCode, java.lang.Object param1, java.lang.Object param2)
messageCode
- Use this message code to find the message.param1
- See getMessage(String messageCode, Object param1)
for
a description of param
n arguments.public static java.lang.String getMessage(java.lang.String messageCode, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3)
messageCode
- Use this message code to find the message.param1
- See getMessage(String messageCode, Object param1)
for
a description of param
n arguments.public static java.lang.String getMessage(java.lang.String messageCode, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3, java.lang.Object param4)
messageCode
- Use this message code to find the message.param1
- See getMessage(String messageCode, Object param1)
for
a description of param
n arguments.public static java.lang.String getMessage(java.lang.String messageCode, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3, java.lang.Object param4, java.lang.Object param5)
messageCode
- Use this message code to find the message.param1
- See getMessage(String messageCode, Object param1)
for
a description of param
n arguments.public static java.lang.String getMessage(java.lang.String messageCode, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3, java.lang.Object param4, java.lang.Object param5, java.lang.Object param6)
messageCode
- Use this message code to find the message.param1
- See getMessage(String messageCode, Object param1)
for
a description of param
n arguments.public static java.lang.String getMessage(java.lang.String messageCode, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3, java.lang.Object param4, java.lang.Object param5, java.lang.Object param6, java.lang.Object param7)
messageCode
- Use this message code to find the message.param1
- See getMessage(String messageCode, Object param1)
for
a description of param
n arguments.public static java.lang.String getMessage(java.lang.String messageCode, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3, java.lang.Object param4, java.lang.Object param5, java.lang.Object param6, java.lang.Object param7, java.lang.Object param8)
messageCode
- Use this message code to find the message.param1
- See getMessage(String messageCode, Object param1)
for
a description of param
n arguments.public static java.lang.String getCategory(java.lang.String messageCode)
messageCode
- This argument specifies the category. The standard categories
are: Database
, Configuration
, TibRvComm
,
JMSComm
, Application
.public static java.lang.String getRole(java.lang.String messageCode)
messageCode
- This argument specifies a role such as errorRole
,
infoRole
, and so forth.public static void addMessage(java.lang.String messageCode, java.lang.String role, java.lang.String category, java.lang.String message)
MMessageBundle
object.
messageCode
- Message code.role
- Role of this message.category
- Category of the message. See getCategory(String)
for a list of the standard categories.message
- Message for this code.addResourceBundle(String, String)
public static void addResourceBundle(java.lang.String subSystem, java.util.ResourceBundle resBundle)
public static void addResourceBundle(java.lang.String subSystem, java.util.ResourceBundle resBundle, java.util.Locale locale)
public static void addResourceBundle(java.lang.String subSystem, java.lang.String filename)
The path of the resource file needs to be in the CLASSPATH
.
The properties file format is:
< role>.< category>.< messageCode> =text message
For example:
ERROR.TibrvComm.AESDKJ-00012=Publish Failed on subject %1
subSystem
- The name of the system of the associated resource bundle.filename
- The name of the resource bundle which is a properties file.addMessage(String, String, String, String)
public static void addResourceBundle(java.lang.String subSystem, java.lang.String filename, java.lang.ClassLoader resourceClassLoader)
The path of the resource file needs to be in the CLASSPATH
.
The properties file format is:
< role>.< category>.< messageCode> =text message
For example:
ERROR.TibrvComm.AESDKJ-00012=Publish Failed on subject %1
subSystem
- The name of the system of the associated resource bundle.filename
- The name of the resource bundle which is a properties file.resourceClassLoader
- Classloader to load message bundleaddMessage(String, String, String, String)
public static void addResourceBundle(java.lang.String subSystem, java.lang.String filename, java.util.Locale locale)
public static void addXMLResourceBundle(java.lang.String subSystem, java.lang.String filename)
public static java.lang.String toXMLString()