class Comet::MongoDBConnection

MongoDBConnection is a typed class wrapper around the underlying Comet Server API data structure.

def clear

def clear
  @server = ''
  @port = 0
  @username = ''
  @password = ''
  @authentication_db = ''
  @mongo_shell_path = ''
  @mongodump_path = ''
  @read_preference = ''
  @replica_name = ''
  @replica_members = []
  @client_sslpempath = ''
  @server_sslpempath = ''
  @sslclient_key_password = ''
  @sshconnection = Comet::SSHConnection.new
  @unknown_json_fields = {}
end

def from_hash(obj)

Parameters:
  • obj (Hash) -- The complete object as a Ruby hash
def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash
  obj.each do |k, v|
    case k
    when 'Server'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @server = v
    when 'Port'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
      @port = v
    when 'Username'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @username = v
    when 'Password'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @password = v
    when 'AuthenticationDB'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @authentication_db = v
    when 'MongoShellPath'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @mongo_shell_path = v
    when 'MongodumpPath'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @mongodump_path = v
    when 'ReadPreference'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @read_preference = v
    when 'UseReplica'
      @use_replica = v
    when 'ReplicaName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @replica_name = v
    when 'ReplicaMembers'
      if v.nil?
        @replica_members = []
      else
        @replica_members = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String
          @replica_members[i1] = v1
        end
      end
    when 'UseSSL'
      @use_ssl = v
    when 'ClientSSLPEMPath'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @client_sslpempath = v
    when 'ServerSSLPEMPath'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @server_sslpempath = v
    when 'SSLClientKeyPassword'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
      @sslclient_key_password = v
    when 'AllowInvalidCertificate'
      @allow_invalid_certificate = v
    when 'AllowInvalidHostname'
      @allow_invalid_hostname = v
    when 'UseSSH'
      @use_ssh = v
    when 'SSHConnection'
      @sshconnection = Comet::SSHConnection.new
      @sshconnection.from_hash(v)
    else
      @unknown_json_fields[k] = v
    end
  end
end

def from_json(json_string)

Parameters:
  • json_string (String) -- The complete object in JSON format
def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String
  from_hash(JSON.parse(json_string))
end

def initialize

def initialize
  clear
end

def to_h

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_h
  to_hash
end

def to_hash

Returns:
  • (Hash) - The complete object as a Ruby hash
def to_hash
  ret = {}
  ret['Server'] = @server
  ret['Port'] = @port
  ret['Username'] = @username
  ret['Password'] = @password
  ret['AuthenticationDB'] = @authentication_db
  ret['MongoShellPath'] = @mongo_shell_path
  ret['MongodumpPath'] = @mongodump_path
  ret['ReadPreference'] = @read_preference
  ret['UseReplica'] = @use_replica
  ret['ReplicaName'] = @replica_name
  ret['ReplicaMembers'] = @replica_members
  ret['UseSSL'] = @use_ssl
  ret['ClientSSLPEMPath'] = @client_sslpempath
  ret['ServerSSLPEMPath'] = @server_sslpempath
  ret['SSLClientKeyPassword'] = @sslclient_key_password
  ret['AllowInvalidCertificate'] = @allow_invalid_certificate
  ret['AllowInvalidHostname'] = @allow_invalid_hostname
  ret['UseSSH'] = @use_ssh
  unless @sshconnection.nil?
    ret['SSHConnection'] = @sshconnection
  end
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

def to_json(options = {})

Returns:
  • (String) - The complete object as a JSON string
def to_json(options = {})
  to_hash.to_json(options)
end