4Suite API Documentation

Module Ft.Server.Common.Install.InstallUtil

Definitions and functions used in the installation process
Copyright 2004 Fourthought, Inc. (USA).
Detailed license and copyright information: http://4suite.org/COPYRIGHT
Project home, documentation, distributions: http://4suite.org/
Classes:
Functions:
Globals:

Classes

class Alias(XmlDocument)

Methods

__init__(self, path, acl, owner, imt, docDef, reference)
Overrides: __init__ from class XmlDocument
createContent(self, repo, quiet)
Called when we need to add our content to the repo
Overrides: createContent from class XmlDocument
updateContent(self, repo, quiet)
Called when we need to update our content in the repo
Overrides: updateContent from class XmlDocument
updateOther(self, repo, quiet)
Overrides: updateOther from class XmlDocument

Methods inherited from class RawFile

Members

resourceType = 2

Members inherited from class XmlDocument

Members inherited from class RawFile

Members inherited from class IndicatorBase

class Command(XmlDocument)

Methods inherited from class XmlDocument

Methods inherited from class RawFile

Members

docName = 'Command'
resourceType = 14

Members inherited from class RawFile

Members inherited from class IndicatorBase

class Container(XmlDocument)

Methods

__init__(self, path, acl, owner, imt, docDef)
Overrides: __init__ from class XmlDocument
createContent(self, repo, quiet)
Overrides: createContent from class XmlDocument
updateContent(self, repo, quiet)
Called when we need to update our content in the repo
Overrides: updateContent from class XmlDocument

Methods inherited from class XmlDocument

Methods inherited from class RawFile

Members

resourceType = 1

Members inherited from class XmlDocument

Members inherited from class RawFile

Members inherited from class IndicatorBase

class ExtensionModule(IndicatorBase)

Methods

__init__(self, file)
checkStatus(self, repo, force=0, checkAcl=1)
createContent(self, repo, quiet)
setPath(self, fName)
updateContent(self, repo, quiet)

Members

owner = -1
resourceType = None

Members inherited from class IndicatorBase

class Group(XmlDocument)

Methods

__init__(self, groupName, acl, owner, imt, docDef, basePath, members)
Overrides: __init__ from class XmlDocument
checkStatus(self, repo, force=0, checkAcl=True)
Overrides: checkStatus from class XmlDocument
createContent(self, repo, quiet)
Called when we need to add our content to the repo
Overrides: createContent from class XmlDocument
updateContent(self, repo, quiet)
Called when we need to update our content in the repo
Overrides: updateContent from class XmlDocument
updateOther(self, repo, quiet)
Overrides: updateOther from class XmlDocument

Methods inherited from class RawFile

Members

resourceType = 8

Members inherited from class XmlDocument

Members inherited from class RawFile

Members inherited from class IndicatorBase

class IndicatorBase

Members

indicator = None
class Product

Methods

__init__(self, resourceList, name='', version=0, description='', useIndicator=None)
filter(self, repo, checkAcl=True)
Processes self.resourceList, creating (if not already created) 3 more lists: self.sortedList, which is the resources that have content or docdef changes and thus need to have their dependencies expanded; self.filteredList, which is the resources that have other changes; and self.notDirectlyChangedList, which is resources with no changes.
install(self, repo, basePath, quiet, do_update=False, checkAcl=True)
Install the product into the repo
serialize(self, stream=<open file '<stdout>', mode 'w' at 0x401dd060>, refUri='')
setBase(self, basePath)
Processes self.resourceList, setting the destination container on each resource to be the given basePath.
setIndicator(self)
Processes self.resourceList, hooking each resource into the progress indicator.
sort(self, repo, quiet=True)

Members

description = ''
name = ''
version = 0
class RawFile(IndicatorBase)

Methods

__init__(self, path, acl, owner, imt)
__repr__(self)
checkStatus(self, repo, force=0, checkAcl=1)
Get the status of this resource from against the supplied repo, Note, force here specifies that we force update to the status. Not force install
createContent(self, repo, quiet)
Called when we need to add our content to the repo
setPath(self, contentUri)
setSource(self, stringContent, stringLastModified)
updateAcl(self, repo, quiet)
Called when we need to update our acl in the repo
updateContent(self, repo, quiet)
Called when we need to update our content in the repo
updateImt(self, repo, quiet)
Called when we need to update our imt in the repo
updateOther(self, repo, quiet)
Called when we need to update our other stuff in the repo
updateOwner(self, repo, quiet)
Called when we need to update our owner in the repo

