coldbox.system.cache.util

Class EventURLFacade

railo-context.Component
        extended by coldbox.system.cache.util.EventURLFacade
Class Attributes:
  • output : false
  •  
  • synchronized : false
  •  
  • accessors : false
  •  
  • persistent : false
  •  

    This object acts as an url/form facade for CacheBox event caching

    Constructor Summary
    init(any<IColdboxApplicationCache> cacheProvider)
          Constructor.
    Method Summary
    any buildBasicCacheKey(any keySuffix, any targetEvent)
         Builds a basic cache key.
    any buildEventKey(any keySuffix, any targetEvent, any targetContext)
         Build an event key according to passed in params.
    any buildEventKeyNoContext(any keySuffix, any targetEvent, any targetArgs)
         Build an event key according to passed in params and no Context.
    any buildHash(any args)
         build a unique hash according to event and args.
    any getUniqueHash(any event)
         Get's the unique incoming URL hash.
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init(any<IColdboxApplicationCache> cacheProvider)

    Constructor

    Parameters:
    cacheProvider - The cache provider/manager this utility will be associated with as type: coldbox.system.cache.IColdboxApplicationCache

    Method Detail

    buildBasicCacheKey

    public any buildBasicCacheKey(any keySuffix, any targetEvent)

    Builds a basic cache key

    Parameters:
    keySuffix - A handler key suffix if used.
    targetEvent - The target event string

    buildEventKey

    public any buildEventKey(any keySuffix, any targetEvent, any targetContext)

    Build an event key according to passed in params

    Parameters:
    keySuffix - A handler key suffix if used.
    targetEvent - The target event string
    targetContext - The target event context to test.

    buildEventKeyNoContext

    public any buildEventKeyNoContext(any keySuffix, any targetEvent, any targetArgs)

    Build an event key according to passed in params and no Context

    Parameters:
    keySuffix - A handler key suffix if used.
    targetEvent - The target event string
    targetArgs - The string of args to incorporate into the hash

    buildHash

    public any buildHash(any args)

    build a unique hash according to event and args

    Parameters:
    args - The string of args to incorporate into the hash

    getUniqueHash

    public any getUniqueHash(any event)

    Get's the unique incoming URL hash

    Parameters:
    event - The event request context to incorporate into the hash