com.phoenix_int.aserver.library
Class PHXCVSLibrarian

java.lang.Object
  com.phoenix_int.aserver.library.PHXCVSLibrarian

All Implemented Interfaces:

IPHXLibrarian, IPHXVersionedLibrarian

public class PHXCVSLibrarian
extends java.lang.Object
implements IPHXVersionedLibrarian

Implementation of IPHXLibrarian which loads files out of CVS. This class generates a directory in the scratch directory called "CVSLIB" which contains its cache data. A single copy of the latest version out of cvs is kept there for component browsing. When a component is requested with "instantiate", it generates a temp directory in CVSLIB and checks out the entire directory that contains that component into the temp dir. The temp dir gets deleted when the connection is dropped. In order to have consistent files, it figures out the commit time for the component requested, and then checks out all the files in the directory from that same date.

The required configuration parameters are defined on the initialize() method.

This class requires passwordless access to cvs and does not currently provide any access control functions (.aserver files do not work).

Constructor Summary

PHXCVSLibrarian()

Method Summary

void	cleanUp() Delete all the temp directories
PHXComponentDescription	describe(java.lang.String compClass, java.lang.String virtualDir) describes the specified component.
PHXComponentBranch	getComponentHistory(java.lang.String compClass, java.lang.String virtualDir) Gets all version information about a particular component 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.
java.lang.String	getQueues(java.lang.String compClass, java.lang.String virtualDir) method for getting Queues from CenterLink, AS just returns blank string
void	initialize(com.phoenix_int.aserver.ascore.PHXConnection connection, IPHXFactory factories, com.phoenix_int.aserver.ascore.PHXAServerArgs args, org.w3c.dom.Node xmlOptions) There are 2 options for this class.
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) 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 available sub-directories for the specified path

Methods inherited from class java.lang.Object

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

Constructor Detail

PHXCVSLibrarian

public PHXCVSLibrarian()

Method Detail

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)
                throws java.lang.Exception

There are 2 options for this class. The CVSROOT which should be set as if you were using the command line tools and the module in CVS which is the base for all the published components. The startModule cannot be blank. The XML format is:

 <librarianOptions>
  <CVSROOT>pathfinder:/shared/cvs</CVSROOT>
  <startModule>analyses</startModule>
 </librarianOptions>
 

Specified by:

initialize in interface IPHXLibrarian

Throws:

java.lang.Exception

cleanUp

public void cleanUp()

Delete all the temp directories

Specified by:

cleanUp in interface IPHXLibrarian

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:

listComponents in interface IPHXLibrarian

Parameters:

virtualDir - The directory the client asked for

Returns:

an array of class names

Throws:

java.io.IOException - if the directory could not be scanned

PHXNoSuchCategoryException

com.phoenix_int.aserver.security.PHXAccessDeniedException

listDirectories

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

Lists available sub-directories for the specified path

Specified by:

listDirectories in interface IPHXLibrarian

Returns:

a Collection of Strings

Throws:

PHXNoSuchCategoryException

com.phoenix_int.aserver.security.PHXAccessDeniedException

instantiate

public IPHXComponent instantiate(java.lang.String compClass,
                                 java.lang.String virtualDir,
                                 java.lang.String connector,
                                 java.lang.String queue)
                          throws java.lang.ClassNotFoundException,
                                 java.lang.IllegalAccessException,
                                 java.lang.InstantiationException,
                                 java.lang.reflect.InvocationTargetException,
                                 java.io.IOException,
                                 PHXServerSideException,
                                 java.net.MalformedURLException,
                                 com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException,
                                 PHXNoSuchCategoryException

creates an instance of the specified component.

Specified by:

instantiate in interface IPHXLibrarian

Parameters:

compClass - the class name for the component

directory - 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

java.io.IOException

PHXServerSideException

java.net.MalformedURLException

com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException

PHXNoSuchCategoryException

instantiate

public IPHXComponent instantiate(java.lang.String compClass,
                                 java.lang.String virtualDir)
                          throws java.lang.ClassNotFoundException,
                                 java.lang.IllegalAccessException,
                                 java.lang.InstantiationException,
                                 java.lang.reflect.InvocationTargetException,
                                 java.io.IOException,
                                 PHXServerSideException,
                                 java.net.MalformedURLException,
                                 com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException,
                                 PHXNoSuchCategoryException

Description copied from interface: IPHXLibrarian

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:

instantiate in interface IPHXLibrarian

Parameters:

compClass - the class name for the component

virtualDir - The directory the client asked for

Returns:

an instance of the specified component class

Throws:

java.lang.ClassNotFoundException - If compClass doesn't indicate a valid class for the specified directory

PHXNoSuchCategoryException - If the virtualDirName passed in is invalid

java.lang.IllegalAccessException

java.lang.InstantiationException

java.lang.reflect.InvocationTargetException

java.io.IOException

PHXServerSideException

java.net.MalformedURLException

com.phoenix_int.aserver.util.proxywrapper.PHXProxyNotAllowedException

getComponentHistory

public PHXComponentBranch getComponentHistory(java.lang.String compClass,
                                              java.lang.String virtualDir)
                                       throws java.lang.ClassNotFoundException,
                                              PHXNoSuchCategoryException,
                                              java.io.IOException

Description copied from interface: IPHXVersionedLibrarian

Gets all version information about a particular component

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:

getComponentHistory in interface IPHXVersionedLibrarian

Parameters:

compClass - the class name for the component

Returns:

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

Throws:

java.lang.ClassNotFoundException - If compClass doesn't indicate a valid class for the specified directory

PHXNoSuchCategoryException - If the virtualDirName passed in is invalid

java.io.IOException

describe

public PHXComponentDescription describe(java.lang.String compClass,
                                        java.lang.String virtualDir)
                                 throws java.lang.ClassNotFoundException,
                                        java.io.IOException,
                                        PHXServerSideException,
                                        java.net.MalformedURLException,
                                        PHXNoSuchCategoryException

describes the specified component.

TODO: Currently all descriptions come from the head.

Specified by:

describe in interface IPHXLibrarian

Parameters:

compClass - the class name for the component

dirName - the directory to search for the component class

Returns:

a description of the specified component class

Throws:

java.lang.ClassNotFoundException - if the class is not found

PHXNoSuchCategoryException - If the virtualDirName passed in is invalid

java.io.IOException

PHXServerSideException

java.net.MalformedURLException

getQueues

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

method for getting Queues from CenterLink, AS just returns blank string

Specified by:

getQueues in interface IPHXLibrarian

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:

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