coldbox.system.web.services

Class RequestService

lucee.Component
    extended by coldbox.system.web.services.BaseService
      extended by coldbox.system.web.services.RequestService

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- This service takes care of preparing and creating request contexts. Facades to FORM and URL

Class Attributes:
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  
    Constructor Summary
    init(any controller)
          Constructor.
    Method Summary
    RequestService buildFlashScope()
         Build's the Flash RAM Scope as defined in the application spec.
    boolean contextExists()
         Does the request context exist in request scope.
    any createContext([string classPath='coldbox.system.web.context.RequestContext'])
         Creates a new request context object.
    RequestService eventCachingTest(any context, [boolean fwCache='false'])
         Tests if the incoming context is an event cache.
    any getContext([string classPath='coldbox.system.web.context.RequestContext'])
         Get the Request context from request scope or create a new one.
    any getFlashScope()
         Does the request context exist in request scope.
    any onConfigurationLoad()
         Once configuration loads.
    RequestService rebuildFlashScope()
         Rebuild's the Flash RAM Scope if the application spec has changed, else it ignores it.
    RequestService removeContext()
         Remove the context from scope.
    any requestCapture()
         I capture an incoming request.
    RequestService setContext(any context)
         Set the request context into the request scope.
     
    Methods inherited from class coldbox.system.web.services.BaseService
    getController, onShutdown, setController
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any controller)

    Constructor

    Parameters:
    controller
    Method Detail

    buildFlashScope

    public RequestService buildFlashScope()

    Build's the Flash RAM Scope as defined in the application spec.

    contextExists

    public boolean contextExists()

    Does the request context exist in request scope

    createContext

    public any createContext([string classPath='coldbox.system.web.context.RequestContext'])

    Creates a new request context object

    Parameters:
    classPath
    Returns:
    coldbox.system.web.context.RequestContext

    eventCachingTest

    public RequestService eventCachingTest(any context, [boolean fwCache='false'])

    Tests if the incoming context is an event cache

    Parameters:
    context - The request context to test for event caching
    fwCache - Flag to hard purge the cache if needed

    getContext

    public any getContext([string classPath='coldbox.system.web.context.RequestContext'])

    Get the Request context from request scope or create a new one.

    Parameters:
    classPath
    Returns:
    coldbox.system.web.context.RequestContext

    getFlashScope

    public any getFlashScope()

    Does the request context exist in request scope

    onConfigurationLoad

    public any onConfigurationLoad()

    Once configuration loads

    Overrides:
    onConfigurationLoad in class BaseService

    rebuildFlashScope

    public RequestService rebuildFlashScope()

    Rebuild's the Flash RAM Scope if the application spec has changed, else it ignores it

    removeContext

    public RequestService removeContext()

    Remove the context from scope

    requestCapture

    public any requestCapture()

    I capture an incoming request. Returns: coldbox.system.web.context.RequestContext

    Returns:
    coldbox.system.web.context.RequestContext

    setContext

    public RequestService setContext(any context)

    Set the request context into the request scope

    Parameters:
    context - Request Context object