public abstract class

MongoHQConnector

extends Object
java.lang.Object
   ↳ org.mule.modules.mongohq.MongoHQConnector
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This connector provides functionality to connect with MongoHQ a mongoDB hosting provider.

{@sample.config INCLUDE_ERROR}

Summary

Constants
int TIMEOUT Connection timeout
Fields
private String apiKey API Key
Public Constructors
MongoHQConnector()
Public Methods
abstract void createDatabase(DatabaseRequest databaseRequest)
Create Database

abstract void deleteDatabase(String dbName)
Delete a database

String getApiKey()
abstract List<Database> listDatabases()
List Databases

abstract Database retrieveDatabaseInfo(String dbName)
Retrieve information about a particular database

void setApiKey(String apiKey)
static String transformDatabaseRequestToJson(DatabaseRequest databaseRequest)
Transform DatabaseRequest to JSON

static Database transformJsonToDatabase(String json)
Transform JSON to database

static List<Database> transformJsonToDatabases(String json)
Transform JSON to a list of databases

Protected Methods
static <T> List<T> genericJsonToListTransformer(String json)
[Expand]
Inherited Methods
From class java.lang.Object

Constants

private static final int TIMEOUT

Connection timeout

Constant Value: 7200 (0x00001c20)

Fields

private String apiKey

API Key

Public Constructors

public MongoHQConnector ()

Public Methods

public abstract void createDatabase (DatabaseRequest databaseRequest)

Create Database

Parameters
databaseRequest Data required to create a database (name and slug of the plan)
Returns
  • The status of the operation
Throws
IOException if the connection fails

public abstract void deleteDatabase (String dbName)

Delete a database

Parameters
dbName Name of the database to remove
Returns
  • The status of the operation
Throws
IOException if the connection fails

public String getApiKey ()

public abstract List<Database> listDatabases ()

List Databases

Returns
  • The list of the user databases
Throws
IOException if the connection fails

public abstract Database retrieveDatabaseInfo (String dbName)

Retrieve information about a particular database

Parameters
dbName Name of the database to retrieve
Returns
  • The database data
Throws
IOException if the connection fails

public void setApiKey (String apiKey)

Parameters
apiKey

public static String transformDatabaseRequestToJson (DatabaseRequest databaseRequest)

Transform DatabaseRequest to JSON

Parameters
databaseRequest Request to create a JSON database (name and slug)
Returns
  • string JSON representation of the request
Throws
IOException if the connection fails

public static Database transformJsonToDatabase (String json)

Transform JSON to database

Parameters
json JSON string to transform
Returns
Throws
IOException if the connection fails

public static List<Database> transformJsonToDatabases (String json)

Transform JSON to a list of databases

Parameters
json JSON string to transform
Returns
Throws
IOException if the connection fails

Protected Methods

protected static List<T> genericJsonToListTransformer (String json)

Parameters
json
Throws
IOException