openam-agent-cache-simple

Cache using MongoDB for the OpenAM Policy Agent for NodeJS

Installation: npm install @forgerock/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

| Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | object | | Options | | [options.url] | string | "http://localhost/openam-agent" | MongoDB URL | | [options.expireAfterSeconds] | number | 60 | Expiration time in seconds | | [options.collectionName] | string | "agentcache" | MongoDB collection name |

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

| Param | Type | | --- | --- | | key | string |

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

| Param | Type | | --- | --- | | key | string | | value | * |

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

| Param | Type | | --- | --- | | key | string |

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

DISCLAIMER

The sample code described herein is provided on an "as is" basis, without warranty of any kind, to the fullest extent permitted by law. ForgeRock does not warrant or guarantee the individual success developers may have in implementing the sample code on their development platforms or in production configurations.

ForgeRock does not warrant, guarantee or make any representations regarding the use, results of use, accuracy, timeliness or completeness of any data or information relating to the sample code. ForgeRock disclaims all warranties, expressed or implied, and in particular, disclaims all warranties of merchantability, and warranties related to the code, or any service or software related thereto.

ForgeRock shall not be liable for any direct, indirect or consequential damages or costs of any type arising out of any action taken by you or others related to the sample code.