aboutsummaryrefslogtreecommitdiff
path: root/src/share/classes/com/sun/org/apache/xml/internal/security/utils/I18n.java
blob: 17346fc004ea5106112b6c6cef57157b28ed477b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/*
 * reserved comment block
 * DO NOT REMOVE OR ALTER!
 */
/*
 * Copyright  1999-2004 The Apache Software Foundation.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
package com.sun.org.apache.xml.internal.security.utils;

import java.text.MessageFormat;
import java.util.Locale;
import java.util.ResourceBundle;

/**
 * The Internationalization (I18N) pack.
 *
 * @author Christian Geuer-Pollmann
 */
public class I18n {

   /** Field NOT_INITIALIZED_MSG */
   public static final String NOT_INITIALIZED_MSG =
      "You must initialize the xml-security library correctly before you use it. "
      + "Call the static method \"com.sun.org.apache.xml.internal.security.Init.init();\" to do that "
      + "before you use any functionality from that library.";

   /** Field defaultLanguageCode */
   private static String defaultLanguageCode;    // will be set in static{} block

   /** Field defaultCountryCode */
   private static String defaultCountryCode;    // will be set in static{} block

   /** Field resourceBundle */
   private static ResourceBundle resourceBundle =
       ResourceBundle.getBundle
         (Constants.exceptionMessagesResourceBundleBase, Locale.US);

   /** Field alreadyInitialized */
   private static boolean alreadyInitialized = false;

   /** Field _languageCode */
   private static String _languageCode = null;

   /** Field _countryCode */
   private static String _countryCode = null;

   /**
    * Constructor I18n
    *
    */
   private I18n() {

      // we don't allow instantiation
   }

   /**
    * Method translate
    *
    * translates a message ID into an internationalized String, see alse
    * <CODE>XMLSecurityException.getExceptionMEssage()</CODE>. The strings are
    * stored in the <CODE>ResourceBundle</CODE>, which is identified in
    * <CODE>exceptionMessagesResourceBundleBase</CODE>
    *
    * @param message
    * @param args is an <CODE>Object[]</CODE> array of strings which are inserted into the String which is retrieved from the <CODE>ResouceBundle</CODE>
    * @return message translated
    */
   public static String translate(String message, Object[] args) {
      return getExceptionMessage(message, args);
   }

   /**
    * Method translate
    *
    * translates a message ID into an internationalized String, see alse
    * <CODE>XMLSecurityException.getExceptionMEssage()</CODE>
    *
    * @param message
    * @return message translated
    */
   public static String translate(String message) {
      return getExceptionMessage(message);
   }

   /**
    * Method getExceptionMessage
    *
    * @param msgID
    * @return message translated
    *
    */
   public static String getExceptionMessage(String msgID) {

      try {
         String s = resourceBundle.getString(msgID);

         return s;
      } catch (Throwable t) {
         if (com.sun.org.apache.xml.internal.security.Init.isInitialized()) {
            return "No message with ID \"" + msgID
                   + "\" found in resource bundle \""
                   + Constants.exceptionMessagesResourceBundleBase + "\"";
         }
         return I18n.NOT_INITIALIZED_MSG;
      }
   }

   /**
    * Method getExceptionMessage
    *
    * @param msgID
    * @param originalException
    * @return message translated
    */
   public static String getExceptionMessage(String msgID,
                                            Exception originalException) {

      try {
         Object exArgs[] = { originalException.getMessage() };
         String s = MessageFormat.format(resourceBundle.getString(msgID),
                                         exArgs);

         return s;
      } catch (Throwable t) {
         if (com.sun.org.apache.xml.internal.security.Init.isInitialized()) {
            return "No message with ID \"" + msgID
                   + "\" found in resource bundle \""
                   + Constants.exceptionMessagesResourceBundleBase
                   + "\". Original Exception was a "
                   + originalException.getClass().getName() + " and message "
                   + originalException.getMessage();
         }
          return I18n.NOT_INITIALIZED_MSG;
      }
   }

   /**
    * Method getExceptionMessage
    *
    * @param msgID
    * @param exArgs
    * @return message translated
    */
   public static String getExceptionMessage(String msgID, Object exArgs[]) {

      try {
         String s = MessageFormat.format(resourceBundle.getString(msgID),
                                         exArgs);

         return s;
      } catch (Throwable t) {
         if (com.sun.org.apache.xml.internal.security.Init.isInitialized()) {
            return "No message with ID \"" + msgID
                   + "\" found in resource bundle \""
                   + Constants.exceptionMessagesResourceBundleBase + "\"";
         }
         return I18n.NOT_INITIALIZED_MSG;
      }
   }

//
// Commented out because it modifies shared static
// state which could be maliciously called by untrusted code
//
//   /**
//    * Method init
//    *
//    * @param _defaultLanguageCode
//    * @param _defaultCountryCode
//    */
//   public static void init(String _defaultLanguageCode,
//                           String _defaultCountryCode) {
//
//      I18n.defaultLanguageCode = _defaultLanguageCode;
//
//      if (I18n.defaultLanguageCode == null) {
//         I18n.defaultLanguageCode = Locale.getDefault().getLanguage();
//      }
//
//      I18n.defaultCountryCode = _defaultCountryCode;
//
//      if (I18n.defaultCountryCode == null) {
//         I18n.defaultCountryCode = Locale.getDefault().getCountry();
//      }
//
//      initLocale(I18n.defaultLanguageCode, I18n.defaultCountryCode);
//   }

//
// Commented out because it modifies shared static
// state which could be maliciously called by untrusted code
//
//   /**
//    * Method initLocale
//    *
//    * @param languageCode
//    * @param countryCode
//    */
//   public static void initLocale(String languageCode, String countryCode) {
//
//      if (alreadyInitialized && languageCode.equals(_languageCode)
//              && countryCode.equals(_countryCode)) {
//         return;
//      }
//
//      if ((languageCode != null) && (countryCode != null)
//              && (languageCode.length() > 0) && (countryCode.length() > 0)) {
//         _languageCode = languageCode;
//         _countryCode = countryCode;
//      } else {
//         _countryCode = I18n.defaultCountryCode;
//         _languageCode = I18n.defaultLanguageCode;
//      }
//
//      I18n.resourceBundle =
//         ResourceBundle.getBundle(Constants.exceptionMessagesResourceBundleBase,
//                                  new Locale(_languageCode, _countryCode));
//   }
}