commandbox.system

Class Interceptor

lucee.Component
    extended by commandbox.system.Interceptor

Copyright Since 2005 ColdBox Platform by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com The base class for all CommandBox interceptors

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • author : Brad Wood, Luis Majano
    •  
    Property Summary
    type property default serializable required
    InterceptorService interceptorService


    • access = public
    • returntype = any
    		 true false
    any log


    • access = public
    • returntype = any
    		 true false
    any logBox


    • access = public
    • returntype = any
    		 true false
    struct properties


    • access = public
    • returntype = any
    		 true false
    any shell


    • access = public
    • returntype = any
    		 true false
    any wirebox


    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any shell, [struct properties='[runtime expression]'])
          Constructor.
    Method Summary
    void configure()
         Configuration method for the interceptor.
    any getInstance([any name], [any dsl], [any initArguments='[runtime expression]'], [any targetObject=''])
    string getInterceptorService()
    string getLog()
    string getLogBox()
    string getProperties()
    any getProperty(any property, [any defaultValue])
         Get an interceptor property.
    string getShell()
    string getWirebox()
    boolean propertyExists(any property)
         Verify an interceptor property.
    any setInterceptorService(InterceptorService interceptorService)
    any setLog(any log)
    any setLogBox(any logBox)
    any setProperties(struct properties)
    any setProperty(any property, any value)
         Store an interceptor property.
    any setShell(any shell)
    any setWirebox(any wirebox)
    any unregister(any state)
         Unregister the interceptor.
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any shell, [struct properties='[runtime expression]'])

    Constructor

    Parameters:
    shell - The CommandBox Shell
    properties - The properties to init the Interceptor with
    Property Detail

    interceptorService

    property InterceptorService interceptorService

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    log

    property any log

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    logBox

    property any logBox

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    properties

    property struct properties

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    shell

    property any shell

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    wirebox

    property any wirebox

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    configure

    public void configure()

    Configuration method for the interceptor

    getInstance

    public any getInstance([any name], [any dsl], [any initArguments='[runtime expression]'], [any targetObject=''])

    Parameters:
    name
    dsl
    initArguments
    targetObject

    getInterceptorService

    public string getInterceptorService()

    getLog

    public string getLog()

    getLogBox

    public string getLogBox()

    getProperties

    public string getProperties()

    getProperty

    public any getProperty(any property, [any defaultValue])

    Get an interceptor property

    Parameters:
    property - The property to retrieve
    defaultValue - The default value to return if property does not exist

    getShell

    public string getShell()

    getWirebox

    public string getWirebox()

    propertyExists

    public boolean propertyExists(any property)

    Verify an interceptor property

    Parameters:
    property - The property to check

    setInterceptorService

    public any setInterceptorService(InterceptorService interceptorService)

    Parameters:
    interceptorService

    setLog

    public any setLog(any log)

    Parameters:
    log

    setLogBox

    public any setLogBox(any logBox)

    Parameters:
    logBox

    setProperties

    public any setProperties(struct properties)

    Parameters:
    properties

    setProperty

    public any setProperty(any property, any value)

    Store an interceptor property

    Parameters:
    property - The property to store
    value - The value to store
    Returns:
    Interceptor instance

    setShell

    public any setShell(any shell)

    Parameters:
    shell

    setWirebox

    public any setWirebox(any wirebox)

    Parameters:
    wirebox

    unregister

    public any unregister(any state)

    Unregister the interceptor

    Parameters:
    state - The named state to unregister this interceptor from
    Returns:
    Interceptor