## On this page # Class: PHXLibrarianCombiner Last update: 16.07.2025 **Package:** `com.phoenix_int.aserver.library` **Class Hierarchy** ``` ↳ java.lang.Object ↳ com.phoenix_int.aserver.library.PHXLibrarianCombiner ``` **Implemented Interfaces** - [`IPHXLibrarian`](IPHXLibrarian.md), [`IPHXLibrarian2`](IPHXLibrarian2.md), [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md), [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md), `IPHXVersionedLibrarian3` --- **Declaration** ```java public class PHXLibrarianCombiner extends java.lang.Object implements com.phoenix_int.aserver.library.IPHXVersionedLibrarian3 ``` This class combines several sub-librarians, adding dir lists and component lists together. If there is a conflict in component or directory name, the first librarian wins out, and no error is given. ## Constructor Summary Constructor and Description`PHXLibrarianCombiner()`## Method Summary Modifier and TypeMethod and Description`void``addLibrarian(IPHXLibrarian l)` Adds a librarian to our list`void``cleanUp()` Recursively tells kids to clean themselves up[`PHXComponentDescription`](../PHXComponentDescription.md)`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`](../PHXComponentBranch.md)`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)` Get the 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 and 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`](../PHXComponentResourcePair.md)`instantiateManaged(java.lang.String compClass, java.lang.String virtualDir)` Creates an instance of the specified component.[`PHXComponentResourcePair`](../PHXComponentResourcePair.md)`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)` Returns sub-directories from a specified directory### Methods inherited from class java.lang.Object `clone`, `equals`, `finalize`, `getClass`, `hashCode`, `notify`, `notifyAll`, `toString`, `wait`, `wait`, `wait` ## Constructor Detail ### PHXLibrarianCombiner ```java public PHXLibrarianCombiner() ``` ## Method Detail ### addLibrarian ```java public void addLibrarian(IPHXLibrarian l) ``` Adds a librarian to our list ### initialize ```java public void initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, IPHXFactory factories, com.phoenix_int.aserver.ascore.PHXAServerArgs args, org.w3c.dom.Node xmlOptions) throws java.lang.Exception ``` The XML initialization information for this class is simply a list of `` tags which contain `` and `` tags inside. Example: ```java com.phoenix_int.aserver.library.PHXDirectoryLibrarian ... .... ``` **Specified By:** - `initialize` in interface [`IPHXLibrarian`](IPHXLibrarian.md) **Throws:** - `java.lang.Exception` ### cleanUp ```java public void cleanUp() ``` Recursively tells kids to clean themselves up **Specified By:** - `cleanUp` in interface [`IPHXLibrarian`](IPHXLibrarian.md) ### listComponents ```java 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:** - `listComponents` in interface [`IPHXLibrarian`](IPHXLibrarian.md) **Parameters:** - `virtualDir` - The directory the client asked for **Returns:** - An array of class names **Throws:** - `com.phoenix_int.aserver.security.PHXAccessDeniedException` - if the directory could not be scanned - [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) ### listDirectories ```java public java.util.Collection listDirectories(java.lang.String virtualDir) throws PHXNoSuchCategoryException, com.phoenix_int.aserver.security.PHXAccessDeniedException ``` Returns sub-directories from a specified directory **Specified By:** - `listDirectories` in interface [`IPHXLibrarian`](IPHXLibrarian.md) **Parameters:** - `virtualDir` - The directory the client asked for **Returns:** - A Collection of Strings **Throws:** - [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - `com.phoenix_int.aserver.security.PHXAccessDeniedException` ### instantiate ```java public IPHXComponent instantiate(java.lang.String compClass, java.lang.String virtualDir) throws java.lang.Exception ``` Creates an instance of the specified component. **Specified By:** - `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) **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`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid - `java.lang.Exception` - If anything serious goes wrong ### instantiate (overload) ```java 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:** - `instantiate` in interface [`IPHXLibrarian`](IPHXLibrarian.md) **Throws:** - `java.lang.Exception` ### instantiateManaged ```java 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`](IPHXFactory.md). It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. **Specified By:** - `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) **Parameters:** - `compClass` - The class name for the component - `virtualDir` - The directory the client asked for **Returns:** - An instance of the specified component class and its managed resources ([`PHXComponentResourcePair`](../PHXComponentResourcePair.md)) **Throws:** - [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - 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) ```java 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`](IPHXFactory.md). It is important that this class throws [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) and `ClassNotFoundException` in the appropriate cases as they are handled in special ways by the librarian mounter and librarian combiner. **Specified By:** - `instantiateManaged` in interface [`IPHXLibrarian2`](IPHXLibrarian2.md) **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:** - An instance of the specified component class and its managed resources ([`PHXComponentResourcePair`](../PHXComponentResourcePair.md)) **Throws:** - [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - 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 ```java public PHXComponentDescription describe(java.lang.String compClass, java.lang.String virtualDir) throws java.lang.Exception ``` Describes the specified component. **Specified By:** - `describe` in interface [`IPHXLibrarian`](IPHXLibrarian.md) **Parameters:** - `compClass` - The class name for the component - `virtualDir` - The directory the client asked for **Returns:** - A description of the specified component class ([`PHXComponentDescription`](../PHXComponentDescription.md)) **Throws:** - `java.lang.ClassNotFoundException` - if the class is not found - [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid - `java.lang.Exception` - If anything goes wrong ### getQueues ```java public java.lang.String getQueues(java.lang.String compClass, java.lang.String virtualDir) throws java.lang.Exception ``` Get the queues for the specified component. **Specified By:** - `getQueues` in interface [`IPHXLibrarian`](IPHXLibrarian.md) **Parameters:** - `compClass` - The class name for the component - `virtualDir` - The directory the client asked for **Returns:** - A list of queues of the specified component class **Throws:** - `java.lang.ClassNotFoundException` - if the class is not found - [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - If the `virtualDirName` passed in is invalid - `java.lang.Exception` - If anything goes wrong ### getComponentHistory ```java 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:** - `getComponentHistory` in interface [`IPHXVersionedLibrarian`](IPHXVersionedLibrarian.md) **Parameters:** - `compClass` - The class name for the component - `virtualDir` - The directory the client asked for **Returns:** - An instance of [`PHXComponentBranch`](../PHXComponentBranch.md) which contains all the versions and sub-branches available **Throws:** - [`PHXNoSuchCategoryException`](PHXNoSuchCategoryException.md) - 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 ```java public java.lang.String getBranchesAndTags() throws java.lang.Exception ``` Fetches a list of all branches and tags. **Specified By:** - `getBranchesAndTags` in interface [`IPHXVersionedLibrarian2`](IPHXVersionedLibrarian2.md) **Throws:** - `java.lang.Exception` - If anything goes wrong