Package mondrian.xmla.impl

Class DefaultXmlaRequest

java.lang.Object

mondrian.xmla.impl.DefaultXmlaRequest

All Implemented Interfaces:

XmlaConstants, XmlaRequest

public class DefaultXmlaRequest
extends Object
implements XmlaRequest, XmlaConstants

Default implementation of XmlaRequest by DOM API.

Author:

Gang Chen

Field Summary

Fields inherited from interface mondrian.xmla.XmlaConstants

CHH_AUTHORIZATION_CODE, CHH_AUTHORIZATION_FAULT_FS, CHH_CODE, CHH_FAULT_FS, CLIENT_FAULT_FC, CONTEXT_MIME_TYPE, CONTEXT_ROLE_NAME, CONTEXT_XMLA_PASSWORD, CONTEXT_XMLA_SESSION_ID, CONTEXT_XMLA_SESSION_STATE, CONTEXT_XMLA_SESSION_STATE_BEGIN, CONTEXT_XMLA_SESSION_STATE_END, CONTEXT_XMLA_SESSION_STATE_WITHIN, CONTEXT_XMLA_USERNAME, CPOSTA_CODE, CPOSTA_FAULT_FS, CPREA_CODE, CPREA_FAULT_FS, FAULT_ACTOR, FAULT_FC_PREFIX, FAULT_FS_PREFIX, FAULT_NS_PREFIX, HSB_ACCESS_DENIED_CODE, HSB_ACCESS_DENIED_FAULT_FS, HSB_BAD_COMMAND_CODE, HSB_BAD_COMMAND_FAULT_FS, HSB_BAD_METHOD_CODE, HSB_BAD_METHOD_FAULT_FS, HSB_BAD_METHOD_NS_CODE, HSB_BAD_METHOD_NS_FAULT_FS, HSB_BAD_NON_NULLABLE_COLUMN_CODE, HSB_BAD_NON_NULLABLE_COLUMN_FAULT_FS, HSB_BAD_PROPERTIES_CODE, HSB_BAD_PROPERTIES_FAULT_FS, HSB_BAD_PROPERTIES_LIST_CODE, HSB_BAD_PROPERTIES_LIST_FAULT_FS, HSB_BAD_REQUEST_TYPE_CODE, HSB_BAD_REQUEST_TYPE_FAULT_FS, HSB_BAD_RESTRICTION_LIST_CODE, HSB_BAD_RESTRICTION_LIST_FAULT_FS, HSB_BAD_RESTRICTIONS_CODE, HSB_BAD_RESTRICTIONS_FAULT_FS, HSB_BAD_SOAP_BODY_CODE, HSB_BAD_SOAP_BODY_FAULT_FS, HSB_BAD_STATEMENT_CODE, HSB_BAD_STATEMENT_FAULT_FS, HSB_CONNECTION_DATA_SOURCE_CODE, HSB_CONNECTION_DATA_SOURCE_FAULT_FS, HSB_DISCOVER_FORMAT_CODE, HSB_DISCOVER_FORMAT_FAULT_FS, HSB_DISCOVER_UNPARSE_CODE, HSB_DISCOVER_UNPARSE_FAULT_FS, HSB_DRILL_THROUGH_FORMAT_CODE, HSB_DRILL_THROUGH_FORMAT_FAULT_FS, HSB_DRILL_THROUGH_NOT_ALLOWED_CODE, HSB_DRILL_THROUGH_NOT_ALLOWED_FAULT_FS, HSB_DRILL_THROUGH_SQL_CODE, HSB_DRILL_THROUGH_SQL_FAULT_FS, HSB_EXECUTE_QUERY_CODE, HSB_EXECUTE_QUERY_FAULT_FS, HSB_EXECUTE_UNPARSE_CODE, HSB_EXECUTE_UNPARSE_FAULT_FS, HSB_PARSE_QUERY_CODE, HSB_PARSE_QUERY_FAULT_FS, HSB_PROCESS_CODE, HSB_PROCESS_FAULT_FS, HSB_UNKNOWN_CODE, HSB_UNKNOWN_FAULT_FS, HSH_BAD_SESSION_ID_CODE, HSH_BAD_SESSION_ID_FAULT_FS, HSH_MUST_UNDERSTAND_CODE, HSH_MUST_UNDERSTAND_FAULT_FS, HSH_UNKNOWN_CODE, HSH_UNKNOWN_FAULT_FS, MONDRIAN_NAMESPACE, MSM_UNKNOWN_CODE, MSM_UNKNOWN_FAULT_FS, MUST_UNDERSTAND_FAULT_FC, NS_SOAP_ENC_1_1, NS_SOAP_ENC_1_2, NS_SOAP_ENV_1_1, NS_SOAP_ENV_1_2, NS_SOAP_SECEXT, NS_SQL, NS_XMLA, NS_XMLA_EMPTY, NS_XMLA_EX, NS_XMLA_MDDATASET, NS_XMLA_ROWSET, NS_XSD, NS_XSI, SERVER_FAULT_FC, SIE_REQUEST_STATE_CODE, SIE_REQUEST_STATE_FAULT_FS, SOAP_MUST_UNDERSTAND_ATTR, SOAP_PREFIX, UNKNOWN_ERROR_CODE, UNKNOWN_ERROR_FAULT_FS, USM_DOM_FACTORY_CODE, USM_DOM_FACTORY_FAULT_FS, USM_DOM_PARSE_CODE, USM_DOM_PARSE_FAULT_FS, USM_DOM_PARSE_IO_CODE, USM_DOM_PARSE_IO_FAULT_FS, USM_REQUEST_INPUT_CODE, USM_REQUEST_INPUT_FAULT_FS, USM_REQUEST_STATE_CODE, USM_REQUEST_STATE_FAULT_FS, USM_UNKNOWN_CODE, USM_UNKNOWN_FAULT_FS, VERSION_MISSMATCH_FAULT_FC, XMLA_BEGIN_SESSION, XMLA_END_SESSION, XMLA_SECURITY, XMLA_SESSION, XMLA_SESSION_ID

