%ZHSLIB.PackageManager.Developer.Utils

class %ZHSLIB.PackageManager.Developer.Utils

Method Inventory

Methods

classmethod AddGlobalMapping(pNamespace As %String, pMapping As %String, pFrom As %String, pSetCollation As %Boolean = 0, pSkipActivation As %Boolean = 0, ByRef pChanged As %Boolean = 0) as %Status
classmethod AddPackageMapping(pNamespace As %String, pMapping As %String, pFrom As %String, pSkipActivation As %Boolean = 0) as %Status
classmethod AddRoutineMapping(pNamespace As %String, pMapping As %String, pType As %String = "ALL", pFrom As %String, pSkipActivation As %Boolean = 0) as %Status
classmethod BeginCaptureOutput(Output pCookie As %String) as %Status
This method enables I/O redirection (see EndCaptureOutput for retrieval). pCookie has the previous I/O redirection info.
classmethod CheckLicenseKey() as %Boolean
classmethod ConstructInvertedDependencyGraph(ByRef pDependencyGraph, Output pInvertedDependencyGraph)
Construct an inverted dependency graph from the dependency graph of a module.
@Argument pDependencyGraph Dependency graph constructed.
@Argument pInvertedDependencyGraph Inverted dependency graph constructed.
classmethod ConvertTimestampUTCToW3C(pDateTime As %TimeStamp) as %String
classmethod ConvertW3CToTimestampUTC(pDateTime As %String) as %TimeStamp
classmethod CopyItems(itemspec, source, target, qspec)
This method exports items (classes, routines, etc.) and reloads it into a different namespace The syntax for itemspec is the Name attribute in tag and tag
classmethod CopyItemsInPackage(pPackage As %String, pFromNamespace As %String, pToNamespace As %String)
Copy a package from one namespace to another. This works whether or not the contents of the package are deployed.
This copies classes and include files in the package.
classmethod CreateAndGetSSLConfig(ByRef pProperties) as %String
Returns the name of the default SSL config after creating if it it does not already exist.
classmethod CreateOrUpdateIncludeFile(pName As %String, ByRef pLineArray As %String)
Creates (or updates) an include file with name pName and contents in an indexed subscripted array pLineArray.
@Argument pName Name of include file.
@Argument pLineArray Subscripted array whose keys are indices and values correspond to lines in the include file. The top level node should have the number of lines.
classmethod EndCaptureOutput(pCookie As %String, Output pText) as %Status
This method captures the output from a program and delivers it as an array of lines
classmethod GetDatabaseDirectory(pDatabase As %String) as %String
classmethod GetDependentsAsTree(Output pTree, Output pErrorList, pModuleName As %String, pModuleVersion As %String = "", pRepoNames As %List = "") as %Status
Returns a tree of dependents, with dependent modules at the root, for a given module name (and optional version)
pRepoNames is a $ListBuild list of repositories in which to search for dependents; if blank, only currently-installed modules (and any missing dependencies) are considered.
Tree subscripts are $lb(Name,VersionString,ServerName).
@API.Method @Modifier Availability InterSystems
classmethod GetDependentsList(Output pList As %Library.ListOfObjects(ELEMENTTYPE="%ZHSLIB.PackageManager.Core.QualifiedModuleReference"), Output pErrorList, pModuleName As %String, pModuleVersion As %String = "", pRepoNames As %List = "") as %Status
Returns a flat list of dependents for a given module name (and optional version)
pRepoNames is a $ListBuild list of repositories in which to search for dependents; if blank, only currently-installed modules (and any missing dependencies) are considered.
@API.Method @Modifier Availability InterSystems
classmethod GetFlatDependencyListFromInvertedDependencyGraph(ByRef pInvertedDependencyGraph) as %Library.ListOfObjects
Given an inverted dependency graph, construct an ordered dependency list. The ordering is from least dependent module to most dependent. It is essentially a flattened dependency graph.
@Argument pInvertedDependencyGraph Inverted dependency graph.
classmethod GetGlobalDatabase(pNamespace As %String) as %String
classmethod GetGlobalDatabaseDir(pNamespace As %String) as %String
classmethod GetModuleListClose(ByRef qHandle As %Binary) as %Status
classmethod GetModuleListExecute(ByRef qHandle As %Binary, pServer As %String) as %Status
classmethod GetModuleListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod GetModuleObjectFromPath(pPath As %String, Output pFound As %Boolean) as %ZHSLIB.PackageManager.Developer.Module
Given a path to a module.xml file (directory), tries to correlate it to an instance of %ZHSLIB.PackageManager.Developer.Module. Throws errors.
classmethod GetModuleObjectFromStream(pStream As %Stream.Object, Output pFound As %Boolean) as %ZHSLIB.PackageManager.Developer.Module
Given a stream, tries to correlate it to an instance of %ZHSLIB.PackageManager.Developer.Module. Throws errors.
classmethod GetRequiredVersionExpression(pModuleName As %String, pExcludeModules As %List = "", Output pExpression As %ZHSLIB.PackageManager.Core.SemanticVersionExpression, Output pSourceList As %List) as %Status
Returns a semantic version expression capturing all version requirements for a given module name in the current namespace. A list of modules to exclude may be provided (for example, if these modules would be updated at the same time).
classmethod GetRoutineDatabase(pNamespace As %String) as %String
classmethod GetRoutineDatabaseDir(pNamespace As %String) as %String
classmethod LoadCompleted(pServerName As %String, pModuleName As %String, pVersion As %String, ByRef pParams, ByRef pDependencyGraph) as %Status
Intended to be invoked only as a work queue callback (so %status and %workqueue will be defined) Signature must match LoadModuleReference() per work queue manager conventions.
classmethod LoadDependencies(ByRef pDependencyGraph, ByRef pParams, pWorkQueue As %ZHSLIB.PackageManager.Core.WorkMgr)
Format of pDependencyGraph: pDependencyGraph("module name") = $ListBuild(,,) pDependencyGraph("module name"," ") =
classmethod LoadModuleFromArchive(pModuleName As %String, pModuleVersion As %String, pArchiveStream As %Stream.Object, ByRef pParams) as %Status
classmethod LoadModuleFromDirectory(pDirectory As %String, ByRef pParams, pOverrideDeveloperMode As %Boolean = 0, pRepository As %String = "") as %Status
classmethod LoadModuleReference(pServerName As %String, pModuleName As %String, pVersion As %String, ByRef pParams, ByRef pDependencyGraph) as %Status
classmethod LoadNewModule(pDirectory As %String, ByRef pParams, pRepository As %String = "", pSynchronous As %Boolean = 0) as %Status
classmethod LoadQualifiedReference(pReference As %ZHSLIB.PackageManager.Core.QualifiedModuleReference, ByRef pParams, ByRef pDependencyGraph) as %Status
classmethod LockWithCurrentDependencies(pModuleName As %String) as %Status
Short-term approach to lock a module's dependencies within the module manifest (rather than using a separate file).
classmethod NamespaceHasModule(pNamespace As %String, pModuleName As %String) as %Boolean
Helper method to see if pNamespace has pModule (a module name) installed. Returns false if the module is not installed (which may be because the namespace does not exist).
classmethod OrphanedResourcesClose(ByRef qHandle As %Binary) as %Status
classmethod OrphanedResourcesExecute(ByRef qHandle As %Binary, pNamespace As %String = $Namespace, pType As %String = "") as %Status
classmethod OrphanedResourcesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod RemoveGlobalMapping(pNamespace As %String, pMapping As %String = "", pSkipActivation As %Boolean = 0, ByRef pChanged As %Boolean = 0) as %Status
classmethod RemovePackageMapping(pNamespace As %String, pMapping As %String, pSkipActivation As %Boolean = 0) as %Status
classmethod RemoveRoutineMapping(pNamespace As %String, pMapping As %String, pType As %String = "ALL", pSkipActivation As %Boolean = 0) as %Status
classmethod ResolveItems(itemlist, itemspec, namespace) as %Status
This method resolves itemspec used by Name sttribute in and
classmethod SyncLoadDependencies(pModule As %ZHSLIB.PackageManager.Developer.Module, ByRef pParams)
Temporary workaround to synchronously load dependencies. Can be removed once HSIEO-4450 is complete.
classmethod UninstallAll(pForce As %Boolean, ByRef pParams) as %Status
Uninstalls all modules from the current namespace

Queries

query GetModuleList(pServer As %String)
Selects Name As %String, Version As %String
query OrphanedResources(pNamespace As %String = $Namespace, pType As %String = "")
Selects Name As %String
Feedback