Java > Open Source Codes > mondrian > xmla > XmlaConstants


1 /*
2 // $Id: //open/mondrian/src/main/mondrian/xmla/XmlaConstants.java#7 $
3 // This software is subject to the terms of the Common Public License
4 // Agreement, available at the following URL:
5 // http://www.opensource.org/licenses/cpl.html.
6 // Copyright (C) 2005-2006 Julian Hyde
7 // All Rights Reserved.
8 // You must accept the terms of that agreement to use this software.
9 */
10 package mondrian.xmla;
11
12
13 /**
14  * Constants for XML/A.
15  *
16  * @author Gang Chen
17  * @version $Id: //open/mondrian/src/main/mondrian/xmla/XmlaConstants.java#7 $
18  */
19 public interface XmlaConstants {
20
21     /* SOAP 1.1 */
22     public static final String NS_SOAP_ENV_1_1 = "http://schemas.xmlsoap.org/soap/envelope/";
23     public static final String NS_SOAP_ENC_1_1 = "http://schemas.xmlsoap.org/soap/encoding/";
24
25     /* SOAP 1.2 - currently not supported */
26     public static final String NS_SOAP_ENV_1_2="http://www.w3.org/2003/05/soap-envelope";
27     public static final String NS_SOAP_ENC_1_2="http://www.w3.org/2003/05/soap-encoding";
28
29     /* Namespaces for XML */
30     public static final String NS_XSD = "http://www.w3.org/2001/XMLSchema";
31     public static final String NS_XSI = "http://www.w3.org/2001/XMLSchema-instance";
32
33     /* Namespaces for XML/A */
34     public static final String NS_XMLA = "urn:schemas-microsoft-com:xml-analysis";
35     public static final String NS_XMLA_MDDATASET = "urn:schemas-microsoft-com:xml-analysis:mddataset";
36     public static final String NS_XMLA_EMPTY = "urn:schemas-microsoft-com:xml-analysis:empty";
37     public static final String NS_XMLA_ROWSET = "urn:schemas-microsoft-com:xml-analysis:rowset";
38     public static final String NS_SQL = "urn:schemas-microsoft-com:xml-sql";
39     public static final String NS_XMLA_EX = "urn:schemas-microsoft-com:xml-analysis:exception";
40
41
42     public static final String SOAP_PREFIX = "SOAP-ENV";
43
44     /*
45      * Soap Header mustUnderstand attribute name.
46      */
47     public static final String SOAP_MUST_UNDERSTAND_ATTR = "mustUnderstand";
48
49     /*
50      * Soap XMLA Header elements and attribute names.
51      */
52     public static final String XMLA_BEGIN_SESSION = "BeginSession";
53     public static final String XMLA_SESSION = "Session";
54     public static final String XMLA_END_SESSION = "EndSession";
55     public static final String XMLA_SESSION_ID = "SessionId";
56
57
58     /*
59      * Names of context keys known by both callbacks and Mondrian code.
60      */
61     // context key for role storage
62 public static final String CONTEXT_ROLE = "role";
63     // context key for session id storage
64 public static final String CONTEXT_XMLA_SESSION_ID = "session_id";
65
66     // context key for session state storage
67 public static final String CONTEXT_XMLA_SESSION_STATE = "SessionState";
68     public static final String CONTEXT_XMLA_SESSION_STATE_BEGIN = "SessionStateBegin";
69     public static final String CONTEXT_XMLA_SESSION_STATE_WITHIN = "SessionStateWithin";
70     public static final String CONTEXT_XMLA_SESSION_STATE_END = "SessionStateEnd";
71
72
73
74
75     /* XMLA protocol constants */
76     public static final int METHOD_DISCOVER = 1;
77     public static final int METHOD_EXECUTE = 2;
78
79     /** The content type default value - shared across more than one file */
80     public static final Enumeration.Content CONTENT_DEFAULT =
81                     Enumeration.Content.SchemaData;
82
83    /*************************************************************************
84     *
85     * The following are XMLA exception fault codes used as faultcode entries
86     * in the SOAP Fault element.
87     *
88     * If Mondrian Exceptions actually used the "id" attributes found in the
89     * MondrianResource.xml file, then those would be used as the SOAP Fault
90     * detail error code values, but, alas they do not show up as part of
91     * the generated Exception Java code so, here we simply duplicate
92     * the fault code entry.
93     *
94     * Currently, SOAP 1.2 errors are not supported.
95     *
96     *************************************************************************/
97
98    /**
99     * This is the namespace used to qualify the faultcode identifier.
100     */
101     public static final String MONDRIAN_NAMESPACE = "http://mondrian.sourceforge.net";
102     public static final String FAULT_NS_PREFIX = "XA";
103
104     public static final String FAULT_ACTOR = "Mondrian";
105
106     // soap 1.1 default faultcodes
107 public static final String VERSION_MISSMATCH_FAULT_FC = "VersionMismatch";
108     public static final String MUST_UNDERSTAND_FAULT_FC = "MustUnderstand";
109     public static final String CLIENT_FAULT_FC = "Client";
110     public static final String SERVER_FAULT_FC = "Server";
111
112       //<faultcode>XA:Mondrian.XML.88BA1202</faultcode>
113 public static final String FAULT_FC_PREFIX = "Mondrian";
114     public static final String FAULT_FS_PREFIX = "The Mondrian XML: ";
115
116     /////////////////////////////////////////////////////////////////////////
117 // Unmarshall Soap Message : USM
118 /////////////////////////////////////////////////////////////////////////
119 public static final String USM_REQUEST_STATE_CODE = "00USMA01";
120     public static final String USM_REQUEST_STATE_FAULT_FS =
121             "Request input method invoked at illegal time";
122
123     public static final String USM_REQUEST_INPUT_CODE = "00USMA02";
124     public static final String USM_REQUEST_INPUT_FAULT_FS =
125             "Request input Exception occurred";
126
127     public static final String USM_DOM_FACTORY_CODE = "00USMB01";
128     public static final String USM_DOM_FACTORY_FAULT_FS =
129             "DocumentBuilder cannot be created which satisfies the configuration requested";
130
131     public static final String USM_DOM_PARSE_IO_CODE = "00USMC01";
132     public static final String USM_DOM_PARSE_IO_FAULT_FS = "DOM parse IO errors occur";
133
134     public static final String USM_DOM_PARSE_CODE = "00USMC02";
135     public static final String USM_DOM_PARSE_FAULT_FS = "DOM parse errors occur";
136
137     // unknown error while unmarshalling soap message
138 public static final String USM_UNKNOWN_CODE = "00USMU01";
139     public static final String USM_UNKNOWN_FAULT_FS =
140             "Unknown error unmarshalling soap message";
141
142     /////////////////////////////////////////////////////////////////////////
143 // Callback http header : CHH
144 /////////////////////////////////////////////////////////////////////////
145 public static final String CHH_CODE = "00CHHA01";
146     public static final String CHH_FAULT_FS =
147             "Error in Callback processHttpHeader";
148
149     public static final String CHH_AUTHORIZATION_CODE = "00CHHA02";
150     public static final String CHH_AUTHORIZATION_FAULT_FS =
151             "Error in Callback processHttpHeader Authorization";
152
153     /////////////////////////////////////////////////////////////////////////
154 // Callback Pre-Action : CPREA
155 /////////////////////////////////////////////////////////////////////////
156 public static final String CPREA_CODE = "00CPREA01";
157     public static final String CPREA_FAULT_FS =
158             "Error in Callback PreAction";
159
160 /*
161     public static final String CPREA_AUTHORIZATION_CODE = "00CPREA02";
162     public static final String CPREA_AUTHORIZATION_FAULT_FS =
163             "Error Callback PreAction Authorization";
164 */
165
166     /////////////////////////////////////////////////////////////////////////
167 // Handle Soap Header : HSH
168 /////////////////////////////////////////////////////////////////////////
169 public static final String HSH_MUST_UNDERSTAND_CODE = "00HSHA01";
170     public static final String HSH_MUST_UNDERSTAND_FAULT_FS =
171             "SOAP Header must understand element not recognized";
172
173     // This is used to signal XMLA clients supporting Soap header session ids
174 // that the client's metadata may no longer be valid.
175 public static final String HSH_BAD_SESSION_ID_CODE = "00HSHB01";
176     public static final String HSH_BAD_SESSION_ID_FAULT_FS =
177             "Bad Session Id, re-start session";
178
179     // unknown error while handle soap header
180 public static final String HSH_UNKNOWN_CODE = "00HSHU01";
181     public static final String HSH_UNKNOWN_FAULT_FS =
182             "Unknown error handle soap header";
183
184     /////////////////////////////////////////////////////////////////////////
185 // Handle Soap Body : HSB
186 /////////////////////////////////////////////////////////////////////////
187 public static final String HSB_BAD_SOAP_BODY_CODE = "00HSBA01";
188     public static final String HSB_BAD_SOAP_BODY_FAULT_FS =
189             "SOAP Body not correctly formed";
190
191     public static final String HSB_PROCESS_CODE = "00HSBB01";
192     public static final String HSB_PROCESS_FAULT_FS =
193             "XMLA SOAP Body processing error";
194
195     public static final String HSB_BAD_METHOD_CODE = "00HSBB02";
196     public static final String HSB_BAD_METHOD_FAULT_FS =
197             "XMLA SOAP bad method";
198
199     public static final String HSB_BAD_METHOD_NS_CODE = "00HSBB03";
200     public static final String HSB_BAD_METHOD_NS_FAULT_FS =
201             "XMLA SOAP bad method namespace";
202
203     public static final String HSB_BAD_REQUEST_TYPE_CODE = "00HSBB04";
204     public static final String HSB_BAD_REQUEST_TYPE_FAULT_FS =
205             "XMLA SOAP bad Discover RequestType element";
206
207     public static final String HSB_BAD_RESTRICTIONS_CODE = "00HSBB05";
208     public static final String HSB_BAD_RESTRICTIONS_FAULT_FS =
209             "XMLA SOAP bad Discover Restrictions element";
210
211     public static final String HSB_BAD_PROPERTIES_CODE = "00HSBB06";
212     public static final String HSB_BAD_PROPERTIES_FAULT_FS =
213             "XMLA SOAP bad Discover or Execute Properties element";
214
215     public static final String HSB_BAD_COMMAND_CODE = "00HSBB07";
216     public static final String HSB_BAD_COMMAND_FAULT_FS =
217             "XMLA SOAP bad Execute Command element";
218
219     public static final String HSB_BAD_RESTRICTION_LIST_CODE = "00HSBB08";
220     public static final String HSB_BAD_RESTRICTION_LIST_FAULT_FS =
221             "XMLA SOAP too many Discover RestrictionList element";
222
223     public static final String HSB_BAD_PROPERTIES_LIST_CODE = "00HSBB09";
224     public static final String HSB_BAD_PROPERTIES_LIST_FAULT_FS =
225             "XMLA SOAP bad Discover or Execute PropertyList element";
226
227     public static final String HSB_BAD_STATEMENT_CODE = "00HSBB10";
228     public static final String HSB_BAD_STATEMENT_FAULT_FS =
229             "XMLA SOAP bad Execute Statement element";
230
231     public static final String HSB_DRILLDOWN_BAD_MAXROWS_CODE = "00HSBB11";
232     public static final String HSB_DRILLDOWN_BAD_MAXROWS_FAULT_FS =
233             "XMLA SOAP Drilldown Execute Statement non-positive maxrows";
234
235     public static final String HSB_DRILLDOWN_BAD_FIRST_ROWSET_CODE = "00HSBB12";
236     public static final String HSB_DRILLDOWN_BAD_FIRST_ROWSET_FAULT_FS =
237             "XMLA SOAP Drilldown Execute Statement non-positive first rowset";
238
239     public static final String HSB_DRILLDOWN_ERROR_CODE = "00HSBB13";
240     public static final String HSB_DRILLDOWN_ERROR_FAULT_FS =
241             "XMLA SOAP Drilldown Execute Statement error";
242
243     public static final String HSB_BAD_RESTRICTION_TYPE_CODE = "00HSBB14";
244     public static final String HSB_BAD_RESTRICTION_TYPE_FAULT_FS =
245             "XMLA SOAP bad Restriction type";
246
247     public static final String HSB_BAD_RESTRICTION_VALUE_CODE = "00HSBB15";
248     public static final String HSB_BAD_RESTRICTION_VALUE_FAULT_FS =
249             "XMLA SOAP bad Restriction value type";
250
251     public static final String HSB_BAD_NON_NULLABLE_COLUMN_CODE = "00HSBB16";
252     public static final String HSB_BAD_NON_NULLABLE_COLUMN_FAULT_FS =
253             "XMLA SOAP non-nullable column";
254
255
256     public static final String HSB_CONNECTION_DATA_SOURCE_CODE = "00HSBC01";
257     public static final String HSB_CONNECTION_DATA_SOURCE_FAULT_FS =
258             "XMLA connection datasource not found";
259
260     public static final String HSB_ACCESS_DENIED_CODE = "00HSBC02";
261     public static final String HSB_ACCESS_DENIED_FAULT_FS =
262             "XMLA connection with role must be authenticated";
263
264     public static final String HSB_PARSE_QUERY_CODE = "00HSBD01";
265     public static final String HSB_PARSE_QUERY_FAULT_FS = "XMLA MDX parse failed";
266
267     public static final String HSB_EXECUTE_QUERY_CODE = "00HSBD02";
268     public static final String HSB_EXECUTE_QUERY_FAULT_FS = "XMLA MDX execute failed";
269
270     public static final String HSB_DISCOVER_FORMAT_CODE = "00HSBE01";
271     public static final String HSB_DISCOVER_FORMAT_FAULT_FS =
272             "XMLA Discover format error";
273
274     public static final String HSB_DRILL_THROUGH_FORMAT_CODE = "00HSBE02";
275     public static final String HSB_DRILL_THROUGH_FORMAT_FAULT_FS =
276             "XMLA Drill Through format error";
277
278     public static final String HSB_DISCOVER_UNPARSE_CODE = "00HSBE02";
279     public static final String HSB_DISCOVER_UNPARSE_FAULT_FS =
280             "XMLA Discover unparse results error";
281
282     public static final String HSB_EXECUTE_UNPARSE_CODE = "00HSBE03";
283     public static final String HSB_EXECUTE_UNPARSE_FAULT_FS =
284             "XMLA Execute unparse results error";
285
286     public static final String HSB_DRILL_THROUGH_NOT_ALLOWED_CODE = "00HSBF01";
287     public static final String HSB_DRILL_THROUGH_NOT_ALLOWED_FAULT_FS =
288             "XMLA Drill Through not allowed";
289
290     public static final String HSB_DRILL_THROUGH_SQL_CODE = "00HSBF02";
291     public static final String HSB_DRILL_THROUGH_SQL_FAULT_FS =
292             "XMLA Drill Through SQL error";
293
294     public static final String HSB_UNSUPPORTED_OPERATION_CODE = "00HSBG01";
295     public static final String HSB_UNSUPPORTED_OPERATION_FAULT_FS =
296             "XMLA unsupported operation";
297
298     // unknown error while handle soap body
299 public static final String HSB_UNKNOWN_CODE = "00HSBU01";
300     public static final String HSB_UNKNOWN_FAULT_FS =
301             "Unknown error handle soap body";
302
303     /////////////////////////////////////////////////////////////////////////
304 // Callback Post-Action : CPOSTA
305 /////////////////////////////////////////////////////////////////////////
306 public static final String CPOSTA_CODE = "00CPOSTA01";
307     public static final String CPOSTA_FAULT_FS =
308             "Error in Callback PostAction";
309
310     /////////////////////////////////////////////////////////////////////////
311 // Marshall Soap Message : MSM
312 /////////////////////////////////////////////////////////////////////////
313
314     // unknown error while marshalling soap message
315 public static final String MSM_UNKNOWN_CODE = "00MSMU01";
316     public static final String MSM_UNKNOWN_FAULT_FS =
317             "Unknown error marshalling soap message";
318
319     /////////////////////////////////////////////////////////////////////////
320 // Unknown error : UE
321 /////////////////////////////////////////////////////////////////////////
322 public static final String UNKNOWN_ERROR_CODE = "00UE001";
323     // While this is actually "unknown", for users "internal"
324 // is a better term
325 public static final String UNKNOWN_ERROR_FAULT_FS = "Internal Error";
326
327 }
328
329 // End XmlaConstants.java
330

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags