Skip to main content

ModelCenter Remote Execution Java API 2025 R2

Class: PHXLibrarianMounter

Last update: 16.07.2025

Package: com.phoenix_int.aserver.library

Class Hierarchy

↳ java.lang.Object
  ↳ com.phoenix_int.aserver.library.PHXLibrarianMounter

Implemented Interfaces


Declaration

public class PHXLibrarianMounter
extends java.lang.Object
implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3

This class has the functionality of providing a "virtual" directory tree where different sub-librarians can be mounted very similarly to the UNIX concept of mounting filesystems. When a librarian is mounted to a particular location, any components and directories that are available via a librarian mounted higher up in the directory tree are hidden.

This class will automatically add empty directories as necessary to ensure that you can "browse" to a mount point. For example, if you have not mounted anything to the root ("" or "/"), you can still mount to a subdirectory like "mount/here" and this class will create the empty directory "mount".

Only one librarian can be mounted in a given location. Use a PHXLibrarianCombiner to put multiple librarians in the same place.

Constructor Summary

Constructor and Description
PHXLibrarianMounter()

Method Summary

Modifier and Type Method and Description
void addLibrarian(java.lang.String mountPoint, IPHXLibrarian l)
Creates a librarian mount.
void cleanUp()
Recursively calls cleanUp on all our mount points
PHXComponentDescription describe(java.lang.String compClass, java.lang.String virtualDir)
Describes the specified component.
java.lang.String getBranchesAndTags()
Fetches a list of all branches and tags
PHXComponentBranch getComponentHistory(java.lang.String compClass, java.lang.String virtualDir)
Gets all version information about a particular component
java.lang.String getQueues(java.lang.String compClass, java.lang.String virtualDir)
Gets queues for the specified component.
void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, IPHXFactory factories, com.phoenix_int.aserver.ascore.PHXAServerArgs args, org.w3c.dom.Node xmlOptions)
The XML initialization information for this class is simply a list of tags which contain <className>, <mountPoint>, and <librarianOptions> tags inside.
IPHXComponent instantiate(java.lang.String compClass, java.lang.String virtualDir)
Creates an instance of the specified component.
IPHXComponent instantiate(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)
PHXComponentResourcePair instantiateManaged(java.lang.String compClass, java.lang.String virtualDir)
Creates an instance of the specified component.
PHXComponentResourcePair instantiateManaged(java.lang.String compClass, java.lang.String virtualDir, java.lang.String connector, java.lang.String queue)
Creates an instance of the specified component.
java.util.Collection listComponents(java.lang.String virtualDir)
Returns the components in a specific directory
java.util.Collection listDirectories(java.lang.String virtualDir)
Lists any available sub-directories from a particular directory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PHXLibrarianMounter

public PHXLibrarianMounter()

Method Detail

addLibrarian

public void addLibrarian(java.lang.String mountPoint,
                         IPHXLibrarian l)

Creates a librarian mount.

initialize

public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection,
                       IPHXFactory factories,
                       com.phoenix_int.aserver.ascore.PHXAServerArgs args,
                       org.w3c.dom.Node xmlOptions)

The XML initialization information for this class is simply a list of <librarian> tags which contain <className>, <mountPoint>, and <librarianOptions> tags inside.

Example:

 <librarianOptions>
  <librarian>
   <mountPoint>/mounthere</mountPoint>
   <className>com.phoenix_int.aserver.library.PHXDirectoryLibrarian</className>
   <librarianOptions> ... </librarianOptions>
  </librarian>
  <librarian>
   ....
  </librarian>
 </librarianOptions>

Specified By:

cleanUp

public void cleanUp()

Recursively calls cleanUp on all our mount points

Specified By:

listComponents

public java.util.Collection listComponents(java.lang.String virtualDir)
                                    throws PHXNoSuchCategoryException,
                                           com.phoenix_int.aserver.security.PHXAccessDeniedException

Returns the components in a specific directory

Specified By:

Parameters:

  • virtualDir - The directory the client asked for

Returns:

  • An array of class names

Throws:

listDirectories

public java.util.Collection listDirectories(java.lang.String virtualDir)
                                     throws PHXNoSuchCategoryException,
                                            com.phoenix_int.aserver.security.PHXAccessDeniedException

Lists any available sub-directories from a particular directory

Specified By:

Parameters:

  • virtualDir - The directory the client asked for

Returns:

  • A Collection of Strings

Throws:

instantiate

