ColdBox Platform Version 2.6.3

coldbox.system.interceptors
Class ses

WEB-INF.cftags.component
        extended by coldbox.system.frameworkSupertype
            extended by coldbox.system.interceptor
                extended by coldbox.system.interceptors.ses

public class ses
extends interceptor

This is a ses support internceptor


Method Summary
 void Configure()
          This is where the ses plugin configures itself.
 any addCourse(string pattern, [string handler], [string action], [boolean packageResolverExempt='false'], [string matchVariables])
          Adds a route to dispatch
private void checkForInvalidURL(any course, any script_name, any event)
          Check for invalid URL's
private Struct findCourse(any action, any event)
          Figures out which course matches this request
 string getBaseURL()
          Get BaseURL
private string getCGIElement(string cgielement)
          The cgi element facade method
private string getDefaultFrameworkAction()
          Get the default framework action
 boolean getUniqueURLs()
          Get uniqueURLs
 Array get_courses()
          Get _courses
 boolean getenabled()
          Get enabled
private any packageResolver(any routingString, any routeParams)
          Resolve handler packages
 void preProcess(any event, struct interceptData)
          This is the course dispatch
private any routeToDestination(any course, any event)
          Route to destination
private string serializeURL([string formVars=''], any event)
          Serialize a URL
 void setBaseURL(string baseURL)
          Set the base URL for the application.
 void setEnabled(boolean enabled)
          Set whether the interceptor is enabled or not.
 void setUniqueURLs(boolean uniqueURLs)
          Set the uniqueURLs property
 void set_courses(Array _courses)
          Set _courses
 
Methods inherited from class coldbox.system.interceptor
afterAspectsLoad, afterCacheElementInsert, afterCacheElementRemoved, afterConfigurationLoad, afterHandlerCreation, afterPluginCreation, appendToBuffer, clearBuffer, getBufferObject, getBufferString, getInterceptorService, getProperty, getproperties, init, onException, postEvent, postProcess, postRender, preEvent, preRender, propertyExists, sessionEnd, sessionStart, setProperty, setproperties, unregister
 
Methods inherited from class coldbox.system.frameworkSupertype
abort, announceInterception, dump, getColdboxOCM, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getcontroller, getfwLocale, htmlhead, include, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, rethrowit, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setcontroller, settingExists, throw
 
Methods inherited from class WEB-INF.cftags.component
 

Method Detail

Configure

public void Configure()
This is where the ses plugin configures itself.

Overrides:
Configure in class interceptor

addCourse

public any addCourse(string pattern, [string handler], [string action], [boolean packageResolverExempt='false'], [string matchVariables])
Adds a route to dispatch

Parameters:
pattern - The pattern to match against the URL.
handler - The handler to path to execute if passed.
action - The action to assign if passed.
packageResolverExempt - If this is set to true, then the interceptor will not try to do handler package resolving. Else a package will always be resolved.
matchVariables - A string of name-value pair variables to add to the request collection when this pattern matches. This is a comma delimmitted list. Ex: spaceFound=true,missingAction=onTest

checkForInvalidURL

private void checkForInvalidURL(any course, any script_name, any event)
Check for invalid URL's

Parameters:
course
script_name
event - The event object.

findCourse

private Struct findCourse(any action, any event)
Figures out which course matches this request

Parameters:
action - The action evaluated by the path_info
event - The event object.

getBaseURL

public string getBaseURL()
Get BaseURL


getCGIElement

private string getCGIElement(string cgielement)
The cgi element facade method

Parameters:
cgielement -

getDefaultFrameworkAction

private string getDefaultFrameworkAction()
Get the default framework action


getUniqueURLs

public boolean getUniqueURLs()
Get uniqueURLs


get_courses

public Array get_courses()
Get _courses


getenabled

public boolean getenabled()
Get enabled


packageResolver

private any packageResolver(any routingString, any routeParams)
Resolve handler packages

Parameters:
routingString - The routing string
routeParams - The route params array

preProcess

public void preProcess(any event, struct interceptData)
This is the course dispatch

Overrides:
preProcess in class interceptor
Parameters:
event - The event object.
interceptData - interceptData of intercepted info.

routeToDestination

private any routeToDestination(any course, any event)
Route to destination

Parameters:
course
event - The event object.

serializeURL

private string serializeURL([string formVars=''], any event)
Serialize a URL

Parameters:
formVars
event - The event object.

setBaseURL

public void setBaseURL(string baseURL)
Set the base URL for the application.

Parameters:
baseURL

setEnabled

public void setEnabled(boolean enabled)
Set whether the interceptor is enabled or not.

Parameters:
enabled

setUniqueURLs

public void setUniqueURLs(boolean uniqueURLs)
Set the uniqueURLs property

Parameters:
uniqueURLs

set_courses

public void set_courses(Array _courses)
Set _courses

Parameters:
_courses

ColdBox Platform Version 2.6.3