Constructor Summary

Constructors

Constructor	Description
DefaultXmlaRequest(Element xmlaRoot, String roleName, String username, String password, String sessionId)

Method Summary

Modifier and Type	Method	Description
String	getAuthenticatedUser()
String[]	getAuthenticatedUserGroups()
String	getCommand()
org.olap4j.metadata.XmlaConstants.Method	getMethod()	Indicate DISCOVER or EXECUTE method.
Map<String,String>	getParameters()
String	getPassword()	The password to use to open the underlying olap4j connection.
Map<String,String>	getProperties()	Properties of XML/A request.
String	getRequestType()	Request type of DISCOVER method.
Map<String,Object>	getRestrictions()	Restrictions of DISCOVER method.
String	getRoleName()	Role name binds with this XML/A request.
String	getSessionId()	Returns the id of the session this request belongs to.
String	getStatement()	Statement of EXECUTE method.
String	getUsername()	The username to use to open the underlying olap4j connection.
protected final void	init(Element xmlaRoot)
boolean	isDrillThrough()	Indicate whether statement is a drill through statement of EXECUTE method.
void	setAuthenticatedUser(String authenticatedUser)
void	setAuthenticatedUserGroups(String[] authenticatedUserGroups)
void	setProperty(String key, String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultXmlaRequest

public DefaultXmlaRequest(Element xmlaRoot,
 String roleName,
 String username,
 String password,
 String sessionId)
                   throws XmlaException

Throws:

XmlaException

Method Details

getSessionId

public String getSessionId()

Description copied from interface: XmlaRequest

Returns the id of the session this request belongs to.

Not necessarily the same as the HTTP session: the SOAP request contains its own session information.

The session id is used to retrieve existing olap connections. And username / password only need to be passed on the first request in a session.

Specified by:

getSessionId in interface XmlaRequest

Returns:

Id of the session

getUsername

public String getUsername()

Description copied from interface: XmlaRequest

The username to use to open the underlying olap4j connection. Can be null.

Specified by:

getUsername in interface XmlaRequest

getPassword

public String getPassword()

Description copied from interface: XmlaRequest

The password to use to open the underlying olap4j connection. Can be null.

Specified by:

getPassword in interface XmlaRequest

getMethod

public org.olap4j.metadata.XmlaConstants.Method getMethod()

Description copied from interface: XmlaRequest

Indicate DISCOVER or EXECUTE method.

Specified by:

getMethod in interface XmlaRequest

getProperties

public Map<String,String> getProperties()

Description copied from interface: XmlaRequest

Properties of XML/A request.

Specified by:

getProperties in interface XmlaRequest

getParameters

public Map<String,String> getParameters()

getRestrictions

public Map<String,Object> getRestrictions()

Description copied from interface: XmlaRequest

Restrictions of DISCOVER method.

If the value is a list of strings, the restriction passes if the column has one of the values.

Specified by:

getRestrictions in interface XmlaRequest

getStatement

public String getStatement()

Description copied from interface: XmlaRequest

Statement of EXECUTE method.

Specified by:

getStatement in interface XmlaRequest

getRoleName

public String getRoleName()

Description copied from interface: XmlaRequest

Role name binds with this XML/A request. Maybe null.

Specified by:

getRoleName in interface XmlaRequest

getCommand

public String getCommand()

getRequestType

public String getRequestType()

Description copied from interface: XmlaRequest

Request type of DISCOVER method.

Specified by:

getRequestType in interface XmlaRequest

isDrillThrough

public boolean isDrillThrough()

Description copied from interface: XmlaRequest

Indicate whether statement is a drill through statement of EXECUTE method.

Specified by:

isDrillThrough in interface XmlaRequest

init

protected final void init(Element xmlaRoot)
                   throws XmlaException

Throws:

XmlaException

setProperty

public void setProperty(String key,
 String value)

setAuthenticatedUser

public void setAuthenticatedUser(String authenticatedUser)

getAuthenticatedUser

public String getAuthenticatedUser()

Specified by:

getAuthenticatedUser in interface XmlaRequest

setAuthenticatedUserGroups

public void setAuthenticatedUserGroups(String[] authenticatedUserGroups)

getAuthenticatedUserGroups

public String[] getAuthenticatedUserGroups()

Specified by:

getAuthenticatedUserGroups in interface XmlaRequest