commandbox.system.services

Class FRTransService

lucee.Component
    extended by commandbox.system.services.FRTransService

Copyright Since 2014 CommandBox by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com FusionReactor Transaction Service. I abstract interactions with the FRAPI, which may or may not exist. When the FR JVM args have been loaded in the JVM, I help assist in tracking custom transactions. If FR is not present, I do nothing.

Class Attributes:
  • singleton
    •  
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • author : Brad Wood, Luis Majano, Denny Valliant
    •  
    Property Summary
    type property default serializable required
    any FRAPI


    • access = public
    • returntype = any
    		 true false
    boolean FREnabled


    • access = public
    • returntype = any
    		 false true false
    Constructor Summary
    init()
          The constructor detects if FR is present and stores a flag that can short circuit all the methods in this service if FR isn't running.
    Method Summary
    any endTransaction(any FRTransaction)
         Will close a transaction by reference.
    any errorTransaction(any FRTransaction, any javaException)
         Mark a transaction as having an error.
    string getFRAPI()
    string getFREnabled()
    any setFRAPI(any FRAPI)
    any setFREnabled(boolean FREnabled)
    any startTransaction(string name, [string description=''])
         Start a named transaction in FR.
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    The constructor detects if FR is present and stores a flag that can short circuit all the methods in this service if FR isn't running

    Property Detail

    FRAPI

    property any FRAPI

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

    FREnabled

    property boolean FREnabled = [false]

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

    endTransaction

    public any endTransaction(any FRTransaction)

    Will close a transaction by reference

    Parameters:
    FRTransaction - Instance of FR Transaction object, returned by previous call to startTransaction.

    errorTransaction

    public any errorTransaction(any FRTransaction, any javaException)

    Mark a transaction as having an error. This will NOT end the transaction. You must still do that.

    Parameters:
    FRTransaction - Instance of FR Transaction object, returned by previous call to startTransaction.
    javaException - Instance of Java exception object that represents the error

    getFRAPI

    public string getFRAPI()

    getFREnabled

    public string getFREnabled()

    setFRAPI

    public any setFRAPI(any FRAPI)

    Parameters:
    FRAPI

    setFREnabled

    public any setFREnabled(boolean FREnabled)

    Parameters:
    FREnabled

    startTransaction

    public any startTransaction(string name, [string description=''])

    Start a named transaction in FR. This transaction will stay "running" in FR until endTransaction() is called.

    Parameters:
    name - The short name of the transaction
    description - Full details of this transaction