CVS: jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces Application.java,1.3,1.4 ApplicationContext.java,1.7,1.8 ClassLoaderManager.java,1.4,1.5 ClassLoaderSet.java,1.2,1.3 ConfigurationInterceptor.java,1.2,1.3 ContainerConstants.java,1.7,1.8 Deployer.java,1.5,1.6 Installer.java,1.4,1.5 Kernel.java,1.6,1.7 LogManager.java,1.5,1.6 LoomException.java,1.1,1.2 SystemManager.java,1.5,1.6
Peter Donald <pdonald-yCVjj/[email protected]> Sat, 29 Nov 2003 07:45:03 -0600
| Newsgroups | gmane.comp.java.jcontainer.cvs |
|---|---|
| Message-ID | <[email protected]> |
Update of /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces
In directory hogshead.codehaus.org:/tmp/cvs-serv31016/loom/engine/src/java/org/jcontainer/loom/interfaces
Modified Files:
Application.java ApplicationContext.java
ClassLoaderManager.java ClassLoaderSet.java
ConfigurationInterceptor.java ContainerConstants.java
Deployer.java Installer.java Kernel.java LogManager.java
LoomException.java SystemManager.java
Log Message:
Remove email addie
Index: Application.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/Application.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- Application.java 2 Sep 2003 04:36:58 -0000 1.3
+++ Application.java 29 Nov 2003 13:44:29 -0000 1.4
@@ -90,11 +90,12 @@
* The Application is a self-contained component that performs a specific
* function.
*
- * Example ServerApplications may be a Mail Server, File Server, Directory Server etc.
- * Example JesktopApplications may be a Spreadsheet program, browser, mail client
- * Example WebApplications may be a particular website or application within a website
+ * Example ServerApplications may be a Mail Server, File Server, Directory
+ * Server etc. Example JesktopApplications may be a Spreadsheet program,
+ * browser, mail client Example WebApplications may be a particular website or
+ * application within a website
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface Application
{
@@ -107,14 +108,12 @@
/**
* Retrieve names of Blocks contained in application.
- *
- * @return
*/
String[] getBlockNames();
/**
- * Retrieve Block with specified name.
- * If no such block exists a null will be returned.
+ * Retrieve Block with specified name. If no such block exists a null will
+ * be returned.
*
* @param name the name of block to retrieve
* @return the coresponding block or null if none
Index: ApplicationContext.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/ApplicationContext.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- ApplicationContext.java 16 Oct 2003 14:45:47 -0000 1.7
+++ ApplicationContext.java 29 Nov 2003 13:44:29 -0000 1.8
@@ -95,7 +95,7 @@
/**
* Manage the "context" in which Applications operate.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface ApplicationContext
{
@@ -104,15 +104,14 @@
PartitionProfile getPartitionProfile();
/**
- * A application can request that it be be shutdown. In most cases
- * the kernel will schedule the shutdown to occur in another thread.
+ * A application can request that it be be shutdown. In most cases the
+ * kernel will schedule the shutdown to occur in another thread.
*/
void requestShutdown();
/**
- * Export specified object into management system.
- * The object is exported using specifed interface
- * and using the specified name.
+ * Export specified object into management system. The object is exported
+ * using specifed interface and using the specified name.
*
* @param name the name of object to export
* @param object the actual object to export
@@ -136,24 +135,23 @@
ClassLoader getClassLoader();
/**
- * This method grants access to a named ClassLoader. The ClassLoaders
- * for an application are declared in the <tt>environment.xml</tt>
- * descriptor. See the Specification for details.
+ * This method grants access to a named ClassLoader. The ClassLoaders for an
+ * application are declared in the <tt>environment.xml</tt> descriptor. See
+ * the Specification for details.
*/
ClassLoader getClassLoader( String name )
throws Exception;
/**
- * Retrieve a resource from the SAR file. The specified
- * name is relative the root of the archive. So you could
- * use it to retrieve a html page from within sar by loading
- * the resource named "data/main.html" or similar.
+ * Retrieve a resource from the SAR file. The specified name is relative the
+ * root of the archive. So you could use it to retrieve a html page from
+ * within sar by loading the resource named "data/main.html" or similar.
*/
InputStream getResourceAsStream( String name );
/**
- * Get logger with category for application.
- * Note that this name may not be the absolute category.
+ * Get logger with category for application. Note that this name may not be
+ * the absolute category.
*
* @param name the name of logger
* @return the Logger
Index: ClassLoaderManager.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/ClassLoaderManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- ClassLoaderManager.java 5 Oct 2003 03:25:09 -0000 1.4
+++ ClassLoaderManager.java 29 Nov 2003 13:44:29 -0000 1.5
@@ -91,20 +91,20 @@
import org.jcontainer.dna.Configuration;
/**
- * Interface for component that creates and manages the
- * {@link ClassLoader} for an Application. The specific
- * mechanism by which the {@link ClassLoader} is created
- * is dependent on the type of {@link Embeddor} and the
- * deployment format.
+ * Interface for component that creates and manages the {@link ClassLoader} for
+ * an Application. The specific mechanism by which the {@link ClassLoader} is
+ * created is dependent on the type of {@link Embeddor} and the deployment
+ * format.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface ClassLoaderManager
{
/**
* Create a {@link ClassLoaderSet} for a specific application.
*
- * @param environment the configuration "environment.xml" for the application
+ * @param environment the configuration "environment.xml" for the
+ * application
* @param data the context data used when expanding config files
* @param baseDirectory the base directory of application
* @param workDirectory the work directory of application
Index: ClassLoaderSet.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/ClassLoaderSet.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- ClassLoaderSet.java 17 Aug 2003 18:27:33 -0000 1.2
+++ ClassLoaderSet.java 29 Nov 2003 13:44:29 -0000 1.3
@@ -91,7 +91,7 @@
/**
* A dodgy class to hold all apps classloaders.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
* @todo Remove me when kernel is reworked!
*/
Index: ConfigurationInterceptor.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/ConfigurationInterceptor.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- ConfigurationInterceptor.java 5 Oct 2003 03:25:09 -0000 1.2
+++ ConfigurationInterceptor.java 29 Nov 2003 13:44:29 -0000 1.3
@@ -13,7 +13,7 @@
/**
* Repository from which all configuration data is retrieved.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface ConfigurationInterceptor
{
@@ -23,7 +23,6 @@
* @param application Application name
* @param block Block name to store configuration for
* @param configuration information to store.
- *
* @throws ConfigurationException if configuration could not be stored
*/
Configuration processConfiguration( String application,
Index: ContainerConstants.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/ContainerConstants.java,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- ContainerConstants.java 26 Oct 2003 08:23:52 -0000 1.7
+++ ContainerConstants.java 29 Nov 2003 13:44:29 -0000 1.8
@@ -90,95 +90,78 @@
* A set of constants that are used internally in the container to communicate
* about different artefacts. They usually act as keys into maps.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface ContainerConstants
{
/**
- * The name of the software. (Usually Loom but different
- * users may overide this).
+ * The name of the software. (Usually Loom but different users may overide
+ * this).
*/
String SOFTWARE = Version.SOFTWARE;
- /**
- * The version of the software.
- */
+ /** The version of the software. */
String VERSION = Version.VERSION;
- /**
- * The date on which software was built.
- */
+ /** The date on which software was built. */
String DATE = Version.DATE;
/**
- * The name which the assembly is registered into Loom
- * using.
+ * The name which the assembly is registered into Loom using.
*/
String ASSEMBLY_NAME = "loom:assembly-name";
/**
- * The name of the config file which is used
- * to load config data.
+ * The name of the config file which is used to load config data.
*/
String CONFIG_DESCRIPTOR = "loom:config";
/**
- * The name of the config file which is used
- * to load assembly data.
+ * The name of the config file which is used to load assembly data.
*/
String ASSEMBLY_DESCRIPTOR = "loom:assembly";
- /**
- * The default classloader to use to load components.
- */
+ /** The default classloader to use to load components. */
String ASSEMBLY_CLASSLOADER = "loom:classloader";
- /**
- * The root instrumentation category for all applications.
- */
+ /** The root instrumentation category for all applications. */
String ROOT_INSTRUMENT_CATEGORY = "applications";
/**
- * The source of installation (usually a directory in .sar format or a .sar file).
- * Type: {@link java.io.File}
+ * The source of installation (usually a directory in .sar format or a .sar
+ * file). Type: {@link java.io.File}
*/
String INSTALL_SOURCE = "install:source";
/**
- * The Directory in which application is installed.
- * Type: {@link java.io.File}
+ * The Directory in which application is installed. Type: {@link
+ * java.io.File}
*/
String INSTALL_HOME = "install:home";
/**
- * The Directory in which application temporary/work data is stored.
- * Type: {@link java.io.File}
+ * The Directory in which application temporary/work data is stored. Type:
+ * {@link java.io.File}
*/
String INSTALL_WORK = "install:work";
/**
- * The URL to block configuration data.
- * Type: {@link java.lang.String}
+ * The URL to block configuration data. Type: {@link java.lang.String}
*/
String INSTALL_CONFIG = "install:config";
/**
- * The URL to assembly data.
- * Type: {@link java.lang.String}
+ * The URL to assembly data. Type: {@link java.lang.String}
*/
String INSTALL_ASSEMBLY = "install:assembly";
/**
- * The URL to application configuration data.
- * Type: {@link java.lang.String}
+ * The URL to application configuration data. Type: {@link
+ * java.lang.String}
*/
String INSTALL_ENVIRONMENT = "install:environment";
- /**
- * Name of partition containing blocks.
- */
+ /** Name of partition containing blocks. */
String BLOCK_PARTITION = "Loom:BlockPartition";
- /**
- * Name of partition containing listeners.
- */
+ /** Name of partition containing listeners. */
String LISTENER_PARTITION = "Loom:ListenerPartition";
}
Index: Deployer.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/Deployer.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- Deployer.java 26 Oct 2003 08:11:32 -0000 1.5
+++ Deployer.java 29 Nov 2003 13:44:29 -0000 1.6
@@ -91,11 +91,11 @@
/**
* A Deployer is responsible for taking a URL (ie a jar/war/ear) and deploying
* it to a particular "location". "location" means different things for
- * different containers. For a servlet container it may mean the place to
- * mount servlet (ie /myapp --> /myapp/Cocoon.xml is mapping cocoon servlet to
- * /myapp context).
+ * different containers. For a servlet container it may mean the place to mount
+ * servlet (ie /myapp --> /myapp/Cocoon.xml is mapping cocoon servlet to /myapp
+ * context).
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface Deployer
{
Index: Installer.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/Installer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- Installer.java 5 Oct 2003 00:12:37 -0000 1.4
+++ Installer.java 29 Nov 2003 13:44:29 -0000 1.5
@@ -92,7 +92,7 @@
/**
* A basic service to Install an application.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface Installer
{
Index: Kernel.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/Kernel.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- Kernel.java 16 Oct 2003 14:45:47 -0000 1.6
+++ Kernel.java 29 Nov 2003 13:44:29 -0000 1.7
@@ -92,7 +92,7 @@
import org.jcontainer.loom.components.util.profile.PartitionProfile;
/**
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface Kernel
{
@@ -129,12 +129,14 @@
String[] getApplicationNames();
/**
- * Lock the kernel, temporarily preserving the list of applications running in the container
+ * Lock the kernel, temporarily preserving the list of applications running
+ * in the container
*/
void lock();
/**
- * Unlock the kernel, restoring the list of applications to be the current active list
+ * Unlock the kernel, restoring the list of applications to be the current
+ * active list
*/
void unlock();
}
Index: LogManager.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/LogManager.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- LogManager.java 5 Oct 2003 03:25:09 -0000 1.5
+++ LogManager.java 29 Nov 2003 13:44:29 -0000 1.6
@@ -94,7 +94,7 @@
/**
* Interface that is used to manage Log objects for a Sar.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface LogManager
{
Index: LoomException.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/LoomException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- LoomException.java 5 Oct 2003 00:12:37 -0000 1.1
+++ LoomException.java 29 Nov 2003 13:44:29 -0000 1.2
@@ -10,14 +10,12 @@
/**
* Exception to indicate that a problem occured.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public final class LoomException
extends Exception
{
- /**
- * the cause of the exception.
- */
+ /** the cause of the exception. */
private final Throwable m_cause;
/**
Index: SystemManager.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/interfaces/SystemManager.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- SystemManager.java 15 Oct 2003 03:43:09 -0000 1.5
+++ SystemManager.java 29 Nov 2003 13:44:29 -0000 1.6
@@ -87,23 +87,24 @@
package org.jcontainer.loom.interfaces;
/**
- * This component is responsible for managing the system.
- * This includes managing the embeddor, deployer and kernel.
+ * This component is responsible for managing the system. This includes managing
+ * the embeddor, deployer and kernel.
*
* @author <a href="[email protected]">Leo Simons</a>
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
*/
public interface SystemManager
{
/**
- * Register an object for management.
- * The object is exported through some management scheme
- * (typically JMX). Note that the particular management scheme
- * will most likely use reflection to extract manageable information.
+ * Register an object for management. The object is exported through some
+ * management scheme (typically JMX). Note that the particular management
+ * scheme will most likely use reflection to extract manageable
+ * information.
*
* @param name the name to register object under
* @param object the object
- * @throws LoomException if an error occurs such as name already registered.
+ * @throws LoomException if an error occurs such as name already
+ * registered.
* @throws IllegalArgumentException if object is null
*/
void register( String name, Object object )
@@ -113,19 +114,21 @@
* Unregister named object.
*
* @param name the name of object to unregister
- * @throws LoomException if an error occurs such as when no such object registered.
+ * @throws LoomException if an error occurs such as when no such object
+ * registered.
*/
void unregister( String name )
throws LoomException;
/**
- * Returns the subcontext of the specified name. If it does not exist it
- * is created.
+ * Returns the subcontext of the specified name. If it does not exist it is
+ * created.
*
- * @param name name of the object in the parent context that will own this one
+ * @param name name of the object in the parent context that will own this
+ * one
* @param type of objects that will be managed in this context
+ * @return the subcontext with the specified name
* @throws LoomException if context cannot be created or retrieved
- * @return the subcontext with the specified name
*/
SystemManager getSubContext( String name, String type )
throws LoomException;