mcconnell 2003/09/07 04:34:15
Modified: merlin/kernel/bootstrap/src/java Merlin.java
merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl
CLIKernelLoader.java DefaultKernel.java
DefaultKernelContext.java DefaultKernelMBean.java
JRMPKernelAdaptor.java Resources.properties
package.html
merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel
Controller.java Kernel.java KernelContext.java
KernelException.java KernelRuntimeException.java
package.html
Log:
Javadoc updates.
Revision Changes Path
1.9 +3 -0 avalon-sandbox/merlin/kernel/bootstrap/src/java/Merlin.java
Index: Merlin.java
===================================================================
RCS file: /home/cvs/avalon-sandbox/merlin/kernel/bootstrap/src/java/Merlin.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- Merlin.java 5 Sep 2003 09:59:26 -0000 1.8
+++ Merlin.java 7 Sep 2003 11:34:14 -0000 1.9
@@ -107,6 +107,9 @@
* to bootstrap a kernel into existance. The implementation passes
* all command line parameters to the CLIKernelLoader class for
* processing and kernel establishment.
+ *
+ * @param args the command-line arguments
+ * @exception Exception is an error occurs
*/
public static void main( String[] args ) throws Exception
{
1.14 +11 -1
avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/CLIKernelLoader.java
Index: CLIKernelLoader.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/CLIKernelLoader.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- CLIKernelLoader.java 5 Sep 2003 09:59:26 -0000 1.13
+++ CLIKernelLoader.java 7 Sep 2003 11:34:14 -0000 1.14
@@ -40,7 +40,7 @@
import org.xml.sax.SAXException;
/**
- * The CLIKernelLoader loads a Merlin kernel based on a set of
+ * The CLIKernelLoader loads a Merlin Kernel based on a set of
* command line arguments.
*/
public class CLIKernelLoader
@@ -66,6 +66,16 @@
// constructor
//--------------------------------------------------------------------------
+ /**
+ * Creation of a new kernel loader. The supplied repository is
+ * used as the default deployment repository. Depending on command
+ * line arguments, the repository established for runtime deployment
+ * may be changed.
+ *
+ * @param repository the bootstrap repository from which merlin
+ * system jar files have been resolved
+ * @param args the set of command line arguments
+ */
public CLIKernelLoader( final Repository repository, String[] args )
throws Exception
{
1.12 +22 -5
avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/DefaultKernel.java
Index: DefaultKernel.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/DefaultKernel.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- DefaultKernel.java 5 Sep 2003 09:59:26 -0000 1.11
+++ DefaultKernel.java 7 Sep 2003 11:34:14 -0000 1.12
@@ -92,6 +92,7 @@
import org.apache.excalibur.mpool.PoolManager;
/**
+ * Implementation of the default Merlin Kernel.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
* @version $Revision$ $Date$
@@ -138,6 +139,11 @@
// constructor
//--------------------------------------------------------------
+ /**
+ * Creation of a new Merlin Kernel.
+ * @param context the kernel context
+ * @exception KKernelException if a kernel creation error occurs
+ */
public DefaultKernel( final KernelContext context )
throws KernelException
{
@@ -300,7 +306,11 @@
*/
public String getRepositoryDirectoryPath()
{
- return m_context.getRepositoryPath().toString();
+ if( m_context.getRepositoryPath() != null )
+ {
+ return m_context.getRepositoryPath().toString();
+ }
+ return "";
}
/**
@@ -318,7 +328,11 @@
*/
public String getTempDirectoryPath()
{
- return m_context.getTempPath().toString();
+ if( m_context.getTempPath() != null )
+ {
+ return m_context.getTempPath().toString();
+ }
+ return "";
}
/**
@@ -575,8 +589,11 @@
//--------------------------------------------------------------
/**
- * Set the state of the kernel.
- * @param a string representing the kernel state
+ * Set the state of the kernel. The method also triggers the
+ * emmission of a attribute change notification containing the
+ * old and new state value.
+ *
+ * @param state a string representing the new kernel state
*/
private void setState( String state )
{
1.23 +3 -1
avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/DefaultKernelContext.java
Index: DefaultKernelContext.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/DefaultKernelContext.java,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- DefaultKernelContext.java 5 Sep 2003 09:59:26 -0000 1.22
+++ DefaultKernelContext.java 7 Sep 2003 11:34:14 -0000 1.23
@@ -224,6 +224,8 @@
* @param config a url to a configuration override descriptor
* @param server server mode flag
* @param debug debug flag
+ * @exception NullPointerException if the supplied bootstrap repository is null
+ * @exception KernelException if an error occurs during context creation
*/
public DefaultKernelContext(
Repository repository, File system, File library, File home,
1.2 +2 -1
avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/DefaultKernelMBean.java
Index: DefaultKernelMBean.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/DefaultKernelMBean.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DefaultKernelMBean.java 5 Sep 2003 09:59:27 -0000 1.1
+++ DefaultKernelMBean.java 7 Sep 2003 11:34:14 -0000 1.2
@@ -54,6 +54,7 @@
/**
+ * Management interface for the Merlin Kernel.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
* @version $Revision$ $Date$
1.2 +20 -1
avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/JRMPKernelAdaptor.java
Index: JRMPKernelAdaptor.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/JRMPKernelAdaptor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- JRMPKernelAdaptor.java 5 Sep 2003 09:59:27 -0000 1.1
+++ JRMPKernelAdaptor.java 7 Sep 2003 11:34:14 -0000 1.2
@@ -64,7 +64,7 @@
import org.apache.avalon.framework.logger.Logger;
/**
- * RMIAdaptor for the JMX Server.
+ * RMIAdaptor for the JMX Server established by the merlin kernel.
*
*/
public class JRMPKernelAdaptor extends AbstractLogEnabled implements Startable
@@ -85,12 +85,23 @@
// constructors
//--------------------------------------------------------------
+ /**
+ * Creation of a new adapter.
+ * @param logging the assigned logging channel
+ * @param server the mbean server
+ */
public JRMPKernelAdaptor( Logger logger, MBeanServer server )
throws Exception
{
this( logger, server, 1099 );
}
+ /**
+ * Creation of a new adapter.
+ * @param logging the assigned logging channel
+ * @param server the mbean server
+ * @param port the port on which the adapter is conected
+ */
public JRMPKernelAdaptor( Logger logger, MBeanServer server, int port )
throws Exception
{
@@ -119,6 +130,10 @@
m_server.registerMBean( m_adapter, m_name );
}
+ /**
+ * Start the adapter.
+ * @exception Exception is an adapter startup error occurs
+ */
public void start() throws Exception
{
//
@@ -138,6 +153,10 @@
m_adapter.start();
}
+ /**
+ * Stop the adapter.
+ * @exception Exception is an adapter shutdown error occurs
+ */
public void stop() throws Exception
{
getLogger().debug( "stopping jrmp adapter" );
1.7 +1 -1
avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/Resources.properties
Index: Resources.properties
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/Resources.properties,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- Resources.properties 5 Sep 2003 09:59:27 -0000 1.6
+++ Resources.properties 7 Sep 2003 11:34:14 -0000 1.7
@@ -9,7 +9,7 @@
cli-execute-description=If present the kernel will initiate shutdown immediately
following deployment.
-cli-version-description=Prints version information.
+cli-version-description=Print version information and return.
cli-info-description=Lists info about the deployment context.
1.3 +2 -2
avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/impl/src/java/org/apache/avalon/merlin/kernel/impl/package.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- package.html 17 Aug 2003 06:35:52 -0000 1.2
+++ package.html 7 Sep 2003 11:34:14 -0000 1.3
@@ -1,8 +1,8 @@
<body>
<p>
-The kernel package defines a top level Kernel that serves as a host to a set
-of Blocks. The default kernel implementation handles the setup of supporting
+The kernel package defines a top level Kernel implementation that serves as a host
to a set
+of blocks. The default kernel implementation handles the setup of supporting
infrastructure and deployment of declared blocks.
</p>
<p>
1.2 +3 -5
avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/Controller.java
Index: Controller.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/Controller.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Controller.java 5 Sep 2003 09:59:27 -0000 1.1
+++ Controller.java 7 Sep 2003 11:34:15 -0000 1.2
@@ -55,10 +55,8 @@
import org.apache.avalon.activation.appliance.Home;
/**
- * A service that provides support for the establishment and management of a set
- * of component container.
- * <p><b>UML</b></p>
- * <p><image src="doc-files/kernel.gif" border="0"/></p>
+ * The Controller interface defines a subset of management operations exposed by
+ * a kernel implementation.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
* @version $Revision$ $Date$
1.4 +4 -5
avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/Kernel.java
Index: Kernel.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/Kernel.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Kernel.java 5 Sep 2003 09:59:27 -0000 1.3
+++ Kernel.java 7 Sep 2003 11:34:15 -0000 1.4
@@ -55,10 +55,9 @@
import org.apache.avalon.activation.appliance.Home;
/**
- * A service that provides support for the establishment and management of a set
- * of component container.
- * <p><b>UML</b></p>
- * <p><image src="doc-files/kernel.gif" border="0"/></p>
+ * A Kernel is the root of a containment solution. This interfaces
+ * defines the contract for any kernel implementation, core covering
+ * management aspects and service resolutiuon aspects.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
* @version $Revision$ $Date$
1.6 +2 -2
avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/KernelContext.java
Index: KernelContext.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/KernelContext.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- KernelContext.java 5 Sep 2003 09:59:27 -0000 1.5
+++ KernelContext.java 7 Sep 2003 11:34:15 -0000 1.6
@@ -15,8 +15,8 @@
import org.apache.excalibur.mpool.PoolManager;
/**
- * The KernelContext declares the primary information needed to establish
- * a kernel instance.
+ * The KernelContext declares the information needed to establish
+ * a new kernel instance.
*/
public interface KernelContext
{
1.2 +2 -2
avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/KernelException.java
Index: KernelException.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/KernelException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- KernelException.java 11 Aug 2003 22:34:51 -0000 1.1
+++ KernelException.java 7 Sep 2003 11:34:15 -0000 1.2
@@ -53,7 +53,7 @@
import org.apache.avalon.framework.CascadingException;
/**
- * Exception to indicate that there was a kernel related error.
+ * Exception to indicate that there was an error relating to kernel execution.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
* @version $Revision$ $Date$
1.2 +2 -2
avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/KernelRuntimeException.java
Index: KernelRuntimeException.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/KernelRuntimeException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- KernelRuntimeException.java 11 Aug 2003 22:34:56 -0000 1.1
+++ KernelRuntimeException.java 7 Sep 2003 11:34:15 -0000 1.2
@@ -53,7 +53,7 @@
import org.apache.avalon.framework.CascadingRuntimeException;
/**
- * Exception to indicate that there was a kernel related runtime error.
+ * Exception to indicate that there was a runtime error related to the kernel.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Avalon Development Team</a>
* @version $Revision$ $Date$
1.2 +1 -1
avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/package.html
Index: package.html
===================================================================
RCS file:
/home/cvs/avalon-sandbox/merlin/kernel/spi/src/java/org/apache/avalon/merlin/kernel/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 11 Aug 2003 22:34:56 -0000 1.1
+++ package.html 7 Sep 2003 11:34:15 -0000 1.2
@@ -1,7 +1,7 @@
<body>
<p>
-The kernel package defines a top level Kernel interfaces.
+The kernel package defines a top-level Kernel interfaces.
</p>
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
