@forgerock/openam-agent-cache

openam-agent-cache

Abstract cache for the OpenAM Policy Agent for NodeJS

Implement this class to use your own cache with any backed with the node-openam-policy-agent

API Docs

Cache

Kind: global abstract class

• Cache
  • new Cache()
  • .get(key) ⇒ Promise
  • .put(key, value) ⇒ Promise
  • .remove(key) ⇒ Promise
  • .quit() ⇒ Promise

new Cache()

Abstract Cache class

cache.get(key) ⇒ Promise

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

Kind: instance method of Cache

Param	Type
key	string

cache.put(key, value) ⇒ Promise

Store a single cached item (overwrites existing)

Kind: instance method of Cache

Param	Type
key	string
value	*

cache.remove(key) ⇒ Promise

Remove a single cached item

Kind: instance method of Cache

Param	Type
key	string

cache.quit() ⇒ Promise

Closes the client connection

Kind: instance method of Cache

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.