XmlaHandler (Pentaho Community Edition Project: mondrian 9.2.0.0-288 API)

java.lang.Object
- mondrian.xmla.XmlaHandler

```
public class XmlaHandler
extends Object
```
An XmlaHandler responds to XML for Analysis (XML/A) requests.

Since:

27 April, 2003

Author:

jhyde, Gang Chen

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`XmlaHandler.ConnectionFactory` Creates an olap4j connection for responding to XMLA requests.
`static interface`	`XmlaHandler.XmlaExtra` Extra support for XMLA server.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JDBC_LOCALE` Name of property used by JDBC to hold locale.
`static String`	`XSD_BOOLEAN`
`static String`	`XSD_BYTE`
`static byte`	`XSD_BYTE_MAX_INCLUSIVE`
`static byte`	`XSD_BYTE_MIN_INCLUSIVE`
`static String`	`XSD_DECIMAL`
`static String`	`XSD_DOUBLE`
`static String`	`XSD_FLOAT`
`static String`	`XSD_INT`
`static int`	`XSD_INT_MAX_INCLUSIVE`
`static int`	`XSD_INT_MIN_INCLUSIVE`
`static String`	`XSD_INTEGER`
`static String`	`XSD_LONG`
`static long`	`XSD_LONG_MAX_INCLUSIVE`
`static long`	`XSD_LONG_MIN_INCLUSIVE`
`static String`	`XSD_SHORT`
`static short`	`XSD_SHORT_MAX_INCLUSIVE`
`static short`	`XSD_SHORT_MIN_INCLUSIVE`
`static String`	`XSD_STRING`
`static String`	`XSD_UNSIGNED_INT`

Constructor Summary

Constructors
Constructor and Description

XmlaHandler(XmlaHandler.ConnectionFactory connectionFactory, String prefix)
Creates an XmlaHandler.

Constructors
Constructor and Description
`XmlaHandler(XmlaHandler.ConnectionFactory connectionFactory, String prefix)` Creates an `XmlaHandler`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.olap4j.OlapConnection`	`getConnection(String catalog, String schema, String role)` Gets a Connection given a catalog (and implicitly the catalog's data source) and the name of a user role.
`protected org.olap4j.OlapConnection`	`getConnection(String catalog, String schema, String role, Properties props)` Gets a Connection given a catalog (and implicitly the catalog's data source) and the name of a user role.
`org.olap4j.OlapConnection`	`getConnection(XmlaRequest request, Map<String,String> propMap)` Returns a new OlapConnection opened with the credentials specified in the XMLA request or an existing connection if one can be found associated with the request session id.
`static XmlaHandler.XmlaExtra`	`getExtra(org.olap4j.OlapConnection connection)`
`static boolean`	`isValidXsdInt(long l)`
`void`	`process(XmlaRequest request, XmlaResponse response)` Processes a request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JDBC_LOCALE
```
public static final String JDBC_LOCALE
```
    Name of property used by JDBC to hold locale. It is not hard-wired into DriverManager like "user" and "password", but we do expect any olap4j driver that supports i18n to use this property name.
    
    See Also:
    
    Constant Field Values
  - XSD_BOOLEAN
```
public static final String XSD_BOOLEAN
```
    See Also:
    
    Constant Field Values
  - XSD_STRING
```
public static final String XSD_STRING
```
    See Also:
    
    Constant Field Values
  - XSD_UNSIGNED_INT
```
public static final String XSD_UNSIGNED_INT
```
    See Also:
    
    Constant Field Values
  - XSD_BYTE
```
public static final String XSD_BYTE
```
    See Also:
    
    Constant Field Values
  - XSD_BYTE_MAX_INCLUSIVE
```
public static final byte XSD_BYTE_MAX_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - XSD_BYTE_MIN_INCLUSIVE
```
public static final byte XSD_BYTE_MIN_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - XSD_SHORT
```
public static final String XSD_SHORT
```
    See Also:
    
    Constant Field Values
  - XSD_SHORT_MAX_INCLUSIVE
```
public static final short XSD_SHORT_MAX_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - XSD_SHORT_MIN_INCLUSIVE
```
public static final short XSD_SHORT_MIN_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - XSD_INT
```
public static final String XSD_INT
```
    See Also:
    
    Constant Field Values
  - XSD_INT_MAX_INCLUSIVE
```
public static final int XSD_INT_MAX_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - XSD_INT_MIN_INCLUSIVE
```
public static final int XSD_INT_MIN_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - XSD_LONG
```
public static final String XSD_LONG
```
    See Also:
    
    Constant Field Values
  - XSD_LONG_MAX_INCLUSIVE
```
public static final long XSD_LONG_MAX_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - XSD_LONG_MIN_INCLUSIVE
```
public static final long XSD_LONG_MIN_INCLUSIVE
```
    See Also:
    
    Constant Field Values
  - XSD_DOUBLE
```
public static final String XSD_DOUBLE
```
    See Also:
    
    Constant Field Values
  - XSD_FLOAT
```
public static final String XSD_FLOAT
```
    See Also:
    
    Constant Field Values
  - XSD_DECIMAL
```
public static final String XSD_DECIMAL
```
    See Also:
    
    Constant Field Values
  - XSD_INTEGER
```
public static final String XSD_INTEGER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XmlaHandler
```
public XmlaHandler(XmlaHandler.ConnectionFactory connectionFactory,
                   String prefix)
```
    Creates an XmlaHandler.
    The connection factory may be null, as long as you override getConnection(String, String, String, Properties).
    
    Parameters:
    
    connectionFactory - Connection factory
    
    prefix - XML Namespace. Typical value is "xmla", but a value of "cxmla" works around an Internet Explorer 7 bug
- Method Detail
  - getExtra
```
public static XmlaHandler.XmlaExtra getExtra(org.olap4j.OlapConnection connection)
```
  - getConnection
```
public org.olap4j.OlapConnection getConnection(XmlaRequest request,
                                               Map<String,String> propMap)
```
    Returns a new OlapConnection opened with the credentials specified in the XMLA request or an existing connection if one can be found associated with the request session id.
    
    Parameters:
    
    request - Request
    
    propMap - Extra properties
  - isValidXsdInt
```
public static boolean isValidXsdInt(long l)
```
  - process
```
public void process(XmlaRequest request,
                    XmlaResponse response)
             throws XmlaException
```
    Processes a request.
    
    Parameters:
    
    request - XML request, for example, "".
    
    response - Destination for response
    
    Throws:
    
    XmlaException - on error
  - getConnection
```
protected org.olap4j.OlapConnection getConnection(String catalog,
                                                  String schema,
                                                  String role)
                                           throws XmlaException
```
    Gets a Connection given a catalog (and implicitly the catalog's data source) and the name of a user role.
    If you want to pass in a role object, and you are making the call within the same JVM (i.e. not RPC), register the role using MondrianServer.getLockBox() and pass in the moniker for the generated lock box entry. The server will retrieve the role from the moniker.
    
    Parameters:
    
    catalog - Catalog name
    
    schema - Schema name
    
    role - User role name
    
    Returns:
    
    Connection
    
    Throws:
    
    XmlaException - If error occurs
  - getConnection
```
protected org.olap4j.OlapConnection getConnection(String catalog,
                                                  String schema,
                                                  String role,
                                                  Properties props)
                                           throws XmlaException
```
    Gets a Connection given a catalog (and implicitly the catalog's data source) and the name of a user role.
    If you want to pass in a role object, and you are making the call within the same JVM (i.e. not RPC), register the role using MondrianServer.getLockBox() and pass in the moniker for the generated lock box entry. The server will retrieve the role from the moniker.
    
    Parameters:
    
    catalog - Catalog name
    
    schema - Schema name
    
    role - User role name
    
    props - Properties to pass down to the native driver.
    
    Returns:
    
    Connection
    
    Throws:
    
    XmlaException - If error occurs

Class XmlaHandler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JDBC_LOCALE

XSD_BOOLEAN

XSD_STRING

XSD_UNSIGNED_INT

XSD_BYTE

XSD_BYTE_MAX_INCLUSIVE

XSD_BYTE_MIN_INCLUSIVE

XSD_SHORT

XSD_SHORT_MAX_INCLUSIVE

XSD_SHORT_MIN_INCLUSIVE

XSD_INT

XSD_INT_MAX_INCLUSIVE

XSD_INT_MIN_INCLUSIVE

XSD_LONG

XSD_LONG_MAX_INCLUSIVE

XSD_LONG_MIN_INCLUSIVE

XSD_DOUBLE

XSD_FLOAT

XSD_DECIMAL

XSD_INTEGER

Constructor Detail

XmlaHandler

Method Detail

getExtra

getConnection

isValidXsdInt

process

getConnection

getConnection