Class: Mondrian::OLAP::Connection

Inherits:
Object
  • Object
show all
Defined in:
lib/mondrian/olap/connection.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Connection

Returns a new instance of Connection.



12
13
14
15
16
17
 
# File 'lib/mondrian/olap/connection.rb', line 12

def initialize(params={})
  @params = params
  @driver = params[:driver]
  @connected = false
  @raw_connection = nil
end

Instance Attribute Details

#raw_catalog ⇒ Object (readonly)

Returns the value of attribute raw_catalog.



10
11
12
 
# File 'lib/mondrian/olap/connection.rb', line 10

def raw_catalog
  @raw_catalog
end

#raw_connection ⇒ Object (readonly)

Returns the value of attribute raw_connection.



10
11
12
 
# File 'lib/mondrian/olap/connection.rb', line 10

def raw_connection
  @raw_connection
end

#raw_schema ⇒ Object (readonly)

Returns the value of attribute raw_schema.



10
11
12
 
# File 'lib/mondrian/olap/connection.rb', line 10

def raw_schema
  @raw_schema
end

Class Method Details

.create(params) ⇒ Object 



4
5
6
7
8
 
# File 'lib/mondrian/olap/connection.rb', line 4

def self.create(params)
  connection = new(params)
  connection.connect
  connection
end

.shutdown_static_mondrian_server! ⇒ Object

Force shutdown of static MondrianServer, should not normally be used. Can be used in at_exit block if JRuby based plugin is unloaded from other Java application. WARNING: Mondrian will be unusable after calling this method!



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
 
# File 'lib/mondrian/olap/connection.rb', line 149

def self.shutdown_static_mondrian_server!
  static_mondrian_server = Java::MondrianOlap::MondrianServer.forId(nil)

  # force Mondrian to think that static_mondrian_server is not static MondrianServer
  mondrian_server_registry = Java::MondrianServer::MondrianServerRegistry::INSTANCE
  f = mondrian_server_registry.java_class.declared_field("staticServer")
  f.accessible = true
  f.set_value(mondrian_server_registry, nil)

  static_mondrian_server.shutdown

  # shut down expiring reference timer thread
  f = Java::MondrianUtil::ExpiringReference.java_class.declared_field("timer")
  f.accessible = true
  expiring_reference_timer = f.static_value.to_java
  expiring_reference_timer.cancel

  # shut down Mondrian Monitor
  cons = Java::MondrianServer.__send__(:"MonitorImpl$ShutdownCommand").java_class.declared_constructor
  cons.accessible = true
  shutdown_command = cons.new_instance.to_java

  cons = Java::MondrianServer.__send__(:"MonitorImpl$Handler").java_class.declared_constructor
  cons.accessible = true
  handler = cons.new_instance.to_java

  pair = Java::mondrian.util.Pair.new handler, shutdown_command

  f = Java::MondrianServer::MonitorImpl.java_class.declared_field("ACTOR")
  f.accessible = true
  monitor_actor = f.static_value.to_java

  f = monitor_actor.java_class.declared_field("eventQueue")
  f.accessible = true
  event_queue = f.value(monitor_actor)

  event_queue.put pair

  # shut down connection pool thread
  f = Java::mondrian.rolap.RolapConnectionPool.java_class.declared_field("instance")
  f.accessible = true
  rolap_connection_pool = f.static_value.to_java
  f = rolap_connection_pool.java_class.declared_field("mapConnectKeyToPool")
  f.accessible = true
  map_connect_key_to_pool = f.value(rolap_connection_pool)
  map_connect_key_to_pool.values.each do |pool|
    pool.close if pool && !pool.isClosed
  end

  true
end

Instance Method Details

#available_role_names ⇒ Object 



100
101
102
 
# File 'lib/mondrian/olap/connection.rb', line 100

def available_role_names
  @raw_connection.getAvailableRoleNames.to_a
end

#close ⇒ Object 



59
60
61
62
63
64
 
# File 'lib/mondrian/olap/connection.rb', line 59

def close
  @raw_connection.close
  @connected = false
  @raw_connection = @raw_jdbc_connection = nil
  true
end

#connect ⇒ Object 



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
 
# File 'lib/mondrian/olap/connection.rb', line 19

