dlr 01/06/20 01:36:26
Modified: src/java/org/apache/turbine/services ServiceBroker.java
Log:
JavaDoc changes and additions.
Revision Changes Path
1.9 +42 -14
jakarta-turbine/src/java/org/apache/turbine/services/ServiceBroker.java
Index: ServiceBroker.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine/src/java/org/apache/turbine/services/ServiceBroker.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- ServiceBroker.java 2001/06/14 15:06:09 1.8
+++ ServiceBroker.java 2001/06/20 08:36:24 1.9
@@ -63,31 +63,26 @@
* Classes that implement this interface can act as a broker for
* <code>Service</code> classes.
*
- * Functionality that <code>ServiceBroker</code> provides in addition
- * to <code>InitableBroker</code> functionality includes:
- *
+ * Functionality includes:
* <ul>
- *
* <li>Maintaining service name to class name mapping, allowing
* plugable service implementations.</li>
- *
* <li>Providing <code>Services</code> with <code>Properties</code>
* based on a system wide configuration mechanism.</li>
- *
* </ul>
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Kevin Burton</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Rafal Krzewski</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Daniel Rall</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Jason van Zyl</a>
- * @version $Id: ServiceBroker.java,v 1.8 2001/06/14 15:06:09 jvanzyl Exp $
+ * @version $Id: ServiceBroker.java,v 1.9 2001/06/20 08:36:24 dlr Exp $
*/
public interface ServiceBroker
{
/**
- * Performs early initialization of an Initable class.
+ * Performs early initialization of a <code>Service</code> class.
*
- * If your class depends on another Initable being initialized to
+ * If your class depends on another service being initialized to
* perform early initialization, you should always ask your broker
* to initialize the other class with the objects that are passed
* to you, before you try to retrieve that Initable's instance with
@@ -102,7 +97,7 @@
throws InitializationException;
/**
- * Shutdowns an Initable class.
+ * Shutdowns a <code>Service</code> class.
*
* This method is used to release resources allocated by an
* Initable class, and return it to initial (uninitailized)
@@ -140,7 +135,7 @@
//public void initServices( Object data );
/**
- * Shutdowns a Service.
+ * Shutdowns a service.
*
* This method is used to release resources allocated by a
* Service, and return it to initial (uninitailized) state.
@@ -150,7 +145,7 @@
public void shutdownService( String name );
/**
- * Shutdowns all Services.
+ * Shutdowns all services.
*
* This method is used to release resources allocated by
* Services, and return them to initial (uninitailized) state.
@@ -159,11 +154,11 @@
/**
- * Returns an instance of requested Service.
+ * Returns an instance of the requested <code>Service</code>.
*
* @param name The name of the Service requested.
* @return An instance of requested Service.
- * @exception InstantiationException, if the service is unknown or
+ * @exception InstantiationException If the service is unknown or
* can't be initialized.
*/
public Service getService( String name )
@@ -187,9 +182,42 @@
*/
public Configuration getConfiguration( String name );
+ /**
+ * Sets an application specific service object that can be used by
+ * application specific services.
+ *
+ * @param name The name of the service object.
+ * @param value The value of service object.
+ */
public void setServiceObject(String key, Object value);
+
+ /**
+ * Retrieves an application specific service object.
+ *
+ * @return Object An application specific service object.
+ */
public Object getServiceObject(String name);
+
+ /**
+ * Gets the version of the supplied path as relative to appliation
+ * root. Does not demand strict adherence to the Servlet API's
+ * definition of <code>getRealPath()</code>.
+ *
+ * @return The path, relative to application root.
+ */
public String getRealPath(String path);
+
+ /**
+ * Get the application root as set by the parent application.
+ *
+ * @return String The application root for this broker.
+ */
public String getApplicationRoot();
+
+ /**
+ * Get the log4j <code>Category</code> used for logging.
+ *
+ * @return The logger for this broker.
+ */
public Category getCategory();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
