coldbox.system.aop

Class MethodInvocation

lucee.Component
    extended by coldbox.system.aop.MethodInvocation

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- This object is used when implementing AOP advices. Each advice you create will implement a `invokeMethod()` and receive this object as an argument. You can then use any of the properties in this object to construct your advice. Please see the property documentation below to understand each of the properties. Just remember that in order to continue the execution of the Adviced method you will need to call `proceed()`

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    any args
          The currently executing method arguments.

    • access = public
    • returntype = any
    		 true false
    any interceptorIndex
          The current index of execution.

    • access = public
    • returntype = any
    		 true false
    any interceptorLen
          The number of interceptors applied.

    • access = public
    • returntype = any
    		 true false
    any interceptors
          The AOP interceptors to execute.

    • access = public
    • returntype = any
    		 true false
    any method
          The currently executing method.

    • access = public
    • returntype = any
    		 true false
    any methodMetadata
          The current method metadata.

    • access = public
    • returntype = any
    		 true false
    any target
          The target of execution.

    • access = public
    • returntype = any
    		 true false
    any targetMapping
          The target wirebox mapping.

    • access = public
    • returntype = any
    		 true false
    any targetName
          The target shortname.

    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any method, any args, any methodMetadata, any target, any targetName, any<Mapping> targetMapping, any interceptors)
          Constructor.
    Method Summary
    string getArgs()
    string getInterceptorIndex()
    string getInterceptorLen()
    string getInterceptors()
    string getMethod()
    string getMethodMetadata()
    string getTarget()
    string getTargetMapping()
    string getTargetName()
    any incrementInterceptorIndex()
         Increment the interceptor index pointer.
    any proceed()
         Proceed execution of the method invocation.
    any setArgs(any args)
         Set args.
    any setInterceptorIndex(any interceptorIndex)
    any setInterceptorLen(any interceptorLen)
    any setInterceptors(any interceptors)
    any setMethod(any method)
    any setMethodMetadata(any methodMetadata)
    any setTarget(any target)
    any setTargetMapping(any targetMapping)
    any setTargetName(any targetName)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any method, any args, any methodMetadata, any target, any targetName, any<Mapping> targetMapping, any interceptors)

    Constructor

    Parameters:
    method - The method name that was intercepted
    args - The argument collection that was intercepted
    methodMetadata - The method metadata that was intercepted
    target - The target object reference that was intercepted
    targetName - The name of the target wired up
    targetMapping - The target's mapping object reference
    interceptors - The array of interceptors for this invocation
    Property Detail

    args

    property any args

    The currently executing method arguments

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

    interceptorIndex

    property any interceptorIndex

    The current index of execution

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

    interceptorLen

    property any interceptorLen

    The number of interceptors applied

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

    interceptors

    property any interceptors

    The AOP interceptors to execute

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

    method

    property any method

    The currently executing method

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

    methodMetadata

    property any methodMetadata

    The current method metadata

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

    target

    property any target

    The target of execution

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

    targetMapping

    property any targetMapping

    The target wirebox mapping

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

    targetName

    property any targetName

    The target shortname

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

    getArgs

    public string getArgs()

    getInterceptorIndex

    public string getInterceptorIndex()

    getInterceptorLen

    public string getInterceptorLen()

    getInterceptors

    public string getInterceptors()

    getMethod

    public string getMethod()

    getMethodMetadata

    public string getMethodMetadata()

    getTarget

    public string getTarget()

    getTargetMapping

    public string getTargetMapping()

    getTargetName

    public string getTargetName()

    incrementInterceptorIndex

    public any incrementInterceptorIndex()

    Increment the interceptor index pointer

    Returns:
    MethodInvocation

    proceed

    public any proceed()

    Proceed execution of the method invocation

    setArgs

    public any setArgs(any args)

    Set args

    Parameters:
    args
    Returns:
    MethodInvocation

    setInterceptorIndex

    public any setInterceptorIndex(any interceptorIndex)

    Parameters:
    interceptorIndex

    setInterceptorLen

    public any setInterceptorLen(any interceptorLen)

    Parameters:
    interceptorLen

    setInterceptors

    public any setInterceptors(any interceptors)

    Parameters:
    interceptors

    setMethod

    public any setMethod(any method)

    Parameters:
    method

    setMethodMetadata

    public any setMethodMetadata(any methodMetadata)

    Parameters:
    methodMetadata

    setTarget

    public any setTarget(any target)

    Parameters:
    target

    setTargetMapping

    public any setTargetMapping(any targetMapping)

    Parameters:
    targetMapping

    setTargetName

    public any setTargetName(any targetName)

    Parameters:
    targetName