openam-agent-cache-mongodb v1.0.2

openam-agent-cache-simple

Cache using MongoDB for the OpenAM Policy Agent for NodeJS

Installation: npm install openam-agent-cache-mongodb

API Docs

MongoCache ⇐ Cache

Kind: global class
Extends: Cache

• MongoCache ⇐ Cache
  • new MongoCache([options])
  • .get(key) ⇒ Promise
  • .put(key, value) ⇒ Promise
  • .remove(key) ⇒ Promise
  • .close() ⇒ Promise
  • .quit() ⇒ Promise

new MongoCache(options)

Cache implementation for MongoDB

Example

var mongoCache = new MongoCache({
  url: 'mongodb://db.example.com/mydb',
  expireAfterSeconds: 600,
  collectionName: 'sessions'
});

mongoCache.get(key) ⇒ Promise

Get a single cached item If the entry is not found, reject

Kind: instance method of MongoCache

Example

mongoCache.get('foo').then(function (cached) {
  console.log(cached);
}).catch(function (err) {
  console.error(err);
});

mongoCache.put(key, value) ⇒ Promise

Store a single cached item (overwrites existing)

Kind: instance method of MongoCache

Example

mongoCache.put('foo', {bar: 'baz'}).then(function () {
  console.log('foo saved to cache');
}).catch(function (err) {
  console.error(err);
});

mongoCache.remove(key) ⇒ Promise

Remove a single cached item

Kind: instance method of MongoCache

Example

mongoCache.remove('foo').then(function () {
  console.log('foo removed from cache');
}).catch(function (err) {
  console.error(err);
});

mongoCache.close() ⇒ Promise

Closes the database connection

Kind: instance method of MongoCache
Example

mongoCache.close().then(function () {
  console.log('cache closed');
});

mongoCache.quit() ⇒ Promise

Closes the database connection

Kind: instance method of MongoCache