def connect
  Error.wrap_native_exception do
    # hack to call private constructor of MondrianOlap4jDriver
    # to avoid using DriverManager which fails to load JDBC drivers
    # because of not seeing JRuby required jar files
    cons = Java::MondrianOlap4j::MondrianOlap4jDriver.java_class.declared_constructor
    cons.accessible = true
    driver = cons.new_instance.to_java

    props = java.util.Properties.new
    props.setProperty('JdbcUser', @params[:username]) if @params[:username]
    props.setProperty('JdbcPassword', @params[:password]) if @params[:password]

    conn_string = connection_string

    # latest Mondrian version added ClassResolver which uses current thread class loader to load some classes
    # therefore need to set it to JRuby class loader to ensure that Mondrian classes are found
    # (e.g. when running mondrian-olap inside OSGi container)
    current_thread = Java::JavaLang::Thread.currentThread
    class_loader = current_thread.getContextClassLoader
    begin
      current_thread.setContextClassLoader JRuby.runtime.jruby_class_loader
      @raw_jdbc_connection = driver.connect(conn_string, props)
    ensure
      current_thread.setContextClassLoader(class_loader)
    end

    @raw_connection = @raw_jdbc_connection.unwrap(Java::OrgOlap4j::OlapConnection.java_class)
    @raw_catalog = @raw_connection.getOlapCatalog
    # currently it is assumed that there is just one schema per connection catalog
    @raw_schema = @raw_catalog.getSchemas.first
    @connected = true
    true
  end
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/mondrian/olap/connection.rb', line 55

def connected?
  @connected
end

#cube(name) ⇒ Object 



88
89
90
 
# File 'lib/mondrian/olap/connection.rb', line 88

def cube(name)
  Cube.get(self, name)
end

#cube_names ⇒ Object 



84
85
86
 
# File 'lib/mondrian/olap/connection.rb', line 84

def cube_names
  @raw_schema.getCubes.map{|c| c.getName}
end

#execute(query_string) ⇒ Object 



66
67
68
69
70
71
 
# File 'lib/mondrian/olap/connection.rb', line 66

def execute(query_string)
  Error.wrap_native_exception do
    statement = @raw_connection.prepareOlapStatement(query_string)
    Result.new(self, statement.executeQuery())
  end
end

#execute_drill_through(query_string) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/mondrian/olap/connection.rb', line 73

def execute_drill_through(query_string)
  Error.wrap_native_exception do
    statement = @raw_connection.createStatement
    Result::DrillThrough.new(statement.executeQuery(query_string))
  end
end

#flush_schema_cache ⇒ Object

Will affect only the next created connection. If it is necessary to clear all schema cache then flush_schema_cache should be called, then close and then new connection should be created.



94
95
96
97
98
 
# File 'lib/mondrian/olap/connection.rb', line 94

def flush_schema_cache
  unwrapped_connection = @raw_connection.unwrap(Java::MondrianOlap::Connection.java_class)
  raw_cache_control = unwrapped_connection.getCacheControl(nil)
  raw_cache_control.flushSchemaCache
end

#from(cube_name) ⇒ Object 



80
81
82
 
# File 'lib/mondrian/olap/connection.rb', line 80

def from(cube_name)
  Query.from(self, cube_name)
end

#locale ⇒ Object 



128
129
130
 
# File 'lib/mondrian/olap/connection.rb', line 128

def locale
  @raw_connection.getLocale.toString
end

#locale=(locale) ⇒ Object

Raises:

  • (ArgumentError) 


132
133
134
135
136
137
 
# File 'lib/mondrian/olap/connection.rb', line 132

def locale=(locale)
  locale_elements = locale.to_s.split('_')
  raise ArgumentError, "invalid locale string #{locale.inspect}" unless [1,2,3].include?(locale_elements.length)
  java_locale = Java::JavaUtil::Locale.new(*locale_elements)
  @raw_connection.setLocale(java_locale)
end

#mondrian_server ⇒ Object

access MondrianServer instance



140
141
142
143
144
 
# File 'lib/mondrian/olap/connection.rb', line 140

def mondrian_server
  Error.wrap_native_exception do
    @raw_connection.getMondrianConnection.getServer
  end
end

#role_name ⇒ Object 



104
105
106
 
# File 'lib/mondrian/olap/connection.rb', line 104

def role_name
  @raw_connection.getRoleName
end

#role_name=(name) ⇒ Object 



114
115
116
117
118
 
# File 'lib/mondrian/olap/connection.rb', line 114

def role_name=(name)
  Error.wrap_native_exception do
    @raw_connection.setRoleName(name)
  end
end

#role_names ⇒ Object 



108
109
110
111
112
 
# File 'lib/mondrian/olap/connection.rb', line 108

def role_names
  # workaround to access non-public method (was not public when using inside Torquebox)
  # @raw_connection.getRoleNames.to_a
  @raw_connection.java_method(:getRoleNames).call.to_a
end

#role_names=(names) ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/mondrian/olap/connection.rb', line 120

def role_names=(names)
  Error.wrap_native_exception do
    # workaround to access non-public method (was not public when using inside Torquebox)
    # @raw_connection.setRoleNames(Array(names))
    @raw_connection.java_method(:setRoleNames, [Java::JavaUtil::List.java_class]).call(Array(names))
  end
end