ColdBox Platform v3.8.0

coldbox.system.web.services
Class RequestService

WEB-INF.cftags.component
        extended by coldbox.system.web.services.BaseService
            extended by coldbox.system.web.services.RequestService
Direct Known Subclasses:
MockRequestService

public class RequestService
extends BaseService

This service takes care of preparing and creating request contexts. Facades to FORM and URL

Constructor Summary
init(any controller)
          Constructor
 
Method Summary
 any buildFlashScope()
          Build's the Flash RAM Scope as defined in the application spec
 boolean contextExists()
          Does the request context exist
private any createContext()
          Creates a new request context object
 void eventCachingTest(any<RequestContext> context, [any<boolean> fwCache='false'])
          Tests if the incoming context is an event cache
 any getContext()
          Get the Request context from request scope or create a new one
 any getFlashScope()
          Get the current running Flash Ram Scope of base type:coldbox
 void onConfigurationLoad()
 any removeContext()
          Remove the context from scope and return yourself
 any<RequestContext> requestCapture()
          I capture an incoming request
 any setContext(any context)
          Set the Request context
 
Methods inherited from class coldbox.system.web.services.BaseService
convertToColdBox, getColdboxOCM, getController, getUtil, isFamilyType, onShutdown, setController
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init(any controller)
Constructor

Parameters:
controller - Coldbox controller
Method Detail

buildFlashScope

public any buildFlashScope()
Build's the Flash RAM Scope as defined in the application spec.


contextExists

public boolean contextExists()
Does the request context exist


createContext

private any createContext()
Creates a new request context object


eventCachingTest

public void eventCachingTest(any<RequestContext> context, [any<boolean> fwCache='false'])
Tests if the incoming context is an event cache

Parameters:
context - The request context to test for event caching.
fwCache - If the fwCache command was detected

getContext

public any getContext()
Get the Request context from request scope or create a new one.


getFlashScope

public any getFlashScope()
Get the current running Flash Ram Scope of base type:coldbox.system.web.flash.AbstractFlashScope


onConfigurationLoad

public void onConfigurationLoad()

Overrides:
onConfigurationLoad in class BaseService

removeContext

public any removeContext()
Remove the context from scope and return yourself


requestCapture

public any<RequestContext> requestCapture()
I capture an incoming request. Returns: coldbox.system.web.context.RequestContext


setContext

public any setContext(any context)
Set the Request context

Parameters:
context

ColdBox Platform v3.8.0