contentbox.models.media

Class BaseProvider

lucee.Component
    extended by contentbox.models.media.BaseProvider
Direct Known Subclasses:
CFContentMediaProvider , ForwardMediaProvider , RelocationMediaProvider
Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any cbfs


    • access = public
    • returntype = any
    • inject = DiskService@cbfs
    true false
    any description
          The description of this provider.

    • access = public
    • returntype = any
    true false
    any displayName
          The display name of a provider.

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


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


    • access = public
    • returntype = any
    • inject = mediaService@contentbox
    true false
    any name
          The internal name of the provider.

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


    • access = public
    • returntype = any
    • inject = cachebox:template
    true false
    Method Summary
    string getCbfs()
    string getDescription()
    string getDisplayName()
    string getLog()
    string getMediaService()
    string getName()
    package any getPublicURL(any mediaPath)
         Package Utility Methods ********************************************.
    package any getRealMediaPath(any mediaPath)
    string getTemplateCache()
    boolean mediaExists(any mediaPath)
         Validate if a media requested exists.
    any setCbfs(any cbfs)
    any setDescription(any description)
    any setDisplayName(any displayName)
    any setLog(any log)
    any setMediaService(any mediaService)
    any setName(any name)
    any setTemplateCache(any templateCache)
     
    Methods inherited from class lucee.Component
    None

    Property Detail

    cbfs

    property any cbfs

    Attributes:
    access - public
    required - false
    returntype - any
    inject - DiskService@cbfs
    serializable - true

    description

    property any description

    The description of this provider

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

    displayName

    property any displayName

    The display name of a provider

    Attributes:
    access - public
    required - false
    returntype - any
    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@contentbox
    serializable - true

    name

    property any name

    The internal name of the provider

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

    templateCache

    property any templateCache

    Attributes:
    access - public
    required - false
    returntype - any
    inject - cachebox:template
    serializable - true

    Method Detail

    getCbfs

    public string getCbfs()


    getDescription

    public string getDescription()


    getDisplayName

    public string getDisplayName()


    getLog

    public string getLog()


    getMediaService

    public string getMediaService()


    getName

    public string getName()


    getPublicURL

    package any getPublicURL(any mediaPath)

    Package Utility Methods ********************************************

    Parameters:
    mediaPath

    getRealMediaPath

    package any getRealMediaPath(any mediaPath)

    Parameters:
    mediaPath

    getTemplateCache

    public string getTemplateCache()


    mediaExists

    public boolean mediaExists(any mediaPath)

    Validate if a media requested exists

    Parameters:
    mediaPath - the media path to verify if it exists

    setCbfs

    public any setCbfs(any cbfs)

    Parameters:
    cbfs

    setDescription

    public any setDescription(any description)

    Parameters:
    description

    setDisplayName

    public any setDisplayName(any displayName)

    Parameters:
    displayName

    setLog

    public any setLog(any log)

    Parameters:
    log

    setMediaService

    public any setMediaService(any mediaService)

    Parameters:
    mediaService

    setName

    public any setName(any name)

    Parameters:
    name

    setTemplateCache

    public any setTemplateCache(any templateCache)

    Parameters:
    templateCache