contentbox.models.media

Class CFContentMediaProvider

lucee.Component
    extended by contentbox.models.media.CFContentMediaProvider
All Implemented Interfaces:
IMediaProvider

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- Deliver file via cfcontent

Class Attributes:
  • singleton
    •  
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    any fileUtils


    • access = public
    • returntype = any
    • inject = FileUtils@cb
    		 true false
    any log


    • access = public
    • returntype = any
    • inject = logbox:logger:{this}
    		 true false
    any mediaService


    • access = public
    • returntype = any
    • inject = mediaService@cb
    		 true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    any deliverMedia(any mediaPath)
         Deliver the media.
    any getDescription()
         Get the description of this provider.
    any getDisplayName()
         Get the display name of a provider.
    string getFileUtils()
    string getLog()
    string getMediaService()
    any getName()
         The internal name of the provider.
    private any getRealMediaPath(any mediaPath)
         PRIVATE ********************************************.
    boolean mediaExists(any mediaPath)
         Validate if a media requested exists.
    any setFileUtils(any fileUtils)
    any setLog(any log)
    any setMediaService(any mediaService)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Constructor

    Property Detail

    fileUtils

    property any fileUtils

    Attributes:
    access - public
    required - false
    returntype - any
    inject - FileUtils@cb
    serializable - true

    log

    property any log

    Attributes:
    access - public
    required - false
    returntype - any
    inject - logbox:logger:{this}
    serializable - true

    mediaService

    property any mediaService

    Attributes:
    access - public
    required - false
    returntype - any
    inject - mediaService@cb
    serializable - true
    Method Detail

    deliverMedia

    public any deliverMedia(any mediaPath)

    Deliver the media

    Specified by:
    deliverMedia in interface IMediaProvider
    Parameters:
    mediaPath - the media path to deliver back to the user

    getDescription

    public any getDescription()

    Get the description of this provider

    Specified by:
    getDescription in interface IMediaProvider

    getDisplayName

    public any getDisplayName()

    Get the display name of a provider

    Specified by:
    getDisplayName in interface IMediaProvider

    getFileUtils

    public string getFileUtils()

    getLog

    public string getLog()

    getMediaService

    public string getMediaService()

    getName

    public any getName()

    The internal name of the provider

    Specified by:
    getName in interface IMediaProvider

    getRealMediaPath

    private any getRealMediaPath(any mediaPath)

    PRIVATE ********************************************

    Parameters:
    mediaPath

    mediaExists

    public boolean mediaExists(any mediaPath)

    Validate if a media requested exists

    Specified by:
    mediaExists in interface IMediaProvider
    Parameters:
    mediaPath - the media path to verify if it exists

    setFileUtils

    public any setFileUtils(any fileUtils)

    Parameters:
    fileUtils

    setLog

    public any setLog(any log)

    Parameters:
    log

    setMediaService

    public any setMediaService(any mediaService)

    Parameters:
    mediaService