public IPHXComponent instantiate(java.lang.String compClass,
                                 java.lang.String virtualDir)
                          throws java.lang.Exception

Creates an instance of the specified component.

Specified By:

Parameters:

  • compClass - The class name for the component
  • virtualDir - The directory to search for the component class

Returns:

  • An instance of the associated component class with the file loaded

Throws:

  • java.lang.ClassNotFoundException - if the class is not found
  • java.lang.IllegalAccessException - cannot call constructor
  • java.lang.InstantiationException - cannot call constructor
  • java.lang.reflect.InvocationTargetException - if an exception if the specified component exists, but is not of the right type, or if an exception occurs while creating the class or loading the setup file
  • PHXNoSuchCategoryException - If the virtualDirName passed in is invalid
  • java.lang.Exception - If anything serious goes wrong

instantiate (overload)

public IPHXComponent instantiate(java.lang.String compClass,
                                 java.lang.String virtualDir,
                                 java.lang.String connector,
                                 java.lang.String queue)
                          throws java.lang.Exception

Specified By:

Throws:

  • java.lang.Exception

instantiateManaged

public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass,
                                                                           java.lang.String virtualDir)
                                                                    throws java.lang.Exception

Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the IPHXFactory.

It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner.

Specified By:

Parameters:

  • compClass - The class name for the component
  • virtualDir - The directory the client asked for

Returns:

Throws:

  • PHXNoSuchCategoryException - If the virtualDirName passed in is invalid
  • java.lang.ClassNotFoundException - If compClass doesn't indicate a valid class for the specified directory
  • java.lang.Exception - If anything serious goes wrong

instantiateManaged (overload)

public com.phoenix_int.aserver.PHXComponentResourcePair instantiateManaged(java.lang.String compClass,
                                                                           java.lang.String virtualDir,
                                                                           java.lang.String connector,
                                                                           java.lang.String queue)
                                                                    throws java.lang.Exception

Creates an instance of the specified component. Typically a librarian will find the appropriate files and pass the request off to the IPHXFactory.

It is important that this class throws PHXNoSuchCategoryException and ClassNotFoundException in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner.

Specified By:

Parameters:

  • compClass - The class name for the component
  • virtualDir - The directory the client asked for
  • connector - Name of the connector object to use
  • queue - Name of the queue object to use

Returns:

Throws:

  • PHXNoSuchCategoryException - If the virtualDirName passed in is invalid
  • java.lang.ClassNotFoundException - If compClass doesn't indicate a valid class for the specified directory
  • java.lang.Exception - If anything serious goes wrong

describe

public PHXComponentDescription describe(java.lang.String compClass,
                                        java.lang.String virtualDir)
                                 throws java.lang.Exception

Describes the specified component.

Specified By:

Parameters:

  • compClass - The class name for the component
  • virtualDir - The directory the client asked for

Returns:

Throws:

  • java.lang.ClassNotFoundException - if the class is not found
  • PHXNoSuchCategoryException - If the virtualDirName passed in is invalid
  • java.lang.Exception - If anything goes wrong

getQueues

public java.lang.String getQueues(java.lang.String compClass,
                                  java.lang.String virtualDir)
                           throws java.lang.Exception

Gets queues for the specified component.

Specified By:

Parameters:

  • compClass - The class name for the component
  • virtualDir - The directory the client asked for

Returns:

  • A list of queues for the specified component class

Throws:

  • java.lang.ClassNotFoundException - if the class is not found
  • PHXNoSuchCategoryException - If the virtualDirName passed in is invalid
  • java.lang.Exception - If anything goes wrong

getComponentHistory

public PHXComponentBranch getComponentHistory(java.lang.String compClass,
                                              java.lang.String virtualDir)
                                       throws java.lang.Exception

Gets all version information about a particular component.

Specified By:

Parameters:

  • compClass - The class name for the component
  • virtualDir - The directory the client asked for

Returns:

  • An instance of PHXComponentBranch which contains all the versions and sub-branches available

Throws:

  • PHXNoSuchCategoryException - If the virtualDirName passed in is invalid
  • java.lang.ClassNotFoundException - If compClass doesn't indicate a valid class for the specified directory
  • java.lang.Exception - If anything goes wrong

getBranchesAndTags

public java.lang.String getBranchesAndTags()
                                    throws java.lang.Exception

Fetches a list of all branches and tags.

Specified By:

Throws:

  • java.lang.Exception - If anything goes wrong

Connect with Ansys