Members

contentUri = None
imts = {}
lmds = None
owners = {}
resourceType = 3
stringContent = None
stringLastModified = None

Members inherited from class IndicatorBase

class RdfDocument(XmlDocument)

Methods inherited from class XmlDocument

Methods inherited from class RawFile

Members

docName = 'RdfDocument'
resourceType = 12

Members inherited from class RawFile

Members inherited from class IndicatorBase

class SchematronDocument(XmlDocument)

Methods inherited from class XmlDocument

Methods inherited from class RawFile

Members

docName = 'SchematronDocument'
resourceType = 6

Members inherited from class RawFile

Members inherited from class IndicatorBase

class Server(XmlDocument)

Methods inherited from class XmlDocument

Methods inherited from class RawFile

Members

docName = 'Server'
resourceType = 15

Members inherited from class RawFile

Members inherited from class IndicatorBase

class StatusFlags

Members

ACL_CHANGE = 8
ACTION_REQUIRED = 63
CONTENT_CHANGE = 2
IMT_CHANGE = 4
NOT_PRESENT = 1
NO_CHANGE = 0
OTHER_CHANGE = 32
OWNER_CHANGE = 16
UNKNOWN = -1
class UriReferenceFile(RawFile)

Methods

__init__(self, path, acl, owner, imt, href)
Overrides: __init__ from class RawFile
createContent(self, repo, quiet)
Called when we need to add our content to the repo
Overrides: createContent from class RawFile
updateContent(self, repo, quiet)
Called when we need to update our content in the repo
Overrides: updateContent from class RawFile

Methods inherited from class RawFile

Members

resourceType = 17

Members inherited from class RawFile

Members inherited from class IndicatorBase

class User(XmlDocument)

Methods

__init__(self, userName, acl, owner, imt, docDef, basePath, password=None, data={}, passwdHash=None)
Overrides: __init__ from class XmlDocument
createContent(self, repo, quiet)
Called when we need to add our content to the repo
Overrides: createContent from class XmlDocument
updateContent(self, repo, quiet)
Called when we need to update our content in the repo
Overrides: updateContent from class XmlDocument
updateOther(self, repo, quiet)
Overrides: updateOther from class XmlDocument

Methods inherited from class RawFile

Members

resourceType = 7

Members inherited from class XmlDocument

Members inherited from class RawFile

Members inherited from class IndicatorBase

class XPathDocumentDefinition(XmlDocument)

Methods inherited from class XmlDocument

Methods inherited from class RawFile

Members

docName = 'XPathDocumentDefinition'
resourceType = 9

Members inherited from class RawFile

Members inherited from class IndicatorBase

class XmlDocument(RawFile)

Methods

__init__(self, path, acl, owner, imt, docDef)
Overrides: __init__ from class RawFile
createContent(self, repo, quiet)
Called when we need to add our content to the repo
Overrides: createContent from class RawFile
updateOther(self, repo, quiet)
Overrides: updateOther from class RawFile

Methods inherited from class RawFile

Members

docName = 'XmlDocument'
resourceType = 4

Members inherited from class RawFile

Members inherited from class IndicatorBase

class XsltDocument(XmlDocument)

Methods inherited from class XmlDocument

Methods inherited from class RawFile

Members

docName = 'XsltDocument'
resourceType = 5

Members inherited from class RawFile

Members inherited from class IndicatorBase

class XsltDocumentDefinition(XmlDocument)

Methods inherited from class XmlDocument

Methods inherited from class RawFile

Members

docName = 'XsltDocumentDefinition'
resourceType = 11

Members inherited from class RawFile

Members inherited from class IndicatorBase

Functions

Deserialize(stream, refUri='')

Globals

DefaultFactory = <Ft.Xml.InputSource.InputSourceFactory instance>
EMPTY_NAMESPACE = None
XINCLUDE_NAMESPACE = u'http://www.w3.org/2001/XInclude'
XML_NAMESPACE = u'http://www.w3.org/XML/1998/namespace'
XSL_NAMESPACE = u'http://www.w3.org/1999/XSL/Transform'
g_safeAclIdents = ['super-users', 'world', 'users', 'guest', 'owner']