MasterMgrClient

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

TEMERITY

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

us.temerity.pipeline
Class MasterMgrClient

java.lang.Object
  us.temerity.pipeline.BaseMgrClient
      us.temerity.pipeline.MasterMgrClient

All Implemented Interfaces:: MasterMgrLightClient

public class MasterMgrClient
extends BaseMgrClient
implements MasterMgrLightClient
extends BaseMgrClient
implements MasterMgrLightClient

A connection to the Pipeline master manager daemon.

This class handles network communication with the Pipeline master manager daemon plmaster(1). This class represents the interface used by all Pipeline client programs and end user tools to interact with the Pipeline system.

Field Summary

Fields inherited from class us.temerity.pipeline.BaseMgrClient
`pHostname, pLongTransactionStart, pPort`

Constructor Summary
`MasterMgrClient()` Construct a new master manager client.
`MasterMgrClient(boolean forceLongTransactions)` Construct a new master manager client.

Method Summary
`void`	`addAnnotation(String nname, String aname, BaseAnnotation annot)` Add the given annotation to the set of current annotations for the given node.
`void`	`addSecondary(NodeID nodeID, FileSeq fseq)` Add a secondary file sequence to a working version.
`void`	`addSecondary(String author, String view, String name, FileSeq fseq)` Add a secondary file sequence to a working version.
`String`	`archive(String prefix, MappedSet<String,VersionID> versions, BaseArchiver archiver, String toolset)` Archive the files associated with the given checked-in versions.
`String`	`archive(String prefix, MappedSet<String,VersionID> versions, BaseArchiver archiver, String toolset, StringBuilder dryRunResults)` Archive the files associated with the given checked-in versions.
`ArrayList<ArchiveInfo>`	`archiveQuery(String pattern, Integer maxArchives)` Get archive related information about the checked-in versions which match the given criteria.
`void`	`backupDatabase(Path dir)` Create a set of database backup files.
`void`	`checkIn(NodeID nodeID, String msg, VersionID.Level level)` Check-In the tree of nodes rooted at a working version.
`void`	`checkIn(String author, String view, String name, String msg, VersionID.Level level)` Check-In the tree of nodes rooted at a working version.
`MappedSet<String,Long>`	`checkOut(NodeID nodeID, VersionID vid, CheckOutMode mode, CheckOutMethod method)` Check-Out the tree of nodes rooted at a working version.
`MappedSet<String,Long>`	`checkOut(String author, String view, String name, VersionID vid, CheckOutMode mode, CheckOutMethod method)` Check-Out the tree of nodes rooted at a working version.
`NodeMod`	`clone(String author, String view, String oldName, String newName)` Register a new node who's properties are identical to an existing working version.
`NodeMod`	`clone(String author, String view, String oldName, String newName, boolean cloneAction, boolean cloneLinks, boolean cloneFiles, boolean cloneAnnotations)` Register a new node who's properties are identical to an existing working version.
`void`	`cloneFiles(NodeID sourceID, NodeID targetID)` Replace the primary files associated with one node with the primary files of another node.
`void`	`cloneFiles(NodeID sourceID, NodeID targetID, MappedSet<FileSeq,FileSeq> secondarySequences)` Replace the primary and selected secondary files associated with one node with the primary and selected secondary files of another node.
`void`	`cloneFiles(NodeID sourceID, NodeID targetID, MappedSet<FileSeq,FileSeq> secondarySequences, FrameRange sourceRange, FrameRange targetRange)` Replace the primary and selected secondary files associated with one node with the primary and selected secondary files of another node.
`void`	`createInitialPanelLayout(String name, String author, String view)` Create a default saved panel layout file.
`Toolset`	`createToolset(String name, String desc, Collection<PackageVersion> packages, OsType os)` Create a new toolset from a set of toolset packages.
`PackageVersion`	`createToolsetPackage(PackageMod mod, String desc, VersionID.Level level, OsType os)` Create a new read-only toolset package from a modifiable package.
`void`	`createWorkingArea(String author, String view)` Create a new empty working area.
`void`	`delete(String name, boolean removeFiles)` Delete all working and checked-in versions of a node and optionally remove all associated working area files.
`void`	`denyRestore(TreeMap<String,TreeSet<VersionID>> versions)` Deny the request to restore the given set of checked-in versions.
`TreeMap<String,NodeStatus>`	`downstreamStatus(String author, String view, TreeSet<String> rootNames, DownstreamMode dmode)` Get the downstream only status of multiple nodes.
`void`	`editingFinished(Long editID)` Signal that an Editor plugin has finished editing files associated with the working version of a node.
`Long`	`editingStarted(NodeID nodeID, BaseEditor editor)` Signal that an Editor plugin has started editing files associated with the given working version of a node.
`void`	`editPrivileges(TreeMap<String,Privileges> privs)` Change the administrative privileges for the given users.
`void`	`evolve(NodeID nodeID, VersionID vid)` Change the checked-in version upon which the working version is based without modifying the working version properties, links or associated files.
`void`	`evolve(String author, String view, String name, VersionID vid)` Change the checked-in version upon which the working version is based without modifying the working version properties, links or associated files.
`NodeBundle`	`extractBundle(Path bundlePath)` Extract the node metadata from a node bundle containing a tree of nodes packed at another site.
`Path`	`extractSiteVersion(String name, VersionID vid, TreeSet<String> referenceNames, String localSiteName, TreeSet<FileSeq> replaceSeqs, TreeMap<String,String> replacements, Path dir)` Creates a JAR archive containing both files and metadata associated with a checked-in version of a node suitable for transfer to a remote site.
`PluginMenuLayout`	`getActionMenuLayout()` Get the default layout of the action plugin menu.
`PluginMenuLayout`	`getActionMenuLayout(String name)` Get the layout of the action plugin menu associated with a toolset.
`TreeSet<String>`	`getActiveToolsetNames()` Get the names of the currently active Unix toolsets.
`TreeMap<VersionID,NodeVersion>`	`getAllCheckedInVersions(String name)` Get all of the checked-in versions of a node.
`TreeMap<String,TreeSet<OsType>>`	`getAllToolsetNames()` Get the names of all toolsets for all operating systems.
`DoubleMap<String,OsType,TreeSet<VersionID>>`	`getAllToolsetPackageNames()` Get the names and revision numbers of all toolset packages for all operating systems.
`BaseAnnotation`	`getAnnotation(NodeID nodeID, String aname)` Get a unified view of a specific named annotation from both node and working version of the node in a particular working area view.
`BaseAnnotation`	`getAnnotation(String nname, String aname)` Get a specific per-node annotation for the given node.
`BaseAnnotation`	`getAnnotation(String author, String view, String nname, String aname)` Get a unified view of a specific named annotation from both node and working version of the node in a particular working area view.
`PluginMenuLayout`	`getAnnotationMenuLayout()` Get the default layout of the annotation plugin menu.
`PluginMenuLayout`	`getAnnotationMenuLayout(String name)` Get the layout of the annotation plugin menu associated with a toolset.
`TreeMap<String,BaseAnnotation>`	`getAnnotations(NodeID nodeID)` Get a unified view of all annotation from both node and working version of the node in a particular working area view.
`TreeMap<String,BaseAnnotation>`	`getAnnotations(String name)` Get all of the per-node annotations for the given node.
`TreeMap<String,BaseAnnotation>`	`getAnnotations(String author, String view, String name)` Get a unified view of all annotation from both node and working version of the node in a particular working area view.
`DoubleMap<NodeID,String,BaseAnnotation>`	`getAnnotations(TreeSet<NodeID> nodeIDs)` Get a unified view of all annotation from both node and working version for a set of nodes in working areas.
`ArchiveVolume`	`getArchive(String name)` Get the complete information about the archive with the given name.
`TreeMap<String,Long>`	`getArchivedOn()` Get the names and creation timestamps of all existing archives.
`String`	`getArchivedOutput(String aname)` Get the STDOUT output from running the Archiver plugin during the creation of the given archive volume.
`DoubleMap<String,VersionID,Long>`	`getArchivedSizes(MappedSet<String,VersionID> versions)` Calculate the total size (in bytes) of the files associated with the given checked-in versions for archival purposes.
`PluginMenuLayout`	`getArchiverMenuLayout()` Get the default layout of the archiver plugin menu.
`PluginMenuLayout`	`getArchiverMenuLayout(String name)` Get the layout of the archiver plugin menu associated with a toolset.
`DoubleMappedSet<String,VersionID,String>`	`getArchivesContaining(MappedSet<String,VersionID> versions)` Get the names of the archive volumes containing the given checked-in versions.
`PluginMenuLayout`	`getBuilderCollectionMenuLayout()` Get the default layout of the builder collection plugin menu.
`PluginMenuLayout`	`getBuilderCollectionMenuLayout(String name)` Get the layout of the builder collection plugin menu associated with a toolset.
`TreeMap<VersionID,TreeMap<FileSeq,boolean[]>>`	`getCheckedInFileNovelty(String name)` Get whether each file associated with each checked-in version of a node contains new data not present in the previous checked-in versions.
`DoubleMap<VersionID,String,LinkVersion>`	`getCheckedInLinks(String name)` Get the upstream links of all checked-in versions of a node.
`TreeSet<String>`	`getCheckedInNames(String pattern)` Get the names of the nodes with at least one checked-in version who's name matches the given search pattern.
`NodeVersion`	`getCheckedInVersion(String name, VersionID vid)` Get the checked-in version of a node.
`TreeSet<VersionID>`	`getCheckedInVersionIDs(String name)` Get the revision numbers of all checked-in versions of a node.
`PluginMenuLayout`	`getComparatorMenuLayout()` Get the default layout of the comparator plugin menu.
`PluginMenuLayout`	`getComparatorMenuLayout(String name)` Get the layout of the comparator plugin menu associated with a toolset.
`TreeSet<SuffixEditor>`	`getDefaultSuffixEditors()` Get the site default filename suffix to default editor mappings.
`String`	`getDefaultToolsetName()` Get the name of the default Unix toolset.
`DoubleMap<String,VersionID,LinkVersion>`	`getDownstreamCheckedInLinks(String name, VersionID vid)` Get the links from specific checked-in version to all other checked-in node versions downstream.
`BaseEditor`	`getEditorForSuffix(String suffix)` Get the current user's default editor plugin for a filename suffix.
`PluginMenuLayout`	`getEditorMenuLayout()` Get the default layout of the editor plugin menu.
`PluginMenuLayout`	`getEditorMenuLayout(String name)` Get the layout of the editor plugin menu associated with a toolset.
`TreeMap<VersionID,LogMessage>`	`getHistory(String name)` Get the log messages associated with all checked-in versions of a node.
`String`	`getInitialPanelLayout(String author, String view)` Retrieve the contents of the site default saved panel layout file.
`TreeSet<VersionID>`	`getIntermediateVersionIDs(String name)` Get the revision numbers of all checked-in versions of a node do not save intermediate (temporary) version of files in the repository.
`PluginMenuLayout`	`getKeyChooserMenuLayout()` Get the default layout of the key chooser plugin menu.
`PluginMenuLayout`	`getKeyChooserMenuLayout(String name)` Get the layout of the key chooser plugin menu associated with a toolset.
`LogControls`	`getLogControls()` Get the current logging levels.
`MasterExtensionConfig`	`getMasterExtensionConfig(String name)` Get the current master extension configurations.
`TreeMap<String,MasterExtensionConfig>`	`getMasterExtensionConfigs()` Get the current master extension configurations.
`PluginMenuLayout`	`getMasterExtMenuLayout()` Get the default layout of the master extension plugin menu.
`PluginMenuLayout`	`getMasterExtMenuLayout(String name)` Get the layout of the master extension plugin menu associated with a toolset.
`TreeMap<String,VersionID>`	`getMissingSiteVersionRefs(Path jarPath)` Checks each of the source nodes referenced by the extracted node contained in the given JAR archive and returns the names and versions of any of them that are not already in the node database.
`MappedLinkedList<Long,BaseNodeEvent>`	`getNodeEvents(TreeSet<String> names, TreeSet<String> users, TimeInterval interval)` Retrieve the record of all significant operations involving the given nodes and users during the specified time interval.
`TreeSet<String>`	`getNodeNames(String pattern)` Get the names of all nodes who's name matches the given search pattern.
`String`	`getNodeOwning(String path)` Get the name of the node associated with the given file.
`protected ObjectInput`	`getObjectInput(InputStream in)` Get the object input given a socket input stream.
`DoubleMap<String,VersionID,Long>`	`getOfflineSizes(MappedSet<String,VersionID> versions)` Calculate the total size (in bytes) of the files associated with the given checked-in versions for offlining purposes.
`TreeSet<VersionID>`	`getOfflineVersionIDs(String name)` Get the revision nubers of all offline checked-in versions of the given node.
`TreeMap<OsType,Toolset>`	`getOsToolsets(String name)` Get all OS specific toolsets with the given name.
`PluginSet`	`getPackageActionPlugins(String name, VersionID vid)` Get the action plugins associated with a toolset package.
`PluginSet`	`getPackageAnnotationPlugins(String name, VersionID vid)` Get the annotation plugins associated with a toolset package.
`PluginSet`	`getPackageArchiverPlugins(String name, VersionID vid)` Get the archiver plugins associated with a toolset package.
`PluginSet`	`getPackageBuilderCollectionPlugins(String name, VersionID vid)` Get the builder collection plugins associated with a toolset package.
`PluginSet`	`getPackageComparatorPlugins(String name, VersionID vid)` Get the comparator plugins associated with a toolset package.
`PluginSet`	`getPackageEditorPlugins(String name, VersionID vid)` Get the editor plugins associated with a toolset package.
`PluginSet`	`getPackageKeyChooserPlugins(String name, VersionID vid)` Get the key chooser plugins associated with a toolset package.
`PluginSet`	`getPackageMasterExtPlugins(String name, VersionID vid)` Get the master extension plugins associated with a toolset package.
`PluginSet`	`getPackageQueueExtPlugins(String name, VersionID vid)` Get the queue extension plugins associated with a toolset package.
`PluginSet`	`getPackageToolPlugins(String name, VersionID vid)` Get the tool plugins associated with a toolset package.
`TreeMap<PluginType,PluginMenuLayout>`	`getPluginMenuLayouts(String name)` Get the layout plugin menus for all plugin types associated with a toolset.
`PrivilegeDetails`	`getPrivilegeDetails()` Get the privileges granted to the current user with respect to all other users.
`PrivilegeDetails`	`getPrivilegeDetails(String uname)` Get the privileges granted to a specific user with respect to all other users.
`TreeMap<String,Privileges>`	`getPrivileges()` Get the administrative privileges for all users.
`PluginMenuLayout`	`getQueueExtMenuLayout()` Get the default layout of the queue extension plugin menu.
`PluginMenuLayout`	`getQueueExtMenuLayout(String name)` Get the layout of the queue extension plugin menu associated with a toolset.
`TreeMap<String,TreeSet<Long>>`	`getRestoredOn()` Get the names and restoration timestamps of all existing archives.
`String`	`getRestoredOutput(String aname, long stamp)` Get the STDOUT output from running the Archiver plugin during the restoration of the given archive volume at the given time.
`TreeMap<String,TreeMap<VersionID,RestoreRequest>>`	`getRestoreRequests()` Get the requests for restoration of checked-in versions.
`DoubleMap<String,VersionID,Long>`	`getRestoreSizes(MappedSet<String,VersionID> versions)` Calculate the total size (in bytes) of the files associated with the given checked-in versions for restoration purposes.
`MasterControls`	`getRuntimeControls()` Get the current runtime performance controls.
`TreeMap<PluginType,PluginSet>`	`getSelectPackagePlugins(String pname, VersionID pvid)` Get all types of plugins associated with the given packages.
`TripleMap<String,VersionID,PluginType,PluginSet>`	`getSelectPackagePlugins(TreeMap<String,TreeSet<VersionID>> packages)` Get all types of plugins associated with the given packages.
`protected String`	`getServerDownMessage()` Get the error message to be shown when the server cannot be contacted.
`TreeSet<SuffixEditor>`	`getSuffixEditors()` Get the current user's filename suffix to default editor mappings.
`PluginMenuLayout`	`getToolMenuLayout()` Get the default layout of the tool plugin menu.
`PluginMenuLayout`	`getToolMenuLayout(String name)` Get the layout of the tool plugin menu associated with a toolset.
`Toolset`	`getToolset(String name)` Get a Unix toolset.
`Toolset`	`getToolset(String name, OsType os)` Get an OS specific toolset.
`PluginSet`	`getToolsetActionPlugins(String name)` Get the action plugins associated with all packages of a toolset.
`PluginSet`	`getToolsetAnnotationPlugins(String name)` Get the annotation plugins associated with all packages of a toolset.
`PluginSet`	`getToolsetArchiverPlugins(String name)` Get the archiver plugins associated with all packages of a toolset.
`PluginSet`	`getToolsetBuilderCollectionPlugins(String name)` Get the builder collection plugins associated with all packages of a toolset.
`PluginSet`	`getToolsetComparatorPlugins(String name)` Get the comparator plugins associated with all packages of a toolset.
`PluginSet`	`getToolsetEditorPlugins(String name)` Get the editor plugins associated with all packages of a toolset.
`TreeMap<String,String>`	`getToolsetEnvironment(String author, String view, String tname)` Get the cooked Unix toolset environment.
`TreeMap<String,String>`	`getToolsetEnvironment(String author, String view, String tname, OsType os)` Get the cooked OS specific toolset environment.
`PluginSet`	`getToolsetKeyChooserPlugins(String name)` Get the key chooser plugins associated with all packages of a toolset.
`PluginSet`	`getToolsetMasterExtPlugins(String name)` Get the master extension plugins associated with all packages of a toolset.
`TreeSet<String>`	`getToolsetNames()` Get the names of all Unix toolsets.
`TreeSet<String>`	`getToolsetNames(OsType os)` Get the names of all toolsets for an operating system.
`PackageVersion`	`getToolsetPackage(String name, VersionID vid)` Get a Unix toolset package.
`PackageVersion`	`getToolsetPackage(String name, VersionID vid, OsType os)` Get an OS specific toolset package.
`TreeMap<String,TreeSet<VersionID>>`	`getToolsetPackageNames()` Get the names and revision numbers of all Unix toolset packages.
`TreeMap<String,TreeSet<VersionID>>`	`getToolsetPackageNames(OsType os)` Get the names and revision numbers of all OS specific toolset packages.
`TripleMap<String,VersionID,OsType,PackageVersion>`	`getToolsetPackages(DoubleMap<String,VersionID,TreeSet<OsType>> packages)` Get multiple OS specific toolset packages.
`PluginSet`	`getToolsetQueueExtPlugins(String name)` Get the queue extension plugins associated with all packages of a toolset.
`PluginSet`	`getToolsetToolPlugins(String name)` Get the tool plugins associated with all packages of a toolset.
`MappedSet<String,Long>`	`getUnfinishedJobs(String author, String view)` Get all unfinished jobs for the any nodes contained in the given working area.
`MappedSet<String,Long>`	`getUnfinishedJobs(String author, String view, String pattern)` Get all unfinished jobs for the matching nodes contained in the given working area.
`WorkGroups`	`getWorkGroups()` Get the work groups used to determine the scope of administrative privileges.
`TreeMap<String,TreeSet<String>>`	`getWorkingAreas()` Get the table of current working area authors and views.
`TreeMap<String,TreeSet<String>>`	`getWorkingAreasContaining(String name)` Get the table of the working areas containing the given node.
`TreeMap<String,TreeSet<String>>`	`getWorkingAreasEditing(String name)` Get the table of the working areas in which the given node is currently being edited.
`TreeSet<String>`	`getWorkingNames(String author, String view, String pattern)` Get the names of the nodes in a working area matching the given search pattern.
`TreeSet<String>`	`getWorkingRootNames(String author, String view)` Get the names of the most downstream nodes in a working area.
`NodeMod`	`getWorkingVersion(NodeID nodeID)` Get the working version of a node.
`NodeMod`	`getWorkingVersion(String author, String view, String name)` Get the working version of a node.
`boolean`	`hasUnfinishedJobs(String author, String view)` Whether the given working area contains any nodes for which there are unfinished jobs currently in the queue.
`boolean`	`hasUnfinishedJobs(String author, String view, String pattern)` Whether the given working area contains matching nodes for which there are unfinished jobs currently in the queue.
`void`	`insertSiteVersion(Path jarPath)` Inserts a node version into the local node database previously extraced from a remote site using the `extractSiteVersion(java.lang.String, us.temerity.pipeline.VersionID, java.util.TreeSet, java.lang.String, java.util.TreeSet, java.util.TreeMap, us.temerity.pipeline.Path)` method.
`boolean`	`isSiteVersionInserted(Path jarPath)` Whether the extracted node contained in the given JAR archive has already been inserted into the node database.
`void`	`link(NodeID target, LinkCommon link)` Create or modify an existing link between the working versions.
`void`	`link(String author, String view, String target, LinkCommon link)` Create or modify an existing link between the working versions.
`void`	`link(String author, String view, String target, String source, LinkPolicy policy)` Create or modify an existing link between the working versions.
`void`	`link(String author, String view, String target, String source, LinkPolicy policy, LinkRelationship relationship, Integer offset)` Create or modify an existing link between the working versions.
`void`	`lock(NodeID nodeID, VersionID vid)` Lock the working version of a node to a specific checked-in version.
`void`	`lock(String author, String view, String name, VersionID vid)` Lock the working version of a node to a specific checked-in version.
`NodeVersion`	`lookupSiteVersion(Path jarPath)` Lookup the NodeVersion contained within the extracted site version JAR archive.
`void`	`modifyProperties(String author, String view, NodeMod mod)` Set the node properties of the working version of a node.
`void`	`offline(MappedSet<String,VersionID> versions)` Remove the repository files associated with the given checked-in versions.
`void`	`offline(MappedSet<String,VersionID> versions, StringBuilder dryRunResults)` Remove the repository files associated with the given checked-in versions.
`ArrayList<OfflineInfo>`	`offlineQuery(String pattern, Integer excludeLatest, Integer minArchives, boolean unusedOnly)` Get offline related information about the checked-in versions which match the given criteria.
`Path`	`packNodes(NodeID nodeID)` Create a new node bundle (JAR achive) by packing up a tree of nodes from a working area rooted at the given node.
`Path`	`packNodes(String author, String view, String name)` Create a new node bundle (JAR achive) by packing up a tree of nodes from a working area rooted at the given node.
`NodeMod`	`register(String author, String view, NodeMod mod)` Register an initial working version of a node.
`void`	`release(NodeID nodeID, boolean removeFiles)` Release the working versions of nodes and optionally remove the associated working area files.
`void`	`release(String author, String view, String name, boolean removeFiles)` Release the working version of a node and optionally remove the associated working area files.
`void`	`release(String author, String view, TreeSet<String> names, boolean removeFiles)` Release the working version of a node and optionally remove the associated working area files.
`void`	`removeAnnotation(String nname, String aname)` Remove a specific annotation from a node.
`void`	`removeAnnotations(String name)` Remove all annotations from a node.
`void`	`removeFiles(NodeID nodeID, TreeSet<Integer> indices)` Remove the working area files associated with a node.
`void`	`removeFiles(String author, String view, String name, TreeSet<Integer> indices)` Remove the working area files associated with a node.
`void`	`removeMasterExtensionConfig(String name)` Remove an existing the master extension configuration.
`void`	`removeSecondary(NodeID nodeID, FileSeq fseq)` Remove a secondary file sequence from a working version.
`void`	`removeSecondary(String author, String view, String name, FileSeq fseq)` Remove a secondary file sequence from a working version.
`void`	`removeWorkingArea(String author, String view)` Remove an entire working area.
`void`	`rename(NodeID nodeID, FilePattern pattern, boolean renameFiles)` Rename a working version of a node which has never been checked-in.
`void`	`rename(String author, String view, String name, FilePattern pattern, boolean renameFiles)` Rename a working version of a node which has never been checked-in.
`TreeSet<Long>`	`renumber(NodeID nodeID, FrameRange range, boolean removeFiles)` Renumber the frame ranges of the file sequences associated with a node.
`TreeSet<Long>`	`renumber(String author, String view, String name, FrameRange range, boolean removeFiles)` Renumber the frame ranges of the file sequences associated with a node.
`void`	`requestRestore(TreeMap<String,TreeSet<VersionID>> versions)` Submit a request to restore the given set of checked-in versions.
`void`	`restore(String name, TreeMap<String,TreeSet<VersionID>> versions, BaseArchiver archiver, String toolset)` Restore the given checked-in versions from the given archive volume.
`void`	`restore(String name, TreeMap<String,TreeSet<VersionID>> versions, BaseArchiver archiver, String toolset, StringBuilder dryRunResults)` Restore the given checked-in versions from the given archive volume.
`TreeMap<String,TreeSet<VersionID>>`	`restoreQuery(String pattern)` Get the names and revision numbers of the offline checked-in versions who's names match the given criteria.
`LinkedList<QueueJobGroup>`	`resubmitJobs(NodeID nodeID, TreeSet<FileSeq> targetSeqs, Integer batchSize, Integer priority, Integer rampUp, Float maxLoad, Long minMemory, Long minDisk, Set<String> selectionKeys, Set<String> licenseKeys, Set<String> hardwareKeys)` Resubmit the group of jobs needed to regenerate the selected `Stale` primary file sequences for the tree of nodes rooted at the given node.
`void`	`revertFiles(NodeID nodeID, TreeMap<String,VersionID> files)` Revert specific working area files to an earlier checked-in version of the files.
`void`	`revertFiles(String author, String view, String name, TreeMap<String,VersionID> files)` Revert specific working area files to an earlier checked-in version of the files.
`void`	`setActionMenuLayout(PluginMenuLayout layout)` Set the default layout of the action plugin menu.
`void`	`setActionMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the action plugin menu associated with a toolset.
`void`	`setAnnotationMenuLayout(PluginMenuLayout layout)` Set the default layout of the annotation plugin menu.
`void`	`setAnnotationMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the annotation plugin menu associated with a toolset.
`void`	`setArchiverMenuLayout(PluginMenuLayout layout)` Set the default layout of the archiver plugin menu.
`void`	`setArchiverMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the archiver plugin menu associated with a toolset.
`void`	`setBuilderCollectionMenuLayout(PluginMenuLayout layout)` Set the default layout of the builder collection plugin menu.
`void`	`setBuilderCollectionMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the builder collection plugin menu associated with a toolset.
`void`	`setComparatorMenuLayout(PluginMenuLayout layout)` Set the default layout of the comparator plugin menu.
`void`	`setComparatorMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the comparator plugin menu associated with a toolset.
`void`	`setDefaultToolsetName(String name)` Set the default Unix toolset name.
`void`	`setEditorMenuLayout(PluginMenuLayout layout)` Set the default layout of the editor plugin menu.
`void`	`setEditorMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the editor plugin menu associated with a toolset.
`void`	`setKeyChooserMenuLayout(PluginMenuLayout layout)` Set the default layout of the key chooser plugin menu.
`void`	`setKeyChooserMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the key chooser plugin menu associated with a toolset.
`void`	`setLogControls(LogControls controls)` Set the current logging levels.
`void`	`setMasterExtensionConfig(MasterExtensionConfig extension)` Add or modify an existing the master extension configuration.
`void`	`setMasterExtMenuLayout(PluginMenuLayout layout)` Set the default layout of the master extension plugin menu.
`void`	`setMasterExtMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the master extension plugin menu associated with a toolset.
`void`	`setPackageActionPlugins(String name, VersionID vid, PluginSet plugins)` Set the action plugins associated with a toolset package.
`void`	`setPackageAnnotationPlugins(String name, VersionID vid, PluginSet plugins)` Set the annotation plugins associated with a toolset package.
`void`	`setPackageArchiverPlugins(String name, VersionID vid, PluginSet plugins)` Set the archiver plugins associated with a toolset package.
`void`	`setPackageBuilderCollectionPlugins(String name, VersionID vid, PluginSet plugins)` Set the builder collection plugins associated with a toolset package.
`void`	`setPackageComparatorPlugins(String name, VersionID vid, PluginSet plugins)` Set the comparator plugins associated with a toolset package.
`void`	`setPackageEditorPlugins(String name, VersionID vid, PluginSet plugins)` Set the editor plugins associated with a toolset package.
`void`	`setPackageKeyChooserPlugins(String name, VersionID vid, PluginSet plugins)` Set the key chooser plugins associated with a toolset package.
`void`	`setPackageMasterExtPlugins(String name, VersionID vid, PluginSet plugins)` Set the master extension plugins associated with a toolset package.
`void`	`setPackageQueueExtPlugins(String name, VersionID vid, PluginSet plugins)` Set the queue extension plugins associated with a toolset package.
`void`	`setPackageToolPlugins(String name, VersionID vid, PluginSet plugins)` Set the tool plugins associated with a toolset package.
`void`	`setQueueExtMenuLayout(PluginMenuLayout layout)` Set the default layout of the queue extension plugin menu.
`void`	`setQueueExtMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the queue extension plugin menu associated with a toolset.
`void`	`setRuntimeControls(MasterControls controls)` Set the current runtime performance controls.
`void`	`setSuffixEditors(TreeSet<SuffixEditor> editors)` Set the current user's filename suffix to default editor mappings.
`void`	`setToolMenuLayout(PluginMenuLayout layout)` Set the default layout of the tool plugin menu.
`void`	`setToolMenuLayout(String name, PluginMenuLayout layout)` Set the layout of the tool plugin menu associated with a toolset.
`void`	`setToolsetActive(String name, boolean isActive)` Set the active/inactive state of a Unix toolset.
`void`	`setWorkGroups(WorkGroups groups)` Set the work groups used to determine the scope of administrative privileges.
`void`	`shutdown()` Order the server to refuse any further requests and then to exit as soon as all currently pending requests have be completed.
`void`	`shutdown(boolean shutdownJobMgrs, boolean shutdownPluginMgr)` Order the server to refuse any further requests and then to exit as soon as all currently pending requests have be completed.
`NodeStatus`	`status(NodeID nodeID)` Get the heavyweight upstream status of the tree of nodes rooted at a node.
`NodeStatus`	`status(NodeID nodeID, boolean lightweight, DownstreamMode dmode)` Get the status of the tree of nodes rooted at a node.
`NodeStatus`	`status(String author, String view, String name)` Get the heavyweight upstream status of the tree of nodes rooted at a node.
`NodeStatus`	`status(String author, String view, String name, boolean lightweight, DownstreamMode dmode)` Get the status of the tree of nodes rooted at a node.
`TreeMap<String,NodeStatus>`	`status(String author, String view, TreeSet<String> rootNames, TreeSet<String> heavyNames, DownstreamMode dmode)` Get the status of multiple possibly overlapping trees of nodes.
`LinkedList<QueueJobGroup>`	`submitJobs(NodeID nodeID, TreeSet<Integer> indices)` Submit the group of jobs needed to regenerate the selected `Stale` files associated with the tree of nodes rooted at the given node.
`LinkedList<QueueJobGroup>`	`submitJobs(NodeID nodeID, TreeSet<Integer> indices, Integer batchSize, Integer priority, Integer rampUp, Float maxLoad, Long minMemory, Long minDisk, Set<String> selectionKeys, Set<String> licenseKeys, Set<String> hardwareKeys)` Submit the group of jobs needed to regenerate the selected `Stale` files associated with the tree of nodes rooted at the given node.
`LinkedList<QueueJobGroup>`	`submitJobs(String author, String view, String name, TreeSet<Integer> indices)` Submit the group of jobs needed to regenerate the selected `Stale` files associated with a tree of nodes rooted at the given node.
`LinkedList<QueueJobGroup>`	`submitJobs(String author, String view, String name, TreeSet<Integer> indices, Integer batchSize, Integer priority, Integer rampUp, Float maxLoad, Long minMemory, Long minDisk, Set<String> selectionKeys, Set<String> licenseKeys, Set<String> hardwareKeys)` Submit the group of jobs needed to regenerate the selected `Stale` files associated with the tree of nodes rooted at the given node.
`void`	`unlink(NodeID target, String source)` Destroy an existing link between the working versions.
`void`	`unlink(String author, String view, String target, String source)` Destroy an existing link between the working versions.
`void`	`unpackNodes(Path bundlePath, String author, String view, boolean releaseOnError, ActionOnExistence actOnExist, TreeMap<String,VersionID> lockedVersions, TreeMap<String,String> toolsetRemap, TreeMap<String,String> selectionKeyRemap, TreeMap<String,String> licenseKeyRemap, TreeMap<String,String> hardwareKeyRemap)` Unpack a node bundle containing a tree of nodes packed at another site into the given working area.
`NodeTreeComp`	`updatePaths(String author, String view, TreeMap<String,Boolean> paths)` Update the children of all node path components along the given paths which are visible within a working area view owned by the given user.
`NodeTreeComp`	`updatePaths(String author, String view, TreeSet<String> paths)` Update the immediate children of all node path components along the given paths which are visible within a working area view owned by the given user.
`void`	`vouch(NodeID nodeID)` Vouch for the up-to-date status of the working area files associated with a node.
`void`	`vouch(String author, String view, String name)` Vouch for the up-to-date status of the working area files associated with a node.

Methods inherited from class us.temerity.pipeline.BaseMgrClient
`abortOnTimeout, disconnect, getForceLongTransactions, getHostname, getPort, handleFailure, handleSimpleResponse, performLongTransaction, performTransaction, performTransaction, ping, ping, setForceLongTransactions, shutdownTransaction, verifyConnection, waitForConnection`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

MasterMgrClient

public MasterMgrClient()

Construct a new master manager client.

MasterMgrClient

public MasterMgrClient(boolean forceLongTransactions)

Construct a new master manager client.

Parameters:: forceLongTransactions - Whether to treat all uses of BaseMgrClient.performTransaction(java.lang.Object, java.lang.Object) like BaseMgrClient.performLongTransaction(java.lang.Object, java.lang.Object, int, int) with an infinite request timeout and a 60-second response retry interval with infinite retries.

Method Detail

shutdown

public void shutdown(boolean shutdownJobMgrs,
                     boolean shutdownPluginMgr)
              throws PipelineException

Order the server to refuse any further requests and then to exit as soon as all currently pending requests have be completed.

Parameters:: shutdownJobMgrs - Whether to command the queue manager to shutdown all job servers before exiting.; shutdownPluginMgr - Whether to shutdown the plugin manager before exiting.
Throws:: PipelineException

shutdown

public void shutdown()
              throws PipelineException

Order the server to refuse any further requests and then to exit as soon as all currently pending requests have be completed.

Overrides:: shutdown in class BaseMgrClient

Throws:: PipelineException

getWorkGroups

public WorkGroups getWorkGroups()
                         throws PipelineException

Get the work groups used to determine the scope of administrative privileges.

Specified by:: getWorkGroups in interface MasterMgrLightClient

Returns:: The work groups.
Throws:: PipelineException - If unable to get the work groups.

setWorkGroups

public void setWorkGroups(WorkGroups groups)
                   throws PipelineException

Set the work groups used to determine the scope of administrative privileges.

This operation requires Master Admin privileges (see isMasterAdmin).

Parameters:: groups - The work groups.
Throws:: PipelineException - If unable to set the work groups.

getPrivileges

public TreeMap<String,Privileges> getPrivileges()
                                         throws PipelineException

Get the administrative privileges for all users.

If there is no entry for a given user, then no privileges are granted.

Specified by:: getPrivileges in interface MasterMgrLightClient

Returns:: The privileges for each user indexed by user name.
Throws:: PipelineException - If unable to get the privileges.

editPrivileges

public void editPrivileges(TreeMap<String,Privileges> privs)
                    throws PipelineException

Change the administrative privileges for the given users.

This operation requires Master Admin privileges.

Parameters:: privs - The privileges for each user indexed by user name.
Throws:: PipelineException - If unable to set the privileges.

getPrivilegeDetails

public PrivilegeDetails getPrivilegeDetails()
                                     throws PipelineException

Get the privileges granted to the current user with respect to all other users.

Specified by:: getPrivilegeDetails in interface MasterMgrLightClient

Returns:: The privileges of the current user.
Throws:: PipelineException - If unable to determine the privileges.

getPrivilegeDetails

public PrivilegeDetails getPrivilegeDetails(String uname)
                                     throws PipelineException

Get the privileges granted to a specific user with respect to all other users.

Specified by:: getPrivilegeDetails in interface MasterMgrLightClient

Parameters:: uname - The unique name of the user.
Returns:: The privileges of the given user.
Throws:: PipelineException - If unable to determine the privileges.

getLogControls

public LogControls getLogControls()
                           throws PipelineException

Get the current logging levels.

Throws:: PipelineException

setLogControls

public void setLogControls(LogControls controls)
                    throws PipelineException

Set the current logging levels.

Throws:: PipelineException

getRuntimeControls

public MasterControls getRuntimeControls()
                                  throws PipelineException

Get the current runtime performance controls.

Throws:: PipelineException

setRuntimeControls

public void setRuntimeControls(MasterControls controls)
                        throws PipelineException

Set the current runtime performance controls.

Throws:: PipelineException

getDefaultToolsetName

public String getDefaultToolsetName()
                             throws PipelineException

Get the name of the default Unix toolset.

Specified by:: getDefaultToolsetName in interface MasterMgrLightClient

Throws:: PipelineException - If unable to determine the default toolset name.

setDefaultToolsetName

public void setDefaultToolsetName(String name)
                           throws PipelineException

Set the default Unix toolset name.

Also makes the given toolset active if not already active.

This method will fail if the current user does not have privileged access status.

Parameters:: name - The name of the new default toolset.
Throws:: PipelineException - If unable to make the given toolset the default.

getActiveToolsetNames

public TreeSet<String> getActiveToolsetNames()
                                      throws PipelineException

Get the names of the currently active Unix toolsets.

Specified by:: getActiveToolsetNames in interface MasterMgrLightClient

Throws:: PipelineException - If unable to determine the toolset names.

setToolsetActive

public void setToolsetActive(String name,
                             boolean isActive)
                      throws PipelineException

Set the active/inactive state of a Unix toolset.

This method will fail if the current user does not have privileged access status. The current default toolset cannot be made inactive.

Parameters:: name - The name of the toolset.; isActive - Whether the toolset should be active.
Throws:: PipelineException - If unable to change the active state of the toolset.

getToolsetNames

public TreeSet<String> getToolsetNames()
                                throws PipelineException

Get the names of all Unix toolsets.

Specified by:: getToolsetNames in interface MasterMgrLightClient

Throws:: PipelineException - If unable to determine the toolset names.

getToolsetNames

public TreeSet<String> getToolsetNames(OsType os)
                                throws PipelineException

Get the names of all toolsets for an operating system.

Specified by:: getToolsetNames in interface MasterMgrLightClient

Parameters:: os - The operating system type.
Throws:: PipelineException - If unable to determine the toolset names.

getAllToolsetNames

public TreeMap<String,TreeSet<OsType>> getAllToolsetNames()
                                                   throws PipelineException

Get the names of all toolsets for all operating systems.

Specified by:: getAllToolsetNames in interface MasterMgrLightClient

Throws:: PipelineException - If unable to determine the toolset names.

getToolset

public Toolset getToolset(String name)
                   throws PipelineException

Get a Unix toolset.

Specified by:: getToolset in interface MasterMgrLightClient

Parameters:: name - The toolset name.
Throws:: PipelineException - If unable to find the toolset.

getToolset

public Toolset getToolset(String name,
                          OsType os)
                   throws PipelineException

Get an OS specific toolset.

Specified by:: getToolset in interface MasterMgrLightClient

Parameters:: name - The toolset name.; os - The operating system type.
Throws:: PipelineException - If unable to find the toolset.

getOsToolsets

public TreeMap<OsType,Toolset> getOsToolsets(String name)
                                      throws PipelineException

Get all OS specific toolsets with the given name.

Specified by:: getOsToolsets in interface MasterMgrLightClient

Parameters:: name - The toolset name.
Throws:: PipelineException - If unable to find the toolset.

getToolsetEnvironment

public TreeMap<String,String> getToolsetEnvironment(String author,
                                                    String view,
                                                    String tname)
                                             throws PipelineException

Get the cooked Unix toolset environment.

If the author argument is not null, HOME and USER environmental variables will be added to the cooked environment.

If the author and view arguments are both not null, HOME, USER and WORKING environmental variables will be added to the cooked environment.

Specified by:: getToolsetEnvironment in interface MasterMgrLightClient

Parameters:: author - The user owning the generated environment.; view - The name of the user's working area view.; tname - The toolset name.
Throws:: PipelineException - If unable to find the toolset.

getToolsetEnvironment

public TreeMap<String,String> getToolsetEnvironment(String author,
                                                    String view,
                                                    String tname,
                                                    OsType os)
                                             throws PipelineException

Get the cooked OS specific toolset environment. If the author argument is not null, HOME and USER environmental variables will be added to the cooked environment.

If the author and view arguments are both not null, HOME, USER and WORKING environmental variables will be added to the cooked environment.

Specified by:: getToolsetEnvironment in interface MasterMgrLightClient

Parameters:: author - The user owning the generated environment.; view - The name of the user's working area view.; tname - The toolset name.; os - The operating system type.
Throws:: PipelineException - If unable to find the toolset.

createToolset

public Toolset createToolset(String name,
                             String desc,
                             Collection<PackageVersion> packages,
                             OsType os)
                      throws PipelineException

Create a new toolset from a set of toolset packages.

A new toolset will only be created if the environment defined by evaluating the packages has no environment conflicts (see Toolset.hasConflicts).

All packages given must already exist on the master server. Only the names and revision numbers of the given packages are passed to the server which then looks up its own copy of the toolset package (identified by the name and revision number) to generate the toolset. This insures that the contents of the toolset package cannot be altered by client programs.

The Unix specific toolset must be create before any other operating system specializations for the toolset can be created.

This method will fail if the current user does not have privileged access status.

Parameters:: name - The name of the new toolset.; desc - The toolset description text.; packages - The packages in order of evaluation.; os - The operating system type.
Returns:: The newly created toolset.
Throws:: PipelineException - If unable to create a new toolset.

getToolsetPackageNames

public TreeMap<String,TreeSet<VersionID>> getToolsetPackageNames()
                                                          throws PipelineException

Get the names and revision numbers of all Unix toolset packages.

Specified by:: getToolsetPackageNames in interface MasterMgrLightClient

Throws:: PipelineException - If unable to determine the package names.

getToolsetPackageNames

public TreeMap<String,TreeSet<VersionID>> getToolsetPackageNames(OsType os)
                                                          throws PipelineException

Get the names and revision numbers of all OS specific toolset packages.

Specified by:: getToolsetPackageNames in interface MasterMgrLightClient

Parameters:: os - The operating system type.
Throws:: PipelineException - If unable to determine the package names.

getAllToolsetPackageNames

public DoubleMap<String,OsType,TreeSet<VersionID>> getAllToolsetPackageNames()
                                                                      throws PipelineException

Get the names and revision numbers of all toolset packages for all operating systems.

Specified by:: getAllToolsetPackageNames in interface MasterMgrLightClient

Throws:: PipelineException - If unable to determine the package names.

getToolsetPackage

public PackageVersion getToolsetPackage(String name,
                                        VersionID vid)
                                 throws PipelineException

Get a Unix toolset package.

Specified by:: getToolsetPackage in interface MasterMgrLightClient

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Throws:: PipelineException - If unable to find the toolset package.

getToolsetPackage

public PackageVersion getToolsetPackage(String name,
                                        VersionID vid,
                                        OsType os)
                                 throws PipelineException

Get an OS specific toolset package.

Specified by:: getToolsetPackage in interface MasterMgrLightClient

Parameters:: name - The toolset package name.; vid - The revision number of the package.; os - The operating system type.
Throws:: PipelineException - If unable to find the toolset package.

getToolsetPackages

public TripleMap<String,VersionID,OsType,PackageVersion> getToolsetPackages(DoubleMap<String,VersionID,TreeSet<OsType>> packages)
                                                                     throws PipelineException

Get multiple OS specific toolset packages.

Specified by:: getToolsetPackages in interface MasterMgrLightClient

Parameters:: packages - The name, revision number and operating systems of the toolset packages to retrieve.
Returns:: The packages indexed by name, revision number and operating system type.
Throws:: PipelineException - If unable to find the toolset packages.

createToolsetPackage

public PackageVersion createToolsetPackage(PackageMod mod,
                                           String desc,
                                           VersionID.Level level,
                                           OsType os)
                                    throws PipelineException

Create a new read-only toolset package from a modifiable package.

Once created, the read-only package can not be altered and will remain accessable forever. Only read-only toolset packages can be used to create toolset, therefore this method is a necessary prerequisite to building a new toolset from modifiable toolset packages.

The level argument may be null if this is the first revision of the package.

The Unix specific toolset must be create before any other operating system specializations for the toolset can be created.

This method will fail if the current user does not have privileged access status.

Parameters:: mod - The source modifiable toolset package.; desc - The package description text.; level - The revision number component level to increment.; os - The operating system type.
Returns:: The newly created package.
Throws:: PipelineException - If unable to create a new toolset packages.

getPluginMenuLayouts

public TreeMap<PluginType,PluginMenuLayout> getPluginMenuLayouts(String name)
                                                          throws PipelineException

Get the layout plugin menus for all plugin types associated with a toolset.

This is a convience method for getting the plugin menu layouts for all plugin types at one time. It provides the same functionality as the get*MenuLayout() methods below, but avoids the network overhead of calling the more specialized methods individually.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of editor plugin menus indexed by plugin type.
Throws:: PipelineException - If unable to determine the editor menu layout.

getSelectPackagePlugins

public TripleMap<String,VersionID,PluginType,PluginSet> getSelectPackagePlugins(TreeMap<String,TreeSet<VersionID>> packages)
                                                                         throws PipelineException

Get all types of plugins associated with the given packages.

This is a convience method for getting the various plugin types for a large number of package versions all at once. It provides the same functionality as the getPackage*Plugins() methods below, but avoids the network overhead of calling the more specialized methods individually for each package.

Parameters:: packages - The names and revision numbers of the packages.
Returns:: The vendors, names and revision numbers of the associated plugins indexed by the package names, revision numbers and plugin type.
Throws:: PipelineException - If unable to get the plugins.

getSelectPackagePlugins

public TreeMap<PluginType,PluginSet> getSelectPackagePlugins(String pname,
                                                             VersionID pvid)
                                                      throws PipelineException

Get all types of plugins associated with the given packages.

This is a convience method for getting the various plugin types for specific package versions all at once. It provides the same functionality as the getPackage*Plugins() methods below, but avoids the network overhead of calling the more specialized methods individually for each package.

Parameters:: pname - The package name.; pvid - The package revision number.
Returns:: The vendors, names and revision numbers of the associated plugins indexed by plugin type.
Throws:: PipelineException - If unable to get the plugins.

getEditorMenuLayout

public PluginMenuLayout getEditorMenuLayout()
                                     throws PipelineException

Get the default layout of the editor plugin menu.

Returns:: The heirarchical set of editor plugin menus.
Throws:: PipelineException - If unable to determine the editor menu layout.

setEditorMenuLayout

public void setEditorMenuLayout(PluginMenuLayout layout)
                         throws PipelineException

Set the default layout of the editor plugin menu.

Parameters:: layout - The heirarchical set of editor plugin menus.
Throws:: PipelineException - If unable to set the editor menu layout.

getEditorMenuLayout

public PluginMenuLayout getEditorMenuLayout(String name)
                                     throws PipelineException

Get the layout of the editor plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of editor plugin menus.
Throws:: PipelineException - If unable to determine the editor menu layout.

setEditorMenuLayout

public void setEditorMenuLayout(String name,
                                PluginMenuLayout layout)
                         throws PipelineException

Set the layout of the editor plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The heirarchical set of editor plugin menus.
Throws:: PipelineException - If unable to set the editor menu layout.

getToolsetEditorPlugins

public PluginSet getToolsetEditorPlugins(String name)
                                  throws PipelineException

Get the editor plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated editor plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageEditorPlugins

public PluginSet getPackageEditorPlugins(String name,
                                         VersionID vid)
                                  throws PipelineException

Get the editor plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated editor plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageEditorPlugins

public void setPackageEditorPlugins(String name,
                                    VersionID vid,
                                    PluginSet plugins)
                             throws PipelineException

Set the editor plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated editor plugins.
Throws:: PipelineException - If unable to set the plugins.

getComparatorMenuLayout

public PluginMenuLayout getComparatorMenuLayout()
                                         throws PipelineException

Get the default layout of the comparator plugin menu.

Returns:: The heirarchical set of comparator plugin menus.
Throws:: PipelineException - If unable to determine the comparator menu layout.

setComparatorMenuLayout

public void setComparatorMenuLayout(PluginMenuLayout layout)
                             throws PipelineException

Set the default layout of the comparator plugin menu.

Parameters:: layout - The heirarchical set of comparator plugin menus.
Throws:: PipelineException - If unable to set the comparator menu layout.

getComparatorMenuLayout

public PluginMenuLayout getComparatorMenuLayout(String name)
                                         throws PipelineException

Get the layout of the comparator plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of comparator plugin menus.
Throws:: PipelineException - If unable to determine the comparator menu layout.

setComparatorMenuLayout

public void setComparatorMenuLayout(String name,
                                    PluginMenuLayout layout)
                             throws PipelineException

Set the layout of the comparator plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The heirarchical set of comparator plugin menus.
Throws:: PipelineException - If unable to set the comparator menu layout.

getToolsetComparatorPlugins

public PluginSet getToolsetComparatorPlugins(String name)
                                      throws PipelineException

Get the comparator plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated comparator plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageComparatorPlugins

public PluginSet getPackageComparatorPlugins(String name,
                                             VersionID vid)
                                      throws PipelineException

Get the comparator plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated comparator plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageComparatorPlugins

public void setPackageComparatorPlugins(String name,
                                        VersionID vid,
                                        PluginSet plugins)
                                 throws PipelineException

Set the comparator plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated comparator plugins.
Throws:: PipelineException - If unable to set the plugins.

getActionMenuLayout

public PluginMenuLayout getActionMenuLayout()
                                     throws PipelineException

Get the default layout of the action plugin menu.

Returns:: The heirarchical set of action plugin menus.
Throws:: PipelineException - If unable to determine the action menu layout.

setActionMenuLayout

public void setActionMenuLayout(PluginMenuLayout layout)
                         throws PipelineException

Set the default layout of the action plugin menu.

Parameters:: layout - The heirarchical set of action plugin menus.
Throws:: PipelineException - If unable to set the action menu layout.

getActionMenuLayout

public PluginMenuLayout getActionMenuLayout(String name)
                                     throws PipelineException

Get the layout of the action plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of action plugin menus.
Throws:: PipelineException - If unable to determine the action menu layout.

setActionMenuLayout

public void setActionMenuLayout(String name,
                                PluginMenuLayout layout)
                         throws PipelineException

Set the layout of the action plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The heirarchical set of action plugin menus.
Throws:: PipelineException - If unable to set the action menu layout.

getToolsetActionPlugins

public PluginSet getToolsetActionPlugins(String name)
                                  throws PipelineException

Get the action plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated action plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageActionPlugins

public PluginSet getPackageActionPlugins(String name,
                                         VersionID vid)
                                  throws PipelineException

Get the action plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated action plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageActionPlugins

public void setPackageActionPlugins(String name,
                                    VersionID vid,
                                    PluginSet plugins)
                             throws PipelineException

Set the action plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated action plugins.
Throws:: PipelineException - If unable to set the plugins.

getToolMenuLayout

public PluginMenuLayout getToolMenuLayout()
                                   throws PipelineException

Get the default layout of the tool plugin menu.

Returns:: The heirarchical set of tool plugin menus.
Throws:: PipelineException - If unable to determine the tool menu layout.

setToolMenuLayout

public void setToolMenuLayout(PluginMenuLayout layout)
                       throws PipelineException

Set the default layout of the tool plugin menu.

Parameters:: layout - The heirarchical set of tool plugin menus.
Throws:: PipelineException - If unable to set the tool menu layout.

getToolMenuLayout

public PluginMenuLayout getToolMenuLayout(String name)
                                   throws PipelineException

Get the layout of the tool plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of tool plugin menus.
Throws:: PipelineException - If unable to determine the tool menu layout.

setToolMenuLayout

public void setToolMenuLayout(String name,
                              PluginMenuLayout layout)
                       throws PipelineException

Set the layout of the tool plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The heirarchical set of tool plugin menus.
Throws:: PipelineException - If unable to set the tool menu layout.

getToolsetToolPlugins

public PluginSet getToolsetToolPlugins(String name)
                                throws PipelineException

Get the tool plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated tool plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageToolPlugins

public PluginSet getPackageToolPlugins(String name,
                                       VersionID vid)
                                throws PipelineException

Get the tool plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated tool plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageToolPlugins

public void setPackageToolPlugins(String name,
                                  VersionID vid,
                                  PluginSet plugins)
                           throws PipelineException

Set the tool plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated tool plugins.
Throws:: PipelineException - If unable to set the plugins.

getArchiverMenuLayout

public PluginMenuLayout getArchiverMenuLayout()
                                       throws PipelineException

Get the default layout of the archiver plugin menu.

Returns:: The heirarchical set of archiver plugin menus.
Throws:: PipelineException - If unable to determine the archiver menu layout.

setArchiverMenuLayout

public void setArchiverMenuLayout(PluginMenuLayout layout)
                           throws PipelineException

Set the default layout of the archiver plugin menu.

Parameters:: layout - The heirarchical set of archiver plugin menus.
Throws:: PipelineException - If unable to set the archiver menu layout.

getArchiverMenuLayout

public PluginMenuLayout getArchiverMenuLayout(String name)
                                       throws PipelineException

Get the layout of the archiver plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of archiver plugin menus.
Throws:: PipelineException - If unable to determine the archiver menu layout.

setArchiverMenuLayout

public void setArchiverMenuLayout(String name,
                                  PluginMenuLayout layout)
                           throws PipelineException

Set the layout of the archiver plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The heirarchical set of archiver plugin menus.
Throws:: PipelineException - If unable to set the archiver menu layout.

getToolsetArchiverPlugins

public PluginSet getToolsetArchiverPlugins(String name)
                                    throws PipelineException

Get the archiver plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated archiver plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageArchiverPlugins

public PluginSet getPackageArchiverPlugins(String name,
                                           VersionID vid)
                                    throws PipelineException

Get the archiver plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated archiver plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageArchiverPlugins

public void setPackageArchiverPlugins(String name,
                                      VersionID vid,
                                      PluginSet plugins)
                               throws PipelineException

Set the archiver plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated archiver plugins.
Throws:: PipelineException - If unable to set the plugins.

getMasterExtMenuLayout

public PluginMenuLayout getMasterExtMenuLayout()
                                        throws PipelineException

Get the default layout of the master extension plugin menu.

Returns:: The heirarchical set of master extension plugin menus.
Throws:: PipelineException - If unable to determine the master extension menu layout.

setMasterExtMenuLayout

public void setMasterExtMenuLayout(PluginMenuLayout layout)
                            throws PipelineException

Set the default layout of the master extension plugin menu.

Parameters:: layout - The heirarchical set of master extension plugin menus.
Throws:: PipelineException - If unable to set the master extension menu layout.

getMasterExtMenuLayout

public PluginMenuLayout getMasterExtMenuLayout(String name)
                                        throws PipelineException

Get the layout of the master extension plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of master extension plugin menus.
Throws:: PipelineException - If unable to determine the master extension menu layout.

setMasterExtMenuLayout

public void setMasterExtMenuLayout(String name,
                                   PluginMenuLayout layout)
                            throws PipelineException

Set the layout of the master extension plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The heirarchical set of master extension plugin menus.
Throws:: PipelineException - If unable to set the master extension menu layout.

getToolsetMasterExtPlugins

public PluginSet getToolsetMasterExtPlugins(String name)
                                     throws PipelineException

Get the master extension plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated master extension plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageMasterExtPlugins

public PluginSet getPackageMasterExtPlugins(String name,
                                            VersionID vid)
                                     throws PipelineException

Get the master extension plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated master extension plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageMasterExtPlugins

public void setPackageMasterExtPlugins(String name,
                                       VersionID vid,
                                       PluginSet plugins)
                                throws PipelineException

Set the master extension plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated master extension plugins.
Throws:: PipelineException - If unable to set the plugins.

getQueueExtMenuLayout

public PluginMenuLayout getQueueExtMenuLayout()
                                       throws PipelineException

Get the default layout of the queue extension plugin menu.

Returns:: The heirarchical set of queue extension plugin menus.
Throws:: PipelineException - If unable to determine the queue extension menu layout.

setQueueExtMenuLayout

public void setQueueExtMenuLayout(PluginMenuLayout layout)
                           throws PipelineException

Set the default layout of the queue extension plugin menu.

Parameters:: layout - The heirarchical set of queue extension plugin menus.
Throws:: PipelineException - If unable to set the queue extension menu layout.

getQueueExtMenuLayout

public PluginMenuLayout getQueueExtMenuLayout(String name)
                                       throws PipelineException

Get the layout of the queue extension plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of queue extension plugin menus.
Throws:: PipelineException - If unable to determine the queue extension menu layout.

setQueueExtMenuLayout

public void setQueueExtMenuLayout(String name,
                                  PluginMenuLayout layout)
                           throws PipelineException

Set the layout of the queue extension plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The heirarchical set of queue extension plugin menus.
Throws:: PipelineException - If unable to set the queue extension menu layout.

getToolsetQueueExtPlugins

public PluginSet getToolsetQueueExtPlugins(String name)
                                    throws PipelineException

Get the queue extension plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated queue extension plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageQueueExtPlugins

public PluginSet getPackageQueueExtPlugins(String name,
                                           VersionID vid)
                                    throws PipelineException

Get the queue extension plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated queue extension plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageQueueExtPlugins

public void setPackageQueueExtPlugins(String name,
                                      VersionID vid,
                                      PluginSet plugins)
                               throws PipelineException

Set the queue extension plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated queue extension plugins.
Throws:: PipelineException - If unable to set the plugins.

getAnnotationMenuLayout

public PluginMenuLayout getAnnotationMenuLayout()
                                         throws PipelineException

Get the default layout of the annotation plugin menu.

Returns:: The heirarchical set of annotation plugin menus.
Throws:: PipelineException - If unable to determine the annotation menu layout.

setAnnotationMenuLayout

public void setAnnotationMenuLayout(PluginMenuLayout layout)
                             throws PipelineException

Set the default layout of the annotation plugin menu.

Parameters:: layout - The heirarchical set of annotation plugin menus.
Throws:: PipelineException - If unable to set the annotation menu layout.

getAnnotationMenuLayout

public PluginMenuLayout getAnnotationMenuLayout(String name)
                                         throws PipelineException

Get the layout of the annotation plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of annotation plugin menus.
Throws:: PipelineException - If unable to determine the annotation menu layout.

setAnnotationMenuLayout

public void setAnnotationMenuLayout(String name,
                                    PluginMenuLayout layout)
                             throws PipelineException

Set the layout of the annotation plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The heirarchical set of annotation plugin menus.
Throws:: PipelineException - If unable to set the annotation menu layout.

getToolsetAnnotationPlugins

public PluginSet getToolsetAnnotationPlugins(String name)
                                      throws PipelineException

Get the annotation plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated annotation plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageAnnotationPlugins

public PluginSet getPackageAnnotationPlugins(String name,
                                             VersionID vid)
                                      throws PipelineException

Get the annotation plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated annotation plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageAnnotationPlugins

public void setPackageAnnotationPlugins(String name,
                                        VersionID vid,
                                        PluginSet plugins)
                                 throws PipelineException

Set the annotation plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated annotation plugins.
Throws:: PipelineException - If unable to set the plugins.

getKeyChooserMenuLayout

public PluginMenuLayout getKeyChooserMenuLayout()
                                         throws PipelineException

Get the default layout of the key chooser plugin menu.

Returns:: The heirarchical set of key chooser plugin menus.
Throws:: PipelineException - If unable to determine the key chooser menu layout.

setKeyChooserMenuLayout

public void setKeyChooserMenuLayout(PluginMenuLayout layout)
                             throws PipelineException

Set the default layout of the key chooser plugin menu.

Parameters:: layout - The heirarchical set of key chooser plugin menus.
Throws:: PipelineException - If unable to set the key chooser menu layout.

getKeyChooserMenuLayout

public PluginMenuLayout getKeyChooserMenuLayout(String name)
                                         throws PipelineException

Get the layout of the key chooser plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The heirarchical set of key chooser plugin menus.
Throws:: PipelineException - If unable to determine the key chooser menu layout.

setKeyChooserMenuLayout

public void setKeyChooserMenuLayout(String name,
                                    PluginMenuLayout layout)
                             throws PipelineException

Set the layout of the key chooser plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The heirarchical set of key chooser plugin menus.
Throws:: PipelineException - If unable to set the key chooser menu layout.

getToolsetKeyChooserPlugins

public PluginSet getToolsetKeyChooserPlugins(String name)
                                      throws PipelineException

Get the key chooser plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated key chooser plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageKeyChooserPlugins

public PluginSet getPackageKeyChooserPlugins(String name,
                                             VersionID vid)
                                      throws PipelineException

Get the key chooser plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated key chooser plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageKeyChooserPlugins

public void setPackageKeyChooserPlugins(String name,
                                        VersionID vid,
                                        PluginSet plugins)
                                 throws PipelineException

Set the key chooser plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated key chooser plugins.
Throws:: PipelineException - If unable to set the plugins.

getBuilderCollectionMenuLayout

public PluginMenuLayout getBuilderCollectionMenuLayout()
                                                throws PipelineException

Get the default layout of the builder collection plugin menu.

Returns:: The hierarchical set of builder collection plugin menus.
Throws:: PipelineException - If unable to determine the builder collection menu layout.

setBuilderCollectionMenuLayout

public void setBuilderCollectionMenuLayout(PluginMenuLayout layout)
                                    throws PipelineException

Set the default layout of the builder collection plugin menu.

Parameters:: layout - The hierarchical set of builder collection plugin menus.
Throws:: PipelineException - If unable to set the builder collection menu layout.

getBuilderCollectionMenuLayout

public PluginMenuLayout getBuilderCollectionMenuLayout(String name)
                                                throws PipelineException

Get the layout of the builder collection plugin menu associated with a toolset.

Parameters:: name - The toolset name.
Returns:: The hierarchical set of builder collection plugin menus.
Throws:: PipelineException - If unable to determine the builder collection menu layout.

setBuilderCollectionMenuLayout

public void setBuilderCollectionMenuLayout(String name,
                                           PluginMenuLayout layout)
                                    throws PipelineException

Set the layout of the builder collection plugin menu associated with a toolset.

Parameters:: name - The toolset name.; layout - The hierarchical set of builder collection plugin menus.
Throws:: PipelineException - If unable to set the builder collection menu layout.

getToolsetBuilderCollectionPlugins

public PluginSet getToolsetBuilderCollectionPlugins(String name)
                                             throws PipelineException

Get the builder collection plugins associated with all packages of a toolset.

Parameters:: name - The toolset name.
Returns:: The vendors, names and revision numbers of the associated builder collection plugins.
Throws:: PipelineException - If unable to get the plugins.

getPackageBuilderCollectionPlugins

public PluginSet getPackageBuilderCollectionPlugins(String name,
                                                    VersionID vid)
                                             throws PipelineException

Get the builder collection plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.
Returns:: The vendors, names and revision numbers of the associated builder collection plugins.
Throws:: PipelineException - If unable to get the plugins.

setPackageBuilderCollectionPlugins

public void setPackageBuilderCollectionPlugins(String name,
                                               VersionID vid,
                                               PluginSet plugins)
                                        throws PipelineException

Set the builder collection plugins associated with a toolset package.

Parameters:: name - The toolset package name.; vid - The revision number of the package.; plugins - The vendors, names and revision numbers of the associated builder collection plugins.
Throws:: PipelineException - If unable to set the plugins.

getMasterExtensionConfig

public MasterExtensionConfig getMasterExtensionConfig(String name)
                                               throws PipelineException

Get the current master extension configurations.

Parameters:: name - The name of the master extension configuration.
Returns:: The extension configuration or null if no extension with the given name exists.
Throws:: PipelineException - If unable to determine the extensions.

getMasterExtensionConfigs

public TreeMap<String,MasterExtensionConfig> getMasterExtensionConfigs()
                                                                throws PipelineException

Get the current master extension configurations.

Returns:: The extension configurations indexed by configuration name.
Throws:: PipelineException - If unable to determine the extensions.

removeMasterExtensionConfig

public void removeMasterExtensionConfig(String name)
                                 throws PipelineException

Remove an existing the master extension configuration.

Parameters:: name - The name of the master extension configuration to remove.
Throws:: PipelineException - If unable to remove the extension.

setMasterExtensionConfig

public void setMasterExtensionConfig(MasterExtensionConfig extension)
                              throws PipelineException

Add or modify an existing the master extension configuration.

Parameters:: extension - The master extension configuration to add (or modify).
Throws:: PipelineException - If unable to set the extension.

getEditorForSuffix

public BaseEditor getEditorForSuffix(String suffix)
                              throws PipelineException

Get the current user's default editor plugin for a filename suffix.

Parameters:: suffix - The filename suffix.
Returns:: The editor plugin instance or null if undefined.
Throws:: PipelineException - If unable to determine the editor name.

getSuffixEditors

public TreeSet<SuffixEditor> getSuffixEditors()
                                       throws PipelineException

Get the current user's filename suffix to default editor mappings.

Returns:: The suffix/editor mappings.
Throws:: PipelineException - If unable to determine the mappings.

getDefaultSuffixEditors

public TreeSet<SuffixEditor> getDefaultSuffixEditors()
                                              throws PipelineException

Get the site default filename suffix to default editor mappings.

Returns:: The suffix/editor mappings.
Throws:: PipelineException - If unable to determine the mappings.

setSuffixEditors

public void setSuffixEditors(TreeSet<SuffixEditor> editors)
                      throws PipelineException

Set the current user's filename suffix to default editor mappings.

Parameters:: editors - The suffix/editor mappings.
Throws:: PipelineException - If unable to set the table.

getWorkingAreas

public TreeMap<String,TreeSet<String>> getWorkingAreas()
                                                throws PipelineException

Get the table of current working area authors and views.

Specified by:: getWorkingAreas in interface MasterMgrLightClient

Returns:: The table of working area view names indexed by author user name.
Throws:: PipelineException - If unable to determine the working areas.

getWorkingAreasContaining

public TreeMap<String,TreeSet<String>> getWorkingAreasContaining(String name)
                                                          throws PipelineException

Get the table of the working areas containing the given node.

Specified by:: getWorkingAreasContaining in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.
Returns:: The table of working area view names indexed by author user name.
Throws:: PipelineException - If unable to determine the working areas.

createWorkingArea

public void createWorkingArea(String author,
                              String view)
                       throws PipelineException

Create a new empty working area.

If the working area already exists, the operation is successful even though nothing is actually done.

Parameters:: author - The name of the user which owns the working area.; view - The name of the user's working area view. A valid view name start with ("a"-"z", "A"-"Z", "0"-"9") followed by zero or more of the following characters: ("a"-"z", "A"-"Z", "0"-"9", "_", "-", "~", ".").
Throws:: PipelineException - If unable to create the working area.

removeWorkingArea

public void removeWorkingArea(String author,
                              String view)
                       throws PipelineException

Remove an entire working area.

This method will only succeed there are no working versions of any node currently checked-out in the given working area. All nodes must be released prior to removing the working area.

Any files not managed by Pipeline which exist in the working area directory will be deleted by this operation.

Parameters:: author - The name of the user which owns the working area.; view - The name of the user's working area view.
Throws:: PipelineException - If unable to remove the working area.

getNodeNames

public TreeSet<String> getNodeNames(String pattern)
                             throws PipelineException

Get the names of all nodes who's name matches the given search pattern.

Specified by:: getNodeNames in interface MasterMgrLightClient

Parameters:: pattern - A regular expression pattern used to match the fully resolved names of nodes or null to match all nodes.
Returns:: The fully resolved names of the matching nodes.
Throws:: PipelineException - If determine which working versions match the pattern.

updatePaths

public NodeTreeComp updatePaths(String author,
                                String view,
                                TreeSet<String> paths)
                         throws PipelineException

Update the immediate children of all node path components along the given paths which are visible within a working area view owned by the given user.

Specified by:: updatePaths in interface MasterMgrLightClient

Parameters:: author - The of the user which owns the working version.; view - The name of the user's working area view.; paths - The set of fully resolved node paths to update.
Throws:: PipelineException - If unable to update the node paths.

updatePaths

public NodeTreeComp updatePaths(String author,
                                String view,
                                TreeMap<String,Boolean> paths)
                         throws PipelineException

Update the children of all node path components along the given paths which are visible within a working area view owned by the given user.

Specified by:: updatePaths in interface MasterMgrLightClient

Parameters:: author - The of the user which owns the working version.; view - The name of the user's working area view.; paths - Whether to update all children (true) or only the immediate children (false) of the given fully resolved node path indices.
Throws:: PipelineException - If unable to update the node paths.

getNodeOwning

public String getNodeOwning(String path)
                     throws PipelineException

Get the name of the node associated with the given file.

Specified by:: getNodeOwning in interface MasterMgrLightClient

Parameters:: path - The fully resolved file path relative to the root working directory.
Returns:: The fully resolved node name or null if the file is not associated with any node.
Throws:: PipelineException

getAnnotation

public BaseAnnotation getAnnotation(String nname,
                                    String aname)
                             throws PipelineException

Get a specific per-node annotation for the given node.

Specified by:: getAnnotation in interface MasterMgrLightClient

Parameters:: nname - The fully resolved node name.; aname - The name of the annotation.
Returns:: The named annotation for the node or null if none exists.
Throws:: PipelineException - If unable to determine the annotations.

getAnnotation

public BaseAnnotation getAnnotation(String author,
                                    String view,
                                    String nname,
                                    String aname)
                             throws PipelineException

Get a unified view of a specific named annotation from both node and working version of the node in a particular working area view.

If the named annotation exists as both a per-node and per-version annotation, then the per-version annotation will be returned without generating any warnings or exceptions. If the named annotation exists as only one of a per-node or per-version annotation, then which ever one exists will be be returned. If neither exist, then null will be returned.

Note that this is merely a convienence method that provides a quicker way of looking up both per-node annotations and lookup the working version of a node and then accessing its annotation properties. No new functionality is provided by this method, but it may be faster when needing a unified view of all annotations and other working version information is not required.

Specified by:: getAnnotation in interface MasterMgrLightClient

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; nname - The fully resolved node name.; aname - The name of the annotation.
Returns:: The named annotation for the node or null if none exists.
Throws:: PipelineException - If no working version of the new exists or otherwise unable to determine the annotations.

getAnnotation

public BaseAnnotation getAnnotation(NodeID nodeID,
                                    String aname)
                             throws PipelineException

Get a unified view of a specific named annotation from both node and working version of the node in a particular working area view.

Specified by:: getAnnotation in interface MasterMgrLightClient

Parameters:: nodeID - The unique working version identifier.; aname - The name of the annotation.
Returns:: The named annotation for the node or null if none exists.
Throws:: PipelineException - If no working version of the new exists or otherwise unable to determine the annotations.

getAnnotations

public TreeMap<String,BaseAnnotation> getAnnotations(String name)
                                              throws PipelineException

Get all of the per-node annotations for the given node.

Specified by:: getAnnotations in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.
Returns:: The annotations for the node indexed by annotation name (may be empty).
Throws:: PipelineException - If unable to determine the annotations.

getAnnotations

public TreeMap<String,BaseAnnotation> getAnnotations(String author,
                                                     String view,
                                                     String name)
                                              throws PipelineException

Get a unified view of all annotation from both node and working version of the node in a particular working area view.

If a given annotation exists as both a per-node and per-version annotation, then the per-version annotation will be returned without generating any warnings or exceptions. If a given annotation exists as only one of a per-node or per-version annotation, then which ever one exists will be be returned.

Specified by:: getAnnotations in interface MasterMgrLightClient

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.
Returns:: The annotations for the node indexed by annotation name (may be empty).
Throws:: PipelineException - If no working version of the new exists or otherwise unable to determine the annotations.

getAnnotations

public TreeMap<String,BaseAnnotation> getAnnotations(NodeID nodeID)
                                              throws PipelineException

Get a unified view of all annotation from both node and working version of the node in a particular working area view.

Specified by:: getAnnotations in interface MasterMgrLightClient

Parameters:: nodeID - The unique working version identifier.
Returns:: The annotations for the node indexed by annotation name (may be empty).
Throws:: PipelineException - If no working version of the new exists or otherwise unable to determine the annotations.

getAnnotations

public DoubleMap<NodeID,String,BaseAnnotation> getAnnotations(TreeSet<NodeID> nodeIDs)
                                                       throws PipelineException

Get a unified view of all annotation from both node and working version for a set of nodes in working areas.

Parameters:: nodeIDs - The set of unique working version identifier.
Returns:: The annotations for the node indexed by node id and annotation name (may be empty).
Throws:: PipelineException - If a working version for at least one of the node does not exists or if Pipeline is otherwise unable to determine the annotations.

addAnnotation

public void addAnnotation(String nname,
                          String aname,
                          BaseAnnotation annot)
                   throws PipelineException

Add the given annotation to the set of current annotations for the given node.

If an annotation with the same name already exists for the node, it will be replaced by this new annotation. This method can therefore be used to modify existing annotations as well as add new ones.

When adding new annotations to a node or replacing an existing annotation with a plugin instance with a different plugin name/version/vendor, this method will fail if the current user does not have Annotator privileges. When only updating the values for an existing annotation, the BaseAnnotation.isParamModifiable method of the existing annotation will be used to determine whether the user has permission to modify each annotation parameter. Only parameters with values not identical to those in the existing annotation will perform this test. Identical values will simply be ignored.

Parameters:: nname - The fully resolved node name.; aname - The name of the annotation.; annot - The new node annotation to add.
Throws:: PipelineException - If unable to add the annotation.

removeAnnotation

public void removeAnnotation(String nname,
                             String aname)
                      throws PipelineException

Remove a specific annotation from a node.

This method will fail if the current user does not have Annotator privileges.

Parameters:: nname - The fully resolved node name.; aname - The name of the annotation.
Throws:: PipelineException - If unable to remove the annotation.

removeAnnotations

public void removeAnnotations(String name)
                       throws PipelineException

Remove all annotations from a node.

This method will fail if the current user does not have Annotator privileges.

Parameters:: name - The fully resolved node name.
Throws:: PipelineException - If unable to remove the annotations.

getWorkingNames

public TreeSet<String> getWorkingNames(String author,
                                       String view,
                                       String pattern)
                                throws PipelineException

Get the names of the nodes in a working area matching the given search pattern.

Specified by:: getWorkingNames in interface MasterMgrLightClient

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; pattern - A regular expression pattern used to match the fully resolved names of nodes or null to match all nodes.
Returns:: The fully resolved names of the matching working versions.
Throws:: PipelineException - If unable to determine which working versions match the pattern.

getWorkingRootNames

public TreeSet<String> getWorkingRootNames(String author,
                                           String view)
                                    throws PipelineException

Get the names of the most downstream nodes in a working area.

Specified by:: getWorkingRootNames in interface MasterMgrLightClient

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.
Returns:: The fully resolved names of the root working versions.
Throws:: PipelineException - If unable to determine which working versions are the roots.

getWorkingVersion

public NodeMod getWorkingVersion(String author,
                                 String view,
                                 String name)
                          throws PipelineException

Get the working version of a node.

Specified by:: getWorkingVersion in interface MasterMgrLightClient

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.
Throws:: PipelineException - If unable to retrieve the working version.

getWorkingVersion

public NodeMod getWorkingVersion(NodeID nodeID)
                          throws PipelineException

Get the working version of a node.

Specified by:: getWorkingVersion in interface MasterMgrLightClient

Parameters:: nodeID - The unique working version identifier.
Throws:: PipelineException - If unable to retrieve the working version.

modifyProperties

public void modifyProperties(String author,
                             String view,
                             NodeMod mod)
                      throws PipelineException

Set the node properties of the working version of a node.

Node properties include:

The toolset environment under which editors and actions are run.
The name of the editor plugin used to edit the data files associated with the node.
The regeneration action and its single and per-source parameters.
The overflow policy, execution method and job batch size.
The job requirements.

Note that any links to upstream nodes contain in the mod argument will be ignored. The link and unlink methods must be used to alter the connections between working node versions.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; mod - The working version containing the node property information to copy.
Throws:: PipelineException - If unable to set the node properties.

link

public void link(String author,
                 String view,
                 String target,
                 String source,
                 LinkPolicy policy,
                 LinkRelationship relationship,
                 Integer offset)
          throws PipelineException

Create or modify an existing link between the working versions.

If the relationship argument is OneToOne then the offset argument must not be null. For all other link relationships, the offset argument must be null.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; target - The fully resolved name of the downstream node to connect.; source - The fully resolved name of the upstream node to connect.; policy - The node state propogation policy.; relationship - The nature of the relationship between files associated with the source and target nodes.; offset - The frame index offset.
Throws:: PipelineException - If unable to create or modify the link.

link

public void link(String author,
                 String view,
                 String target,
                 String source,
                 LinkPolicy policy)
          throws PipelineException

Create or modify an existing link between the working versions.

The LinkRelationship defaults to All with no frame offset. Use the other form of link(java.lang.String, java.lang.String, java.lang.String, java.lang.String, us.temerity.pipeline.LinkPolicy, us.temerity.pipeline.LinkRelationship, java.lang.Integer) to specify a different LinkRelationship and frame offset.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; target - The fully resolved name of the downstream node to connect.; source - The fully resolved name of the upstream node to connect.; policy - The node state propogation policy.
Throws:: PipelineException - If unable to create or modify the link.

link

public void link(String author,
                 String view,
                 String target,
                 LinkCommon link)
          throws PipelineException

Create or modify an existing link between the working versions.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; target - The fully resolved name of the downstream node to connect.; link - Information about the relationship between the downstream node and the upstream node to connect.
Throws:: PipelineException - If unable to create or modify the link.

link

public void link(NodeID target,
                 LinkCommon link)
          throws PipelineException

Create or modify an existing link between the working versions.

Parameters:: target - The unique working version identifier of the downstream node to connect.; link - Information about the relationship between downstream node and the upstream node to connect.
Throws:: PipelineException - If unable to create or modify the link.

unlink

public void unlink(String author,
                   String view,
                   String target,
                   String source)
            throws PipelineException

Destroy an existing link between the working versions.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; target - The fully resolved name of the downstream node to disconnect.; source - The fully resolved name of the upstream node to disconnect.
Throws:: PipelineException - If unable to destroy the link.

unlink

public void unlink(NodeID target,
                   String source)
            throws PipelineException

Destroy an existing link between the working versions.

Parameters:: target - The unique working version identifier of the downstream node to disconnect.; source - The fully resolved name of the upstream node to disconnect.
Throws:: PipelineException - If unable to destroy the link.

addSecondary

public void addSecondary(String author,
                         String view,
                         String name,
                         FileSeq fseq)
                  throws PipelineException

Add a secondary file sequence to a working version.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; fseq - The secondary file sequence to add.
Throws:: PipelineException - If unable to add the file sequence.

addSecondary

public void addSecondary(NodeID nodeID,
                         FileSeq fseq)
                  throws PipelineException

Add a secondary file sequence to a working version.

Parameters:: nodeID - The unique working version identifier.; fseq - The secondary file sequence to add.
Throws:: PipelineException - If unable to add the file sequence.

removeSecondary

public void removeSecondary(String author,
                            String view,
                            String name,
                            FileSeq fseq)
                     throws PipelineException

Remove a secondary file sequence from a working version.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; fseq - The secondary file sequence to remove.
Throws:: PipelineException - If unable to remove the file sequence.

removeSecondary

public void removeSecondary(NodeID nodeID,
                            FileSeq fseq)
                     throws PipelineException

Remove a secondary file sequence from a working version.

Parameters:: nodeID - The unique working version identifier.; fseq - The secondary file sequence to remove.
Throws:: PipelineException - If unable to remove the file sequence.

rename

public void rename(String author,
                   String view,
                   String name,
                   FilePattern pattern,
                   boolean renameFiles)
            throws PipelineException

Rename a working version of a node which has never been checked-in.

This operation allows a user to change the name, frame number padding and suffix of a previously registered node before it is checked-in. If a working version is successfully renamed, all node connections will be preserved.

The new primary file sequence pattern passed as the pattern parameter must have a fully resolved prefix which is used to determine the new name of the node. If the original node had a frame number component, the new file pattern must also include a frame number component.

In addition to changing the name of the working version, this operation can also rename the files associated with the working version to match the new node's file pattern if the renameFiles argument is true. The primary file sequence will be renamed to match tne new file pattern. The secondary file sequence prefixes will remain unchanged. Both primary and secondary file sequences will be moved into the working directory which matches the new file pattern prefix.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The current fully resolved node name.; pattern - The new fully resolved file pattern.; renameFiles - Should the files associated with the working version be renamed?
Throws:: PipelineException - If unable to rename the given node or its associated primary files.

rename

public void rename(NodeID nodeID,
                   FilePattern pattern,
                   boolean renameFiles)
            throws PipelineException

Rename a working version of a node which has never been checked-in.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; pattern - The new fully resolved file pattern.; renameFiles - Should the files associated with the working version be renamed?
Throws:: PipelineException - If unable to rename the given node or its associated primary files.

renumber

public TreeSet<Long> renumber(String author,
                              String view,
                              String name,
                              FrameRange range,
                              boolean removeFiles)
                       throws PipelineException

Renumber the frame ranges of the file sequences associated with a node.

See adjustFrameRange for the constraints on legal values for the given new frame range argument range. If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; range - The new frame range.; removeFiles - Whether to remove files from the old frame range which are no longer part of the new frame range.
Returns:: The job IDs of unfinished jobs associated with the obsolete frames or null if no jobs where found.
Throws:: PipelineException - If unable to renumber the given node or its associated primary files.

renumber

public TreeSet<Long> renumber(NodeID nodeID,
                              FrameRange range,
                              boolean removeFiles)
                       throws PipelineException

Renumber the frame ranges of the file sequences associated with a node.

See adjustFrameRange for the constraints on legal values for the given new frame range argument range. If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; range - The new frame range.; removeFiles - Whether to remove files from the old frame range which are no longer part of the new frame range.
Returns:: The job IDs of unfinished jobs associated with the obsolete frames or null if no jobs where found.
Throws:: PipelineException - If unable to renumber the given node or its associated primary files.

getCheckedInNames

public TreeSet<String> getCheckedInNames(String pattern)
                                  throws PipelineException

Get the names of the nodes with at least one checked-in version who's name matches the given search pattern.

Specified by:: getCheckedInNames in interface MasterMgrLightClient

Parameters:: pattern - A regular expression pattern used to match the fully resolved names of nodes or null to match all nodes.
Returns:: The fully resolved names of the matching checked-in versions.
Throws:: PipelineException - If determine which working versions match the pattern.

getCheckedInVersionIDs

public TreeSet<VersionID> getCheckedInVersionIDs(String name)
                                          throws PipelineException

Get the revision numbers of all checked-in versions of a node.

Specified by:: getCheckedInVersionIDs in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.
Throws:: PipelineException - If unable to retrieve the checked-in versions.

getIntermediateVersionIDs

public TreeSet<VersionID> getIntermediateVersionIDs(String name)
                                             throws PipelineException

Get the revision numbers of all checked-in versions of a node do not save intermediate (temporary) version of files in the repository.

Specified by:: getIntermediateVersionIDs in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.
Throws:: PipelineException - If unable to retrieve the checked-in versions.

getCheckedInVersion

public NodeVersion getCheckedInVersion(String name,
                                       VersionID vid)
                                throws PipelineException

Get the checked-in version of a node.

Specified by:: getCheckedInVersion in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.; vid - The revision number of the checked-in version or null for the latest version.
Throws:: PipelineException - If unable to retrieve the checked-in version.

getAllCheckedInVersions

public TreeMap<VersionID,NodeVersion> getAllCheckedInVersions(String name)
                                                       throws PipelineException

Get all of the checked-in versions of a node.

Specified by:: getAllCheckedInVersions in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.
Returns:: The checked-in versions indexed by revision number.
Throws:: PipelineException - If unable to retrieve the checked-in version.

getHistory

public TreeMap<VersionID,LogMessage> getHistory(String name)
                                         throws PipelineException

Get the log messages associated with all checked-in versions of a node.

Specified by:: getHistory in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.
Returns:: The log messages indexed by revision number.
Throws:: PipelineException - If unable to retrieve the log messages.

getCheckedInFileNovelty

public TreeMap<VersionID,TreeMap<FileSeq,boolean[]>> getCheckedInFileNovelty(String name)
                                                                      throws PipelineException

Get whether each file associated with each checked-in version of a node contains new data not present in the previous checked-in versions.

Specified by:: getCheckedInFileNovelty in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.
Returns:: The per-file novelty flags indexed by revision number and file sequence.
Throws:: PipelineException - If unable to determine the file revision history.

getCheckedInLinks

public DoubleMap<VersionID,String,LinkVersion> getCheckedInLinks(String name)
                                                          throws PipelineException

Get the upstream links of all checked-in versions of a node.

Specified by:: getCheckedInLinks in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.
Returns:: The checked-in links indexed by revision number of the target node and the node name of the upstream node.
Throws:: PipelineException - If unable to determine the checked-in links.

getDownstreamCheckedInLinks

public DoubleMap<String,VersionID,LinkVersion> getDownstreamCheckedInLinks(String name,
                                                                           VersionID vid)
                                                                    throws PipelineException

Get the links from specific checked-in version to all other checked-in node versions downstream.

Specified by:: getDownstreamCheckedInLinks in interface MasterMgrLightClient

Parameters:: name - The fully resolved name of the upstream node.; vid - The revision number of the checked-in upstream node.
Returns:: The checked-in links indexed by the name and revision number of the downstream node.
Throws:: PipelineException - If unable to determine the checked-in links.

status

public NodeStatus status(String author,
                         String view,
                         String name)
                  throws PipelineException

Get the heavyweight upstream status of the tree of nodes rooted at a node.

The status information for all nodes upstream of and including the root node will include detailed per-file state and version information which is accessable by calling the NodeStatus.getHeavyDetails method. No downstream node status will be returned.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.
Throws:: PipelineException - If unable to determine the status of the node.

status

public NodeStatus status(NodeID nodeID)
                  throws PipelineException

Get the heavyweight upstream status of the tree of nodes rooted at a node.

Parameters:: nodeID - The unique working version identifier.
Throws:: PipelineException - If unable to determine the status of the node.

status

public NodeStatus status(String author,
                         String view,
                         String name,
                         boolean lightweight,
                         DownstreamMode dmode)
                  throws PipelineException

Get the status of the tree of nodes rooted at a node.

In addition to providing node status information for the given node, the returned NodeStatus instance can be used access the status of all nodes (both upstream and downstream) linked to the given node. The status information for the upstream nodes will also include detailed state and version information which is accessable by calling the NodeStatus.getLightDetails method or the NodeStatus.getHeavyDetails depending on whether lightweight or heavyweight details have been requested.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; lightweight - Whether to report only lightweight node status detail information for the upstream nodes.; dmode - The criteria used to determine how downstream node status is reported.
Throws:: PipelineException - If unable to determine the status of the node.

status

public NodeStatus status(NodeID nodeID,
                         boolean lightweight,
                         DownstreamMode dmode)
                  throws PipelineException

Get the status of the tree of nodes rooted at a node.

Parameters:: nodeID - The unique working version identifier.; lightweight - Whether to report only lightweight node status detail information for the upstream nodes.; dmode - The criteria used to determine how downstream node status is reported.
Throws:: PipelineException - If unable to determine the status of the node.

status

public TreeMap<String,NodeStatus> status(String author,
                                         String view,
                                         TreeSet<String> rootNames,
                                         TreeSet<String> heavyNames,
                                         DownstreamMode dmode)
                                  throws PipelineException

Get the status of multiple possibly overlapping trees of nodes.

For each of the root nodes given, a NodeStatus instance will be returned which access the status of all nodes (both upstream and downstream) linked to the given node. By default, the upstream node status details will be lightweight (see NodeStatus.getLightDetails) for all nodes root at and included in the rootNames node name set. However, heavyweight status (see NodeStatus.getHeavyDetails) can be returned for upstream subtree of these root nodes by including them in the heavyNames node name set. If the contents of the rootNames and heavyNames node name sets are identical, then all upstream nodes will have heavyweight node status details.

This method returns a table containing NodeStatus instances for each of the given nodes in the rootNames set indexed by their fully resolved node names. If status for a root node is requested and the node does not exist, then the entry in this table for the missing node will be null. To enable partial completion of this method when specified both existing and missing root nodes, a PipelineException will not be thrown when only a subset of the nodes are missing.

If not null, the NodeStatus for each root node can be used access the status of all nodes (both upstream and downstream) linked to the node. The status information for the upstream nodes will also include detailed state and version information which is accessable by calling the NodeStatus.getLightDetails method or the NodeStatus.getHeavyDetails depending on whether lightweight or heavyweight details have been requested.

For any given node, only one NodeStatus is actually returned but it may be accessible from multiple paths and from various root nodes. This means that when computing node status where the given root nodes share a significant portion of their upstream nodes, this method will be much more efficient than calling the single node status method for each root node seperately.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; rootNames - The fully resolved names of the nodes for which node stats will be reported.; heavyNames - The fully resolved names of the nodes which require heavyweight node status details. All nodes upstream will also return heavyweight details as well. Note that in order for these heavyweight nodes to be returned, they must be included or reachable upstream from the rootNames set.; dmode - The criteria used to determine how downstream node status is reported for the nodes included in the rootNames set.
Returns:: The node status for each of the root nodes indexed by th root nodes fully resolved names of these nodes. This table contain null values for some keys (see above).
Throws:: PipelineException - If unable to determine the status of any of the root nodes.

downstreamStatus

public TreeMap<String,NodeStatus> downstreamStatus(String author,
                                                   String view,
                                                   TreeSet<String> rootNames,
                                                   DownstreamMode dmode)
                                            throws PipelineException

Get the downstream only status of multiple nodes.

For each of the root nodes given, a NodeStatus instance will be returned which access the status of all nodes downstream linked to the given node according the the criteria specified by the given downtream mode.

Note that all returned NodeStatus instances will not contain any detailed status information, just the minimal status and connectivity information.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; rootNames - The fully resolved names of the nodes for which node stats will be reported.; dmode - The criteria used to determine how downstream node status is reported for the nodes included in the rootNames set.
Returns:: The downstream node status for each of the root nodes indexed by th root nodes fully resolved names of these nodes. This table may contain null values for some keys (see above).
Throws:: PipelineException - If unable to determine the status of any of the root nodes.

register

public NodeMod register(String author,
                        String view,
                        NodeMod mod)
                 throws PipelineException

The mod argument must have a node name which does not already exist and does not match any of the path components of any existing node.

The working version must be an inital version. In other words, the NodeMod.getWorkingID method must return null. As an intial working version, the mod argument should not contain any upstream node link information.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the new working version.; view - The name of the user's working area view.; mod - The initial working version to register.
Returns:: The NodeMod which represents the node that was just registered.
Throws:: PipelineException - If unable to register the given node.

release

public void release(String author,
                    String view,
                    String name,
                    boolean removeFiles)
             throws PipelineException

Release the working version of a node and optionally remove the associated working area files.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; removeFiles - Should the files associated with the working version be deleted?
Throws:: PipelineException - If unable to release the given node.

release

public void release(NodeID nodeID,
                    boolean removeFiles)
             throws PipelineException

Release the working versions of nodes and optionally remove the associated working area files.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; removeFiles - Should the files associated with the working version be deleted?
Throws:: PipelineException - If unable to release the given node.

release

public void release(String author,
                    String view,
                    TreeSet<String> names,
                    boolean removeFiles)
             throws PipelineException

Release the working version of a node and optionally remove the associated working area files.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; names - The fully resolved names of the nodes to release.; removeFiles - Should the files associated with the working version be deleted?
Throws:: PipelineException - If unable to release the given node.

delete

public void delete(String name,
                   boolean removeFiles)
            throws PipelineException

Delete all working and checked-in versions of a node and optionally remove all associated working area files.

This operation may only be performed on nodes which have downstream or upstream links to other nodes in any checked-in version. Only privileged users may delete nodes.

Parameters:: name - The fully resolved node name.; removeFiles - Should the files associated with the working versions be deleted?
Throws:: PipelineException - If unable to release the given node.

checkIn

public void checkIn(String author,
                    String view,
                    String name,
                    String msg,
                    VersionID.Level level)
             throws PipelineException

Check-In the tree of nodes rooted at a working version.

The check-in operation proceeds in a depth-first manner checking-in the most upstream nodes first. The check-in operation aborts at the first failure of a particular node. It is therefore possible for the overall check-in to fail after already succeeding for some set of upstream nodes.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; msg - The check-in message text.; level - The revision number component level to increment.
Throws:: PipelineException - If unable to check-in the nodes.

checkIn

public void checkIn(NodeID nodeID,
                    String msg,
                    VersionID.Level level)
             throws PipelineException

Check-In the tree of nodes rooted at a working version.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; msg - The check-in message text.; level - The revision number component level to increment.
Throws:: PipelineException - If unable to check-in the nodes.

checkOut

public MappedSet<String,Long> checkOut(String author,
                                       String view,
                                       String name,
                                       VersionID vid,
                                       CheckOutMode mode,
                                       CheckOutMethod method)
                                throws PipelineException

Check-Out the tree of nodes rooted at a working version.

If the vid argument is null then check-out the latest version.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; vid - The revision number of the node to check-out.; mode - The criteria used to determine whether nodes upstream of the root node of the check-out should also be checked-out.; method - The method for creating working area files/links from the checked-in files.
Returns:: The unfinished job IDs indexed by node name if aborted or null if successful.
Throws:: PipelineException - If unable to check-out the nodes.

checkOut

public MappedSet<String,Long> checkOut(NodeID nodeID,
                                       VersionID vid,
                                       CheckOutMode mode,
                                       CheckOutMethod method)
                                throws PipelineException

Check-Out the tree of nodes rooted at a working version.

If the vid argument is null then check-out the latest version.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; vid - The revision number of the node to check-out.; mode - The criteria used to determine whether nodes upstream of the root node of the check-out should also be checked-out.; method - The method for creating working area files/links from the checked-in files.
Returns:: The unfinished job IDs indexed by node name if aborted or null if successful.
Throws:: PipelineException - If unable to check-out the nodes.

lock

public void lock(String author,
                 String view,
                 String name,
                 VersionID vid)
          throws PipelineException

Lock the working version of a node to a specific checked-in version.

If the vid argument is null then lock to the base checked-in version.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; vid - The revision number of the checked-in version to which the working version is being locked.
Throws:: PipelineException - If unable to lock the nodes.

lock

public void lock(NodeID nodeID,
                 VersionID vid)
          throws PipelineException

Lock the working version of a node to a specific checked-in version.

If the vid argument is null then lock to the base checked-in version.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; vid - The revision number of the checked-in version to which the working version is being locked.
Throws:: PipelineException - If unable to lock the nodes.

revertFiles

public void revertFiles(String author,
                        String view,
                        String name,
                        TreeMap<String,VersionID> files)
                 throws PipelineException

Revert specific working area files to an earlier checked-in version of the files.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; files - The table of checked-in file revision numbers indexed by file name.
Throws:: PipelineException - If unable to revert the files.

revertFiles

public void revertFiles(NodeID nodeID,
                        TreeMap<String,VersionID> files)
                 throws PipelineException

Revert specific working area files to an earlier checked-in version of the files.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; files - The table of checked-in file revision numbers indexed by file name.
Throws:: PipelineException - If unable to revert the files.

clone

public NodeMod clone(String author,
                     String view,
                     String oldName,
                     String newName)
              throws PipelineException

Register a new node who's properties are identical to an existing working version. Clones all properties, actions, links and files.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the cloned version.; view - The name of the user's working area view.; oldName - The fully resolved name of the source node to clone.; newName - The fully resolved name of the cloned node.
Returns:: A NodeMod representing the newly cloned node.
Throws:: PipelineException - If unable to clone the given node.

clone

public NodeMod clone(String author,
                     String view,
                     String oldName,
                     String newName,
                     boolean cloneAction,
                     boolean cloneLinks,
                     boolean cloneFiles,
                     boolean cloneAnnotations)
              throws PipelineException

Register a new node who's properties are identical to an existing working version. If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the cloned version.; view - The name of the user's working area view.; oldName - The fully resolved name of the source node to clone.; newName - The fully resolved name of the cloned node.; cloneAction - Whether to clone the action and action parameters of source node.; cloneLinks - Whether to clone the links of the source node as well.; cloneFiles - Whether to copy the files of source node as well.; cloneAnnotations - Whether to copy of the annotations of the source node as well. If the user doing the clone does not have Annotator privileges, this may call the clone to error out at the end. However, all proceding steps will not be undone.
Returns:: A NodeMod representing the newly cloned node.
Throws:: PipelineException - If unable to clone the given node.

cloneFiles

public void cloneFiles(NodeID sourceID,
                       NodeID targetID)
                throws PipelineException

Replace the primary files associated with one node with the primary files of another node.

The two nodes must have exactly the same number of files in their primary file sequences or the operation will fail.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: sourceID - The unique working version identifier of the node owning the files being copied.; targetID - The unique working version identifier of the node owning the files being replaced.
Throws:: PipelineException - If unable to clone the files.

cloneFiles

public void cloneFiles(NodeID sourceID,
                       NodeID targetID,
                       MappedSet<FileSeq,FileSeq> secondarySequences)
                throws PipelineException

Replace the primary and selected secondary files associated with one node with the primary and selected secondary files of another node.

The two nodes must have exactly the same number of files in their primary file sequences or the operation will fail.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: sourceID - The unique working version identifier of the node owning the files being copied.; targetID - The unique working version identifier of the node owning the files being replaced.; secondarySequences - A map of the secondary file sequences to be copied. The keys are the secondary sequences of the source node and the values are the set of corresponding sequences in the target node.
Throws:: PipelineException - If unable to clone the files or if some of the specified secondary sequences do not exist.

cloneFiles

public void cloneFiles(NodeID sourceID,
                       NodeID targetID,
                       MappedSet<FileSeq,FileSeq> secondarySequences,
                       FrameRange sourceRange,
                       FrameRange targetRange)
                throws PipelineException

Replace the primary and selected secondary files associated with one node with the primary and selected secondary files of another node.

The two nodes must have exactly the same number of files in their primary file sequences or the operation will fail.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: sourceID - The unique working version identifier of the node owning the files being copied.; targetID - The unique working version identifier of the node owning the files being replaced.; secondarySequences - A map of the secondary file sequences to be copied. The keys are the secondary sequences of the source node and the values are a set of the corresponding sequences in the target node.; sourceRange - The frame range in the source node that will be copied. If this is null then the entire frame range of the node will be copied. If this range ends up having a different number of frames than the targetRange, this request will fail.; targetRange - The frame range in the target node what will be copied to. If this is null then the entire frame range of the node will be copied to. If this range ends up having a different number of frames than the sourceRange, this request will fail.
Throws:: PipelineException - If unable to clone the files or if some of the specified secondary sequences do not exist or if the frame ranges passed in are not valid frame ranges for the nodes or do not contain the same number of frames.

evolve

public void evolve(String author,
                   String view,
                   String name,
                   VersionID vid)
            throws PipelineException

Change the checked-in version upon which the working version is based without modifying the working version properties, links or associated files.

This operation can be used to resolve a conflict by changing to the latest checked-in version.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; vid - The revision number of the checked-in version or null for the latest checked-in version.
Throws:: PipelineException - If unable to evolve the node.

evolve

public void evolve(NodeID nodeID,
                   VersionID vid)
            throws PipelineException

Change the checked-in version upon which the working version is based without modifying the working version properties, links or associated files.

This operation can be used to resolve a conflict by changing to the latest checked-in version.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; vid - The revision number of the checked-in version or null for the latest checked-in version.
Throws:: PipelineException - If unable to evolve the node.

packNodes

public Path packNodes(String author,
                      String view,
                      String name)
               throws PipelineException

Create a new node bundle (JAR achive) by packing up a tree of nodes from a working area rooted at the given node.

If successful, this will create a new node bundle containing the node properties, links and associated working area data files for the entire tree of nodes rooted at the given node. The node bundle will contain full copies of all files associated with these nodes regardless of whether they where checked-out modifiable, frozen or locked within the current working area. All node metadata, including detailed information about the toolsets and toolset packages required, will be written to a GLUE file included in the node bundle.

The node bundle will always be written into the root directory of the working area containing the root node of the node tree being packed into the archive. The name of the archive is automatically generated based on the name of the root node and the time when the operation begins. The full path to the create JAR file is returned by this method if successfull.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status. All nodes to be packed into the node bundle must be in a Finished (blue) state. Any nodes not in a Finished state will cause the entire operation to abort.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name of the root node.
Returns:: The abstract file system path to the newly create node bundle.
Throws:: PipelineException - If unable to create the node bundle containing the nodes.
See Also:: extractBundle(us.temerity.pipeline.Path), unpackNodes(us.temerity.pipeline.Path, java.lang.String, java.lang.String, boolean, us.temerity.pipeline.builder.ActionOnExistence, java.util.TreeMap, java.util.TreeMap, java.util.TreeMap, java.util.TreeMap, java.util.TreeMap)

packNodes

public Path packNodes(NodeID nodeID)
               throws PipelineException

Create a new node bundle (JAR achive) by packing up a tree of nodes from a working area rooted at the given node.

Create a new node JAR archive by packing up a tree of nodes from a working area rooted at the given node.

If the owner of the root node is different than the current user, this method will fail unless the current user has privileged access status. All nodes to be packed into the JAR archive must be in a Finished (blue) state. Any nodes not in a Finished state will cause the entire operation to abort.

Parameters:: nodeID - The unique working version identifier of the root node.
Returns:: The abstract file system path to the newly create node bundle.
Throws:: PipelineException - If unable to create the node bundle containing the nodes.
See Also:: extractBundle(us.temerity.pipeline.Path), unpackNodes(us.temerity.pipeline.Path, java.lang.String, java.lang.String, boolean, us.temerity.pipeline.builder.ActionOnExistence, java.util.TreeMap, java.util.TreeMap, java.util.TreeMap, java.util.TreeMap, java.util.TreeMap)

extractBundle

public NodeBundle extractBundle(Path bundlePath)
                         throws PipelineException

Extract the node metadata from a node bundle containing a tree of nodes packed at another site.

This method is useful for querying for information about the toolsets being used by the nodes in the node bundle without unpacking them. Using this information, a suitable mapping of toolsets from the site which created the nodes to the toolsets at the local site can be generated. If this remapping of toolsets is not specified, than the default toolset at the local site will be used for all unpacked nodes. In many cases, this will not be sufficient to insure that the nodes function properly after being unpacked.

Parameters:: bundlePath - The abstract file system path to the node bundle.
Throws:: PipelineException - If unable to extract the node metadata from the node bundle.
See Also:: packNodes(java.lang.String, java.lang.String, java.lang.String), unpackNodes(us.temerity.pipeline.Path, java.lang.String, java.lang.String, boolean, us.temerity.pipeline.builder.ActionOnExistence, java.util.TreeMap, java.util.TreeMap, java.util.TreeMap, java.util.TreeMap, java.util.TreeMap)

unpackNodes

public void unpackNodes(Path bundlePath,
                        String author,
                        String view,
                        boolean releaseOnError,
                        ActionOnExistence actOnExist,
                        TreeMap<String,VersionID> lockedVersions,
                        TreeMap<String,String> toolsetRemap,
                        TreeMap<String,String> selectionKeyRemap,
                        TreeMap<String,String> licenseKeyRemap,
                        TreeMap<String,String> hardwareKeyRemap)
                 throws PipelineException

Unpack a node bundle containing a tree of nodes packed at another site into the given working area.

Parameters:: bundlePath - The abstract file system path to the node bundle.; author - The name of the user which owns the working version.; view - The name of the user's working area view.; releaseOnError - Whether to release all newly registered and/or modified nodes from the working area if an error occurs in unpacking the node bundle.; actOnExist - What steps to take when encountering previously existing local versions of nodes being unpacked.; lockedVersions - The revision numbers for local checked-in node versions to use for specific nodes locked in the bundle. A valid checked-in version must exist for each locked node in the bundle or a PipelineException wil be thrown.; toolsetRemap - A table mapping the names of toolsets associated with the nodes in the node bundle to toolsets at the local site. Toolsets not found in this table will be remapped to the local default toolset instead.; selectionKeyRemap - A table mapping the names of selection keys associated with the nodes in the node bundle to selection keys at the local site. Any selection keys not found in this table will be ignored.; licenseKeyRemap - A table mapping the names of license keys associated with the nodes in the node bundle to license keys at the local site. Any license keys not found in this table will be ignored.
Throws:: PipelineException - If unable to unpack the nodes from the node bundle.
See Also:: packNodes(java.lang.String, java.lang.String, java.lang.String), extractBundle(us.temerity.pipeline.Path)

extractSiteVersion

public Path extractSiteVersion(String name,
                               VersionID vid,
                               TreeSet<String> referenceNames,
                               String localSiteName,
                               TreeSet<FileSeq> replaceSeqs,
                               TreeMap<String,String> replacements,
                               Path dir)
                        throws PipelineException

Creates a JAR archive containing both files and metadata associated with a checked-in version of a node suitable for transfer to a remote site.

The JAR archive will contain a copy of the original NodeVersion which has been altered from its original form in several ways:

The full name of the target node as well as the names of any source nodes of this target node will have been changed to append the "localSiteName" as the last directory component of the node path before the node prefix.

For each source node listed in the "referenceNames", the link type will be changed to Reference. The name of the source nodes will also be modified to include the "localSiteName" as the last directory component. Any source nodes not contained in "referenceNames" will be removed as a source for the target node.

Any action associated with the target node will be removed. A RemoteVersion per-version annotation will be added to the NodeVersion who's annotation parameters included detailed information about the original node version being extracted. This includes the original node name, local site name as well as information about when the JAR archive was created and by whom.

Each file associated with the target node will also be copied and included in the JAR archive generated. These files will also be altered from their original in the following ways:

The names of the files will similarly renamed to include the local site name as the last directory component of the file path.

If a file is part of one of the primary/secondary file sequences contained in "replaceSeqs", then a series of string substitutions will be performed on each file to make it portable to the new site. All occurances of the names of source nodes included in the "referenceNames" will be automatically changed to include the local site name. In addition, all key entries in the "replacements" table will replaced by their value in this table. This provides a way of adding in any arbitrary site localization fixes which may be node specific.

In addition to a GLUE format file containing the altered NodeVersion copy and associated node files, a "README" text file will also be added to the JAR archive which details the contents and all changes made to the node version being extracted.

If successfull, the JAR archive file will be written to the directory named by "dir" and given a unique name based on the timestamp of when the archive was created. The full filesystem path of this uniquely named JAR file will be returned by this method.

This method will go away when true multi-site support is added to Pipeline.

Specified by:: extractSiteVersion in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name of the node to extract.; vid - The revision number of the node version to extract.; referenceNames - The fully resolved names of the source nodes to include as Reference links or null if no links should be included.; localSiteName - Name for the local site which will be used to modify extracted node names.; replaceSeqs - The primary and secondary file sequences associated with the node to which all string replacements should be applied or null to skip all file contents replacements.; replacements - The table of additional string replacements to perform on the files associated with the node version being extracted or null if there are no additional replacements.; dir - The directory in which to place the JAR archive created.
Returns:: The full file system path of the created JAR archive.
Throws:: PipelineException

lookupSiteVersion

public NodeVersion lookupSiteVersion(Path jarPath)
                              throws PipelineException

Lookup the NodeVersion contained within the extracted site version JAR archive.

Parameters:: jarPath - The full file system path to the JAR archive containing the node version.
Throws:: PipelineException

isSiteVersionInserted

public boolean isSiteVersionInserted(Path jarPath)
                              throws PipelineException

Whether the extracted node contained in the given JAR archive has already been inserted into the node database.

Parameters:: jarPath - The full file system path to the JAR archive containing the node version to insert.
Throws:: PipelineException

getMissingSiteVersionRefs

public TreeMap<String,VersionID> getMissingSiteVersionRefs(Path jarPath)
                                                    throws PipelineException

Checks each of the source nodes referenced by the extracted node contained in the given JAR archive and returns the names and versions of any of them that are not already in the node database.

Parameters:: jarPath - The full file system path to the JAR archive containing the node version to insert.
Returns:: The names and versions of the missing nodes.
Throws:: PipelineException

insertSiteVersion

public void insertSiteVersion(Path jarPath)
                       throws PipelineException

Inserts a node version into the local node database previously extraced from a remote site using the

extractSiteVersion(java.lang.String, us.temerity.pipeline.VersionID, java.util.TreeSet, java.lang.String, java.util.TreeSet, java.util.TreeMap, us.temerity.pipeline.Path)

method.

There several conditions which must be met in order for the node version to be successfully inserted:

If there is are any existing versions of the node being inserted, the RemoteNode per-node annotation must be currently associated with the node. If not, this probably indicates a potential name conflict between a locally created node an the remotely created node being inserted.

The specific version being inserted must not already exist in the node database.

If the version being inserted has Reference source nodes, then the specific versions of these nodes required must already exist.

If the node version being inserted is the first version to be created for a node, then a per-node RemoteNode annotation will also be added to the node.

Parameters:: jarPath - The full file system path to the JAR archive containing the node version to insert.
Throws:: PipelineException

getNodeEvents

public MappedLinkedList<Long,BaseNodeEvent> getNodeEvents(TreeSet<String> names,
                                                          TreeSet<String> users,
                                                          TimeInterval interval)
                                                   throws PipelineException

Retrieve the record of all significant operations involving the given nodes and users during the specified time interval.

Specified by:: getNodeEvents in interface MasterMgrLightClient

Parameters:: names - Limit the events to those associated with the given fully resolved node names or null for all nodes.; users - Limit the events to those generated by the given user names or null for all users.; interval - Limit the events to those which occured within the given time interval or null for all times.
Returns:: The events indexed by the timestamp (milliseconds since midnight, January 1, 1970 UTC) at which the events occurred.
Throws:: PipelineException - If unable to retrieve the events.

editingStarted

public Long editingStarted(NodeID nodeID,
                           BaseEditor editor)
                    throws PipelineException

Signal that an Editor plugin has started editing files associated with the given working version of a node.

Parameters:: nodeID - The unique working version identifier.; editor - The Editor plugin instance.
Returns:: A unique ID for the editing session.
Throws:: PipelineException - If unable to contact the server.

editingFinished

public void editingFinished(Long editID)
                     throws PipelineException

Signal that an Editor plugin has finished editing files associated with the working version of a node.

Parameters:: editID - The unique ID for the editing session.
Throws:: PipelineException - If unable to contact the server.

getWorkingAreasEditing

public TreeMap<String,TreeSet<String>> getWorkingAreasEditing(String name)
                                                       throws PipelineException

Get the table of the working areas in which the given node is currently being edited.

Specified by:: getWorkingAreasEditing in interface MasterMgrLightClient

Parameters:: name - The fully resolved node name.
Returns:: The table of working area view names indexed by author user name.
Throws:: PipelineException - If unable to determine the working areas.

submitJobs

public LinkedList<QueueJobGroup> submitJobs(String author,
                                            String view,
                                            String name,
                                            TreeSet<Integer> indices)
                                     throws PipelineException

Submit the group of jobs needed to regenerate the selected Stale files associated with a tree of nodes rooted at the given node.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; indices - The file sequence indices of the files to regenerate or null to regenerate all Stale files.
Returns:: The list of newly submitted job groups.
Throws:: PipelineException - If unable to generate or submit the jobs.

submitJobs

public LinkedList<QueueJobGroup> submitJobs(String author,
                                            String view,
                                            String name,
                                            TreeSet<Integer> indices,
                                            Integer batchSize,
                                            Integer priority,
                                            Integer rampUp,
                                            Float maxLoad,
                                            Long minMemory,
                                            Long minDisk,
                                            Set<String> selectionKeys,
                                            Set<String> licenseKeys,
                                            Set<String> hardwareKeys)
                                     throws PipelineException

Submit the group of jobs needed to regenerate the selected Stale files associated with the tree of nodes rooted at the given node.

The batchSize, priority or selectionKeys parameters (if not null) will override the settings when creating jobs associated with the root node of this submisssion. However, the node will not be modified by this operation and all jobs associated with nodes upstream of the root node of the submission will be unaffected.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; indices - The file sequence indices of the files to regenerate or null to regenerate all Stale files.; batchSize - For parallel jobs, this overrides the maximum number of frames assigned to each job associated with the root node of the job submission.; priority - Overrides the priority of jobs associated with the root node of the job submission relative to other jobs.; rampUp - The ramp-up interval (in seconds) for the job.; selectionKeys - Overrides the set of selection keys an eligable host is required to have for jobs associated with the root node of the job submission.; licenseKeys - Overrides the set of license keys required by them job associated with the root node of the job submission.
Returns:: The list of newly submitted job groups.
Throws:: PipelineException - If unable to generate or submit the jobs.

submitJobs

public LinkedList<QueueJobGroup> submitJobs(NodeID nodeID,
                                            TreeSet<Integer> indices)
                                     throws PipelineException

Submit the group of jobs needed to regenerate the selected Stale files associated with the tree of nodes rooted at the given node.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; indices - The file sequence indices of the files to regenerate or null to regenerate all Stale files.
Returns:: The list of newly submitted job groups.
Throws:: PipelineException - If unable to generate or submit the jobs.

submitJobs

public LinkedList<QueueJobGroup> submitJobs(NodeID nodeID,
                                            TreeSet<Integer> indices,
                                            Integer batchSize,
                                            Integer priority,
                                            Integer rampUp,
                                            Float maxLoad,
                                            Long minMemory,
                                            Long minDisk,
                                            Set<String> selectionKeys,
                                            Set<String> licenseKeys,
                                            Set<String> hardwareKeys)
                                     throws PipelineException

Submit the group of jobs needed to regenerate the selected Stale files associated with the tree of nodes rooted at the given node.

It is possible that more than one job group will be generated when there are Association links involved. Pipeline treats the network of nodes upstream of an Assocation link as independent from the nodes on the downstream side of the link in terms of staleness and therefore job group generation. When Association links are encountered, there may be additional job groups submitted rooted at the first stale node on the upstream side of each Association link.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; indices - The file sequence indices of the files to regenerate or null to regenerate all Stale files.; batchSize - For parallel jobs, this overrides the maximum number of frames assigned to each job associated with the root node of the job submission.; priority - Overrides the priority of jobs associated with the root node of the job submission relative to other jobs.; rampUp - The ramp-up interval (in seconds) for the job.; maxLoad - The maximum system load allowed on an eligible host.; minMemory - The minimum amount of free memory (in bytes) required on an eligible host.; minDisk - The minimum amount of free temporary local disk space (in bytes) required on an eligible host.; selectionKeys - Overrides the set of selection keys an eligable host is required to have for jobs associated with the root node of the job submission.; licenseKeys - Overrides the set of license keys required by them job associated with the root node of the job submission.
Returns:: The list of newly submitted job groups.
Throws:: PipelineException - If unable to generate or submit the jobs.

resubmitJobs

public LinkedList<QueueJobGroup> resubmitJobs(NodeID nodeID,
                                              TreeSet<FileSeq> targetSeqs,
                                              Integer batchSize,
                                              Integer priority,
                                              Integer rampUp,
                                              Float maxLoad,
                                              Long minMemory,
                                              Long minDisk,
                                              Set<String> selectionKeys,
                                              Set<String> licenseKeys,
                                              Set<String> hardwareKeys)
                                       throws PipelineException

Resubmit the group of jobs needed to regenerate the selected Stale primary file sequences for the tree of nodes rooted at the given node.

This method is typically used to resubmit aborted or failed jobs. The selected files to regenerate are provided as target primary file sequences instead of file indices. The correct indices for each file defined by these target sequences will be computed and new job batches will be submitted for these files.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; targetSeqs - The target primary file sequences to regenerate.; batchSize - For parallel jobs, this overrides the maximum number of frames assigned to each job associated with the root node of the job submission.; priority - Overrides the priority of jobs associated with the root node of the job submission relative to other jobs.; rampUp - The ramp-up interval (in seconds) for the job.; maxLoad - The maximum system load allowed on an eligible host.; minMemory - The minimum amount of free memory (in bytes) required on an eligible host.; minDisk - The minimum amount of free temporary local disk space (in bytes) required on an eligible host.; selectionKeys - Overrides the set of selection keys an eligable host is required to have for jobs associated with the root node of the job submission.; licenseKeys - Overrides the set of license keys required by them job associated with the root node of the job submission.
Returns:: The list of newly submitted job groups.
Throws:: PipelineException - If unable to generate or submit the jobs.

vouch

public void vouch(String author,
                  String view,
                  String name)
           throws PipelineException

Vouch for the up-to-date status of the working area files associated with a node.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.
Throws:: PipelineException - If unable to vouch for the files.

vouch

public void vouch(NodeID nodeID)
           throws PipelineException

Vouch for the up-to-date status of the working area files associated with a node.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.
Throws:: PipelineException - If unable to vouch for the files.

removeFiles

public void removeFiles(String author,
                        String view,
                        String name,
                        TreeSet<Integer> indices)
                 throws PipelineException

Remove the working area files associated with a node.

If the author argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.; name - The fully resolved node name.; indices - The file sequence indices of the files to remove or null to remove all files.
Throws:: PipelineException - If unable to remove the files.

removeFiles

public void removeFiles(NodeID nodeID,
                        TreeSet<Integer> indices)
                 throws PipelineException

Remove the working area files associated with a node.

If the nodeID argument is different than the current user, this method will fail unless the current user has privileged access status.

Parameters:: nodeID - The unique working version identifier.; indices - The file sequence indices of the files to remove or null to remove all files.
Throws:: PipelineException - If unable to remove the files.

hasUnfinishedJobs

public boolean hasUnfinishedJobs(String author,
                                 String view)
                          throws PipelineException

Whether the given working area contains any nodes for which there are unfinished jobs currently in the queue.

A job is considered unfinished if it has as JobState of: Queued, Preempted, Paused, Running or Limbo.

Parameters:: author - The name of the user which owns the working area.; view - The name of the user's working area view.
Throws:: PipelineException - If unable to perform the operation.

hasUnfinishedJobs

public boolean hasUnfinishedJobs(String author,
                                 String view,
                                 String pattern)
                          throws PipelineException

Whether the given working area contains matching nodes for which there are unfinished jobs currently in the queue.

A job is considered unfinished if it has as JobState of: Queued, Preempted, Paused, Running or Limbo.

Parameters:: author - The name of the user which owns the working area.; view - The name of the user's working area view.; pattern - A regular expression pattern used to match the fully resolved names of nodes or null to match all nodes.
Throws:: PipelineException - If unable to perform the operation.

getUnfinishedJobs

public MappedSet<String,Long> getUnfinishedJobs(String author,
                                                String view)
                                         throws PipelineException

Get all unfinished jobs for the any nodes contained in the given working area.

A job is considered unfinished if it has as JobState of: Queued, Preempted, Paused, Running or Limbo.

Parameters:: author - The name of the user which owns the working area.; view - The name of the user's working area view.
Returns:: The unfinished jobIDs indexed node name.
Throws:: PipelineException - If unable to perform the operation.

getUnfinishedJobs

public MappedSet<String,Long> getUnfinishedJobs(String author,
                                                String view,
                                                String pattern)
                                         throws PipelineException

Get all unfinished jobs for the matching nodes contained in the given working area.

A job is considered unfinished if it has as JobState of: Queued, Preempted, Paused, Running or Limbo.

Parameters:: author - The name of the user which owns the working area.; view - The name of the user's working area view.; pattern - A regular expression pattern used to match the fully resolved names of nodes or null to match all nodes.
Returns:: The unfinished jobIDs indexed node name.
Throws:: PipelineException - If unable to perform the operation.

backupDatabase

public void backupDatabase(Path dir)
                    throws PipelineException

Create a set of database backup files.

The backup will not be perfomed until any currently running database operations have completed. Once the databsae backup has begun, all new database operations will blocked until the backup is complete. The this reason, the backup should be performed during non-peak hours.

The database backup files will be automatically named:

plmaster-db.YYMMDD.HHMMSS.tgz

plqueuemgr-db.YYMMDD.HHMMSS.tgz

plpluginmgr-db.YYMMDD.HHMMSS.tgz

Where YYMMDD.HHMMSS is the year, month, day, hour, minute and second of the backup. The backup file is a gzip(1) compressed tar(1) archive of the GLUE format files which make of the persistent storage of the Pipeline database.

Only privileged users may create a database backup.

Parameters:: dir - The full path to the directory to store backup files. This path is will be interpreted as local to each of the machines running the plmaster, plqueuemgr and plpluginmgr daemons.
Throws:: PipelineException - If unable to perform the backup.

archiveQuery

public ArrayList<ArchiveInfo> archiveQuery(String pattern,
                                           Integer maxArchives)
                                    throws PipelineException

Get archive related information about the checked-in versions which match the given criteria.

Parameters:: pattern - A regular expression pattern used to match the fully resolved names of nodes or null for all nodes.; maxArchives - The maximum allowable number of archive volumes which contain the checked-in version in order for it to be included in the returned list or null for any number of archives.
Returns:: Information about the archival state of each matching checked-in version.
Throws:: PipelineException - If unable to determine which checked-in versions match the criteria.

getArchivedSizes

public DoubleMap<String,VersionID,Long> getArchivedSizes(MappedSet<String,VersionID> versions)
                                                  throws PipelineException

Calculate the total size (in bytes) of the files associated with the given checked-in versions for archival purposes.

File sizes are computed from the target of any symbolic links and therefore reflects the amount of bytes that would need to be copied if the files where archived. This may be considerably more than the actual amount of disk space used when several versions of a node have some identical files.

Parameters:: versions - The fully resolved node names and revision numbers of the checked-in versions.
Returns:: The total version file sizes indexed by fully resolved node name and revision number.
Throws:: PipelineException

offlineQuery

public ArrayList<OfflineInfo> offlineQuery(String pattern,
                                           Integer excludeLatest,
                                           Integer minArchives,
                                           boolean unusedOnly)
                                    throws PipelineException

Get offline related information about the checked-in versions which match the given criteria.

Parameters:: pattern - A regular expression pattern used to match the fully resolved names of nodes or null for all nodes.; excludeLatest - The number of latest checked-in versions of the node to exclude from the returned list or null to include all versions.; minArchives - The minimum number of archive volumes containing the checked-in version in order for it to be inclued in the returned list or null for any number of archives.; unusedOnly - Whether to only include checked-in versions which can be offlined.
Returns:: Information about the offline state of each matching checked-in version.
Throws:: PipelineException - If unable to determine which checked-in versions match the criteria.

getOfflineVersionIDs

public TreeSet<VersionID> getOfflineVersionIDs(String name)
                                        throws PipelineException

Get the revision nubers of all offline checked-in versions of the given node.

Parameters:: name - The fully resolved node name.
Throws:: PipelineException - If unable to determine the offline versions.

getOfflineSizes

public DoubleMap<String,VersionID,Long> getOfflineSizes(MappedSet<String,VersionID> versions)
                                                 throws PipelineException

Calculate the total size (in bytes) of the files associated with the given checked-in versions for offlining purposes.

File sizes reflect the actual amount of bytes that will be freed from disk if the given checked-in versions are offlined. A file will only contribute to this freed size if it a regular file and there are no symbolic links from later online versions which target and which are not associated with the given versions.

Parameters:: versions - The fully resolved node names and revision numbers of the checked-in versions.
Returns:: The total version file sizes indexed by fully resolved node name and revision number.
Throws:: PipelineException

offline

public void offline(MappedSet<String,VersionID> versions)
             throws PipelineException

Remove the repository files associated with the given checked-in versions.

All checked-in versions to be offlined must have prevously been included in at least one archive.

The offline operation will not be perfomed until any currently running database operations have completed. Once the offline operation has begun, all new database operations will blocked until the offline operation is complete. The this reason, this should be performed during non-peak hours.

Only privileged users may offline checked-in versions.

Parameters:: versions - The fully resolved names and revision numbers of the checked-in versions to offline.
Throws:: PipelineException

offline

public void offline(MappedSet<String,VersionID> versions,
                    StringBuilder dryRunResults)
             throws PipelineException

Remove the repository files associated with the given checked-in versions.

All checked-in versions to be offlined must have prevously been included in at least one archive.

Only privileged users may offline checked-in versions.

Parameters:: versions - The fully resolved names and revision numbers of the checked-in versions to offline.; dryRunResults - If not null, the operation will not be performed but the given buffer will be filled with a message detailing the steps that would have been performed during an actual execution.
Throws:: PipelineException

restoreQuery

public TreeMap<String,TreeSet<VersionID>> restoreQuery(String pattern)
                                                throws PipelineException

Get the names and revision numbers of the offline checked-in versions who's names match the given criteria.

Parameters:: pattern - A regular expression pattern used to match the fully resolved names of nodes or null for all nodes.
Returns:: The fully resolved node names and revision numbers of the matching versions.
Throws:: PipelineException - If unable to determine which checked-in versions match the criteria.

requestRestore

public void requestRestore(TreeMap<String,TreeSet<VersionID>> versions)
                    throws PipelineException

Submit a request to restore the given set of checked-in versions.

Parameters:: versions - The fully resolved names and revision numbers of the checked-in versions.
Throws:: PipelineException

denyRestore

public void denyRestore(TreeMap<String,TreeSet<VersionID>> versions)
                 throws PipelineException

Deny the request to restore the given set of checked-in versions.

Parameters:: versions - The fully resolved names and revision numbers of the checked-in versions.
Throws:: PipelineException

getRestoreRequests

public TreeMap<String,TreeMap<VersionID,RestoreRequest>> getRestoreRequests()
                                                                     throws PipelineException

Get the requests for restoration of checked-in versions.

Returns:: The restore requests for checked-in versions indexed by fully resolved node name and revision number.
Throws:: PipelineException

getRestoreSizes

public DoubleMap<String,VersionID,Long> getRestoreSizes(MappedSet<String,VersionID> versions)
                                                 throws PipelineException

Calculate the total size (in bytes) of the files associated with the given checked-in versions for restoration purposes.

File sizes reflect the total amount of bytes of disk space that will be need to be available in order to restore the given offline checked-in versions. The actual amount of disk space used after the completion of the restore operation may be less than this amount if some of the restored files are identical to the corresponding files in an earlier online version.

Parameters:: versions - The fully resolved node names and revision numbers of the checked-in versions.
Returns:: The total version file sizes indexed by fully resolved node name and revision number.
Throws:: PipelineException

restore

public void restore(String name,
                    TreeMap<String,TreeSet<VersionID>> versions,
                    BaseArchiver archiver,
                    String toolset)
             throws PipelineException

Restore the given checked-in versions from the given archive volume.

Only privileged users may restore checked-in versions.

If an alternative archiver plugin instance is passed as the archiver parameter, it must have exactly the same plugin name and revision number as the archiver plugin used to create the archive volume. The archiver plugin parameters can be different to allow for possible changes in file system or site organization.

Parameters:: name - The unique name of the archive containing the checked-in versions to restore.; versions - The fully resolved names and revision numbers of the checked-in versions to restore.; archiver - The alternative archiver plugin instance used to perform the restore operation or null to use the original archiver.; toolset - The name of the toolset environment under which the archiver is executed or null to use the original toolset.
Throws:: PipelineException - If unable to restore the checked-in versions.

restore

public void restore(String name,
                    TreeMap<String,TreeSet<VersionID>> versions,
                    BaseArchiver archiver,
                    String toolset,
                    StringBuilder dryRunResults)
             throws PipelineException

Restore the given checked-in versions from the given archive volume.

Only privileged users may restore checked-in versions.

Parameters:: name - The unique name of the archive containing the checked-in versions to restore.; versions - The fully resolved names and revision numbers of the checked-in versions to restore.; archiver - The alternative archiver plugin instance used to perform the restore operation or null to use the original archiver.; toolset - The name of the toolset environment under which the archiver is executed or null to use the original toolset.; dryRunResults - If not null, the operation will not be performed but the given buffer will be filled with a message detailing the steps that would have been performed during an actual execution.
Throws:: PipelineException - If unable to restore the checked-in versions.

getArchivedOn

public TreeMap<String,Long> getArchivedOn()
                                   throws PipelineException

Get the names and creation timestamps of all existing archives.

Returns:: The timestamps (milliseconds since midnight, January 1, 1970 UTC) of when each archive was created indexed by unique archive volume name.
Throws:: PipelineException - If unable to determine when the archive volumes where created.

getRestoredOn

public TreeMap<String,TreeSet<Long>> getRestoredOn()
                                            throws PipelineException

Get the names and restoration timestamps of all existing archives.

Returns:: The timestamps (milliseconds since midnight, January 1, 1970 UTC) of when each archive was restored indexed by unique archive volume name.
Throws:: PipelineException - If unable to determine when the archive volumes where restored.

getArchivedOutput

public String getArchivedOutput(String aname)
                         throws PipelineException

Get the STDOUT output from running the Archiver plugin during the creation of the given archive volume.

Parameters:: aname - The name of the archive volume.
Returns:: The STDOUT output.
Throws:: PipelineException - If unable to find an archive volume with the given name.

getRestoredOutput

public String getRestoredOutput(String aname,
                                long stamp)
                         throws PipelineException

Get the STDOUT output from running the Archiver plugin during the restoration of the given archive volume at the given time.

Parameters:: aname - The name of the archive volume.; stamp - The timestamp (milliseconds since midnight, January 1, 1970 UTC) of when the archive volume was restored.
Returns:: The STDOUT output.
Throws:: PipelineException - If unable to find an archive volume with the given name.

getArchivesContaining

public DoubleMappedSet<String,VersionID,String> getArchivesContaining(MappedSet<String,VersionID> versions)
                                                               throws PipelineException

Get the names of the archive volumes containing the given checked-in versions.

If there are no archive volume which contain a checked-in version, it will be ommitted from the returned tables.

Parameters:: versions - The fully resolved names and revision numbers of the checked-in versions.
Returns:: The names of the archives containing the requested checked-in versions indexed by fully resolved node name and revision number.
Throws:: PipelineException - If determine which archives contain the versions.

getArchive

public ArchiveVolume getArchive(String name)
                         throws PipelineException

Get the complete information about the archive with the given name.

Parameters:: name - The unique name of the archive.
Returns:: The archive information.
Throws:: PipelineException - If unable to find the archive.

createInitialPanelLayout

public void createInitialPanelLayout(String name,
                                     String author,
                                     String view)
                              throws PipelineException

Create a default saved panel layout file.

The layout is copied from an initial default layout provided with the Pipeline release. This layout is provided as a helpful starting point for new users when creating custom layouts. The created panels will be set to view the working area specified by the author and view parameters.

Parameters:: name - The name of the created layout.; author - The name of the user which owns the working version.; view - The name of the user's working area view.
Throws:: PipelineException - If unable to create the layout.

getInitialPanelLayout

public String getInitialPanelLayout(String author,
                                    String view)
                             throws PipelineException

Retrieve the contents of the site default saved panel layout file.

Parameters:: author - The name of the user which owns the working version.; view - The name of the user's working area view.
Throws:: PipelineException - If unable to create the layout.

getObjectInput

protected ObjectInput getObjectInput(InputStream in)
                              throws IOException

Get the object input given a socket input stream.

Overrides:: getObjectInput in class BaseMgrClient

Throws:: IOException

getServerDownMessage

protected String getServerDownMessage()

Get the error message to be shown when the server cannot be contacted.

Overrides:: getServerDownMessage in class BaseMgrClient

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

TEMERITY

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

us.temerity.pipeline Class MasterMgrClient

MasterMgrClient

MasterMgrClient

shutdown

shutdown

getWorkGroups

setWorkGroups

getPrivileges

editPrivileges

getPrivilegeDetails

getPrivilegeDetails

getLogControls

setLogControls

getRuntimeControls

setRuntimeControls

getDefaultToolsetName

setDefaultToolsetName

getActiveToolsetNames

setToolsetActive

getToolsetNames

getToolsetNames

getAllToolsetNames

getToolset

getToolset

getOsToolsets

getToolsetEnvironment

getToolsetEnvironment

createToolset

getToolsetPackageNames

getToolsetPackageNames

getAllToolsetPackageNames

getToolsetPackage

getToolsetPackage

getToolsetPackages

createToolsetPackage

getPluginMenuLayouts

getSelectPackagePlugins

getSelectPackagePlugins

getEditorMenuLayout

setEditorMenuLayout

getEditorMenuLayout

setEditorMenuLayout

getToolsetEditorPlugins

getPackageEditorPlugins

setPackageEditorPlugins

getComparatorMenuLayout

setComparatorMenuLayout

getComparatorMenuLayout

setComparatorMenuLayout

getToolsetComparatorPlugins

getPackageComparatorPlugins

setPackageComparatorPlugins

getActionMenuLayout

setActionMenuLayout

getActionMenuLayout

setActionMenuLayout

getToolsetActionPlugins

getPackageActionPlugins

setPackageActionPlugins

getToolMenuLayout

setToolMenuLayout

getToolMenuLayout

setToolMenuLayout

getToolsetToolPlugins

getPackageToolPlugins

setPackageToolPlugins

getArchiverMenuLayout

setArchiverMenuLayout

getArchiverMenuLayout

setArchiverMenuLayout

getToolsetArchiverPlugins

getPackageArchiverPlugins

setPackageArchiverPlugins

getMasterExtMenuLayout

setMasterExtMenuLayout

getMasterExtMenuLayout

setMasterExtMenuLayout

getToolsetMasterExtPlugins

getPackageMasterExtPlugins

setPackageMasterExtPlugins

us.temerity.pipeline
Class MasterMgrClient