ContentBox Core API 1.6.0

contentbox.model.updates
Class UpdateService

WEB-INF.cftags.component
        extended by contentbox.model.updates.UpdateService

public class UpdateService
extends WEB-INF.cftags.component

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. *******************************************************************************

Property Summary
Type Property & Description Default Serializable Required
 any appPath


Attributes:
  • inject = coldbox:setting:ApplicationPath
true false
 any moduleConfig


Attributes:
  • inject = coldbox:moduleConfig:contentbox
true false
 any patchesLocation


Attributes:
true false
 any wirebox


Attributes:
  • inject = wirebox
true false
 any zipUtil


Attributes:
  • inject = coldbox:plugin:Zip
true false
 
Constructor Summary
init()
 
Method Summary
 any GETAPPPATH()
 any GETMODULECONFIG()
 any GETPATCHESLOCATION()
 any GETWIREBOX()
 any GETZIPUTIL()
 UpdateService SETAPPPATH(any appPath)
 UpdateService SETMODULECONFIG(any moduleConfig)
 UpdateService SETPATCHESLOCATION(any patchesLocation)
 UpdateService SETWIREBOX(any wirebox)
 UpdateService SETZIPUTIL(any zipUtil)
 UpdateService activateORMUpdate()
          Activate ORM Update
 struct applyUpdateFromURL(string downloadURL)
 struct applyUpdateFromUpload(any fileField)
private boolean applyUpdateOnDisk(any log)
 IUpdate buildUpdater()
 UpdateService deactivateORMUpdate()
          Deactivate ORM Update
 boolean downloadPatch(string downloadURL, any log)
 boolean extractPatch(string filename, any log)
 any isNewVersion([any cVersion], [any nVersion])
          Check for version updates cVersion
 void onDIComplete()
          onDIComplete startup the layouting services
 any processRemovals(any path, any log)
          Process patch update removals if any
 any processUpdates(any path, any log)
          Process updated files
 struct uploadUpdate(any fileField)
          Upload an update file to disk
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init()

Property Detail

appPath

any appPath

Attributes:
inject - coldbox:setting:ApplicationPath
required - false
serializable - true
default -

moduleConfig

any moduleConfig

Attributes:
inject - coldbox:moduleConfig:contentbox
required - false
serializable - true
default -

patchesLocation

any patchesLocation

Attributes:
default -
serializable - true
required - false

wirebox

any wirebox

Attributes:
inject - wirebox
required - false
serializable - true
default -

zipUtil

any zipUtil

Attributes:
inject - coldbox:plugin:Zip
required - false
serializable - true
default -

Method Detail

GETAPPPATH

public any GETAPPPATH()


GETMODULECONFIG

public any GETMODULECONFIG()


GETPATCHESLOCATION

public any GETPATCHESLOCATION()


GETWIREBOX

public any GETWIREBOX()


GETZIPUTIL

public any GETZIPUTIL()


SETAPPPATH

public UpdateService SETAPPPATH(any appPath)

Parameters:
appPath

SETMODULECONFIG

public UpdateService SETMODULECONFIG(any moduleConfig)

Parameters:
moduleConfig

SETPATCHESLOCATION

public UpdateService SETPATCHESLOCATION(any patchesLocation)

Parameters:
patchesLocation

SETWIREBOX

public UpdateService SETWIREBOX(any wirebox)

Parameters:
wirebox

SETZIPUTIL

public UpdateService SETZIPUTIL(any zipUtil)

Parameters:
zipUtil

activateORMUpdate

public UpdateService activateORMUpdate()
Activate ORM Update


applyUpdateFromURL

public struct applyUpdateFromURL(string downloadURL)

Parameters:
downloadURL

applyUpdateFromUpload

public struct applyUpdateFromUpload(any fileField)

Parameters:
fileField

applyUpdateOnDisk

private boolean applyUpdateOnDisk(any log)

Parameters:
log

buildUpdater

public IUpdate buildUpdater()


deactivateORMUpdate

public UpdateService deactivateORMUpdate()
Deactivate ORM Update


downloadPatch

public boolean downloadPatch(string downloadURL, any log)

Parameters:
downloadURL
log

extractPatch

public boolean extractPatch(string filename, any log)

Parameters:
filename
log

isNewVersion

public any isNewVersion([any cVersion], [any nVersion])
Check for version updates cVersion.hint The current version of the system nVersion.hint The newer version received

Parameters:
cVersion
nVersion

onDIComplete

public void onDIComplete()
onDIComplete startup the layouting services


processRemovals

public any processRemovals(any path, any log)
Process patch update removals if any

Parameters:
path
log

processUpdates

public any processUpdates(any path, any log)
Process updated files

Parameters:
path
log

uploadUpdate

public struct uploadUpdate(any fileField)
Upload an update file to disk

Parameters:
fileField

ContentBox Core API 1.6.0