commandbox.system.endpoints

Class HTTP

lucee.Component
    extended by commandbox.system.endpoints.HTTP
All Implemented Interfaces:
IEndpoint
Direct Known Subclasses:
HTTPS , HTTP_Cached

Copyright Since 2014 CommandBox by Ortus Solutions, Corp www.coldbox.org | www.ortussolutions.com I am the HTTP endpoint. I get packages from an HTTP URL.

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


    • access = public
    • returntype = any
    • inject = CR@constants
    		 true false
    any artifactService


    • access = public
    • returntype = any
    • inject = ArtifactService
    		 true false
    any consoleLogger


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


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


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


    • access = public
    • returntype = any
    • inject = ProgressBar
    		 true false
    any progressableDownloader


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


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


    • access = public
    • returntype = any
    • inject = semverRegex@constants
    		 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
    string getArtifactService()
    string getCR()
    string getConsoleLogger()
    any getDefaultName(string package)
    string getFileEndpoint()
    string getNamePrefixes()
    string getProgressBar()
    string getProgressableDownloader()
    string getSemanticVersion()
    string getSemverRegex()
    string getTempDir()
    any getUpdate(string package, string version, [boolean verbose='false'])
    string getWirebox()
    string resolvePackage(string package, [boolean verbose='false'])
    string resolvePackageZip(string package, [boolean verbose='false'])
    any setArtifactService(any artifactService)
    any setCR(any CR)
    any setConsoleLogger(any consoleLogger)
    any setFileEndpoint(any fileEndpoint)
    any setNamePrefixes(string namePrefixes)
    any setProgressBar(any progressBar)
    any setProgressableDownloader(any progressableDownloader)
    any setSemanticVersion(any semanticVersion)
    any setSemverRegex(any semverRegex)
    any setTempDir(any tempDir)
    any setWirebox(any wirebox)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Property Detail

    CR

    property any CR

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

    artifactService

    property any artifactService

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

    consoleLogger

    property any consoleLogger

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

    fileEndpoint

    property any fileEndpoint

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

    namePrefixes

    property string namePrefixes

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

    progressBar

    property any progressBar

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

    progressableDownloader

    property any progressableDownloader

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

    semanticVersion

    property any semanticVersion

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

    semverRegex

    property any semverRegex

    Attributes:
    access - public
    required - false
    returntype - any
    inject - semverRegex@constants
    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

    getArtifactService

    public string getArtifactService()

    getCR

    public string getCR()

    getConsoleLogger

    public string getConsoleLogger()

    getDefaultName

    public any getDefaultName(string package)

    Specified by:
    getDefaultName in interface IEndpoint
    Parameters:
    package

    getFileEndpoint

    public string getFileEndpoint()

    getNamePrefixes

    public string getNamePrefixes()

    getProgressBar

    public string getProgressBar()

    getProgressableDownloader

    public string getProgressableDownloader()

    getSemanticVersion

    public string getSemanticVersion()

    getSemverRegex

    public string getSemverRegex()

    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

    resolvePackageZip

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

    Parameters:
    package
    verbose

    setArtifactService

    public any setArtifactService(any artifactService)

    Parameters:
    artifactService

    setCR

    public any setCR(any CR)

    Parameters:
    CR

    setConsoleLogger

    public any setConsoleLogger(any consoleLogger)

    Parameters:
    consoleLogger

    setFileEndpoint

    public any setFileEndpoint(any fileEndpoint)

    Parameters:
    fileEndpoint

    setNamePrefixes

    public any setNamePrefixes(string namePrefixes)

    Parameters:
    namePrefixes

    setProgressBar

    public any setProgressBar(any progressBar)

    Parameters:
    progressBar

    setProgressableDownloader

    public any setProgressableDownloader(any progressableDownloader)

    Parameters:
    progressableDownloader

    setSemanticVersion

    public any setSemanticVersion(any semanticVersion)

    Parameters:
    semanticVersion

    setSemverRegex

    public any setSemverRegex(any semverRegex)

    Parameters:
    semverRegex

    setTempDir

    public any setTempDir(any tempDir)

    Parameters:
    tempDir

    setWirebox

    public any setWirebox(any wirebox)

    Parameters:
    wirebox