commandbox.system.endpoints

Class File

lucee.Component
    extended by commandbox.system.endpoints.File
All Implemented Interfaces:
IEndpoint
Direct Known Subclasses:
TempFile

Copyright Since 2014 CommandBox by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com I am the file endpoint. I get packages from a local file.

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


    • access = public
    • returntype = any
    • inject = logbox:logger:console
    		 true false
    any fileSystemUtil


    • access = public
    • returntype = any
    • inject = FileSystem
    		 true false
    any folderEndpoint


    • access = public
    • returntype = any
    • inject = commandbox.system.endpoints.Folder
    		 true false
    string namePrefixes


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


    • access = public
    • returntype = any
    • inject = packageService
    		 true false
    any semanticVersion


    • access = public
    • returntype = any
    • inject = provider:semanticVersion@semver
    		 true false
    any tempDir


    • access = public
    • returntype = any
    • inject = tempDir@constants
    		 true false
    any wirebox


    • access = public
    • returntype = any
    • inject = wirebox
    		 true false
    Constructor Summary
    init()
    Method Summary
    any cleanUp([any package])
    string getConsoleLogger()
    any getDefaultName(string package)
         Determines the name of a package based on its ID if there is no box.
    string getFileSystemUtil()
    string getFolderEndpoint()
    string getNamePrefixes()
    string getPackageService()
    string getSemanticVersion()
    string getTempDir()
    any getUpdate(string package, string version, [boolean verbose='false'])
    string getWirebox()
    string resolvePackage(string package, [boolean verbose='false'])
    any setConsoleLogger(any consoleLogger)
    any setFileSystemUtil(any fileSystemUtil)
    any setFolderEndpoint(any folderEndpoint)
    any setNamePrefixes(string namePrefixes)
    any setPackageService(any packageService)
    any setSemanticVersion(any semanticVersion)
    any setTempDir(any tempDir)
    any setWirebox(any wirebox)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Property Detail

    consoleLogger

    property any consoleLogger

    Attributes:
    access - public
    required - false
    returntype - any
    inject - logbox:logger:console
    serializable - true

    fileSystemUtil

    property any fileSystemUtil

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

    folderEndpoint

    property any folderEndpoint

    Attributes:
    access - public
    required - false
    returntype - any
    inject - commandbox.system.endpoints.Folder
    serializable - true

    namePrefixes

    property string namePrefixes

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

    packageService

    property any packageService

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

    semanticVersion

    property any semanticVersion

    Attributes:
    access - public
    required - false
    returntype - any
    inject - provider:semanticVersion@semver
    serializable - true

    tempDir

    property any tempDir

    Attributes:
    access - public
    required - false
    returntype - any
    inject - tempDir@constants
    serializable - true

    wirebox

    property any wirebox

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

    cleanUp

    public any cleanUp([any package])

    Parameters:
    package

    getConsoleLogger

    public string getConsoleLogger()

    getDefaultName

    public any getDefaultName(string package)

    Determines the name of a package based on its ID if there is no box.json

    Specified by:
    getDefaultName in interface IEndpoint
    Parameters:
    package

    getFileSystemUtil

    public string getFileSystemUtil()

    getFolderEndpoint

    public string getFolderEndpoint()

    getNamePrefixes

    public string getNamePrefixes()

    getPackageService

    public string getPackageService()

    getSemanticVersion

    public string getSemanticVersion()

    getTempDir

    public string getTempDir()

    getUpdate

    public any getUpdate(string package, string version, [boolean verbose='false'])

    Specified by:
    getUpdate in interface IEndpoint
    Parameters:
    package
    version
    verbose

    getWirebox

    public string getWirebox()

    resolvePackage

    public string resolvePackage(string package, [boolean verbose='false'])

    Specified by:
    resolvePackage in interface IEndpoint
    Parameters:
    package
    verbose

    setConsoleLogger

    public any setConsoleLogger(any consoleLogger)

    Parameters:
    consoleLogger

    setFileSystemUtil

    public any setFileSystemUtil(any fileSystemUtil)

    Parameters:
    fileSystemUtil

    setFolderEndpoint

    public any setFolderEndpoint(any folderEndpoint)

    Parameters:
    folderEndpoint

    setNamePrefixes

    public any setNamePrefixes(string namePrefixes)

    Parameters:
    namePrefixes

    setPackageService

    public any setPackageService(any packageService)

    Parameters:
    packageService

    setSemanticVersion

    public any setSemanticVersion(any semanticVersion)

    Parameters:
    semanticVersion

    setTempDir

    public any setTempDir(any tempDir)

    Parameters:
    tempDir

    setWirebox

    public any setWirebox(any wirebox)

    Parameters:
    wirebox