Module: ActiveLdap::Connection

Defined in:
lib/active_ldap/connection.rb

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



3
4
5
 
# File 'lib/active_ldap/connection.rb', line 3

def self.included(base)
  base.extend(ClassMethods)
end

Instance Method Details

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


263
264
265
 
# File 'lib/active_ldap/connection.rb', line 263

def connected?
  connection != self.class.connection
end

#connection ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/active_ldap/connection.rb', line 248

def connection
  conn = @connection
  return conn if conn

  have_dn = !@dn.nil?
  if !have_dn and attribute_name_resolvable_without_connection?
    begin
      have_dn = !get_attribute_before_type_cast(dn_attribute)[1].nil?
    rescue DistinguishedNameInvalid
    end
  end
  conn = self.class.active_connections[dn] || retrieve_connection if have_dn
  conn || self.class.connection
end

#connection=(adapter) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/active_ldap/connection.rb', line 267

def connection=(adapter)
  if adapter.nil? or adapter.is_a?(Adapter::Base)
    @connection = adapter
  elsif adapter.is_a?(Hash)
    config = adapter
    @connection = self.class.instantiate_adapter(config)
  else
    setup_connection(adapter)
  end
end

#establish_connection(config = nil) ⇒ Object 



234
235
236
237
238
239
240
241
 
# File 'lib/active_ldap/connection.rb', line 234

def establish_connection(config=nil)
  message =
    _("ActiveLdap::Connection#establish_connection has been deprecated " \
      "since 1.1.0. " \
      "Please use ActiveLdap::Connection#setup_connection instead.")
  ActiveSupport::Deprecation.warn(message)
  setup_connection(config)
end

#remove_connection ⇒ Object 



243
244
245
246
 
# File 'lib/active_ldap/connection.rb', line 243

def remove_connection
  self.class.remove_connection(dn)
  @connection = nil
end

#retrieve_connection ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/active_ldap/connection.rb', line 278

def retrieve_connection
  conn = self.class.active_connections[dn]
  return conn if conn

  config = self.class.configuration(dn)
  return nil unless config

  conn = self.class.instantiate_adapter(config)
  @connection = self.class.active_connections[dn] = conn
  conn
end

#schema ⇒ Object 



290
291
292
 
# File 'lib/active_ldap/connection.rb', line 290

def schema
  connection.schema
end

#setup_connection(config = nil) ⇒ Object 



225
226
227
228
229
230
231
232
 
# File 'lib/active_ldap/connection.rb', line 225

def setup_connection(config=nil)
  config = self.class.ensure_configuration(config)
  config = self.class.configuration.merge(config)
  config = self.class.merge_configuration(config, self)

  remove_connection
  self.class.define_configuration(dn, config)
end