Author: fmeschbe Date: Mon Jan 19 06:55:42 2009 New Revision: 735718 URL: http://svn.apache.org/viewvc?rev=735718&view=rev Log: Rename delegate classes to indicate their use in their name Add JavaDoc
Added: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/ (props changed) - copied from r734992, incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/main/ incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java (contents, props changed) - copied, changed from r734992, incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/main/SlingMain.java incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java (contents, props changed) - copied, changed from r734992, incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServlet.java Removed: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/SlingMain.java incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/main/ Modified: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/shared/SharedConstants.java Propchange: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/ ------------------------------------------------------------------------------ svn:mergeinfo = Copied: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java (from r734992, incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/main/SlingMain.java) URL: http://svn.apache.org/viewvc/incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java?p2=incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java&p1=incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/main/SlingMain.java&r1=734992&r2=735718&rev=735718&view=diff ============================================================================== --- incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/main/SlingMain.java (original) +++ incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java Mon Jan 19 06:55:42 2009 @@ -14,7 +14,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -package org.apache.sling.launchpad.base.main; +package org.apache.sling.launchpad.base.app; import static org.apache.felix.framework.util.FelixConstants.LOG_LEVEL_PROP; @@ -66,7 +66,7 @@ * </dd> * </dl> */ -public class SlingMain implements Launcher { +public class MainDelegate implements Launcher { /** Mapping between log level numbers and names */ private static final String[] logLevels = { "FATAL", "ERROR", "WARN", @@ -151,7 +151,7 @@ try { ResourceProvider resProvider = new ClassLoaderResourceProvider( - SlingMain.class.getClassLoader()); + MainDelegate.class.getClassLoader()); // creating the instance launches the framework and we are done here // .. @@ -295,7 +295,7 @@ } log("usage: " - + SlingMain.class.getName() + + MainDelegate.class.getName() + " [ -l loglevel ] [ -f logfile ] [ -c slinghome ] [ -a address ] [ -p port ] [ -h ]"); log(" -l loglevel the initial loglevel (0..4, FATAL, ERROR, WARN, INFO, DEBUG)"); Propchange: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java ------------------------------------------------------------------------------ svn:keywords = Author Date Id Revision Rev Url Propchange: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/app/MainDelegate.java ------------------------------------------------------------------------------ svn:mergeinfo = Modified: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/shared/SharedConstants.java URL: http://svn.apache.org/viewvc/incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/shared/SharedConstants.java?rev=735718&r1=735717&r2=735718&view=diff ============================================================================== --- incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/shared/SharedConstants.java (original) +++ incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/shared/SharedConstants.java Mon Jan 19 06:55:42 2009 @@ -34,16 +34,38 @@ /** * Default {...@link #SLING_HOME sling.home} value if no other value can be - * resolvled. + * resolvled (value is "sling"). */ public static final String SLING_HOME_DEFAULT = "sling"; - public static final String LAUNCHER_JAR_REL_PATH = "org.apache.sling.launchpad.base.jar"; + /** + * The fully qualified name of the class used by the Standalone Java + * Application main class to control the framework. This class implements + * the {...@link Launcher} interface. + */ + public static final String DEFAULT_SLING_MAIN = "org.apache.sling.launchpad.base.app.MainDelegate"; - public static final String DEFAULT_SLING_MAIN = "org.apache.sling.launchpad.base.main.SlingMain"; + /** + * The fully qualified name of the class used by the Sling Web Applicaiton + * servlet to control the framework. This class implements the + * <code>javax.servlet.Servlet</code> and {...@link Launcher} (for setup only) + * interfaces. + */ + public static final String DEFAULT_SLING_SERVLET = "org.apache.sling.launchpad.base.webapp.SlingServletDelegate"; - public static final String DEFAULT_SLING_SERVLET = "org.apache.sling.launchpad.base.webapp.SlingServlet"; + /** + * The name of the file providing the Launcher JAR. On the one hand this is + * the name used to place the JAR file sling.home to use for startup. On the + * other hand, this is the name of the file in the archive (see + * {...@link #DEFAULT_SLING_LAUNCHER_JAR}). + */ + public static final String LAUNCHER_JAR_REL_PATH = "org.apache.sling.launchpad.base.jar"; - public static final String DEFAULT_SLING_LAUNCHER_JAR = "/resources/" + LAUNCHER_JAR_REL_PATH; + /** + * The absolute path to the launcher JAR file in the archive to copy to the + * sling.home directory. + */ + public static final String DEFAULT_SLING_LAUNCHER_JAR = "/resources/" + + LAUNCHER_JAR_REL_PATH; } Copied: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java (from r734992, incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServlet.java) URL: http://svn.apache.org/viewvc/incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java?p2=incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java&p1=incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServlet.java&r1=734992&r2=735718&rev=735718&view=diff ============================================================================== --- incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServlet.java (original) +++ incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java Mon Jan 19 06:55:42 2009 @@ -48,7 +48,7 @@ import org.osgi.framework.ServiceReference; /** - * The <code>SlingServlet</code> serves as a basic servlet for Project Sling. + * The <code>SlingServletDelegate</code> serves as a basic servlet for Project Sling. * The tasks of this servlet are as follows: * <ul> * <li>The {...@link #init()} method launches Apache <code>Felix</code> as the @@ -76,7 +76,7 @@ * to be specified for startup. This servlet builds the list of parameters from * three locations: * <ol> - * <li>The <code>com/day/osgi/servlet/SlingServlet.properties</code> is read + * <li>The <code>com/day/osgi/servlet/SlingServletDelegate.properties</code> is read * from the servlet class path. This properties file contains default settings.</li> * <li>Extensions of this servlet may provide additional properties to be * loaded overwriting the {...@link #loadConfigProperties()} method. @@ -104,7 +104,7 @@ * and Log4J logging. It is recommended that this bundle is used to setup and * configure logging for systems based on this servlet. */ -public class SlingServlet extends GenericServlet implements Launcher { +public class SlingServletDelegate extends GenericServlet implements Launcher { /** Pseduo class version ID to keep the IDE quite. */ private static final long serialVersionUID = 1L; @@ -127,7 +127,7 @@ /** * Flag set by the {...@link #destroy()} method to indicate the servlet has * been destroyed. This flag is used by the {...@link #startSling(String)} - * method to check whether the SlingServlet has been destroyed while Sling + * method to check whether the SlingServletDelegate has been destroyed while Sling * was starting up. */ private boolean servletDestroyed = false; @@ -204,13 +204,13 @@ tmpDelegatee = new HttpServiceServlet(); tmpDelegatee.init(getServletConfig()); - // set the fields only if the SlingServlet has no been destroyed + // set the fields only if the SlingServletDelegate has no been destroyed // while Sling has been starting up. Otherwise we do not set the // fields and leave the temporary variables assigned to have // them destroyed in the finally clause. if (servletDestroyed) { - log("SlingServlet destroyed while starting Sling, shutting Sling down"); + log("SlingServletDelegate destroyed while starting Sling, shutting Sling down"); } else { @@ -459,7 +459,7 @@ private ServletContext servletContext; private ServletContextResourceProvider(ServletContext servletContext) { - super(SlingServlet.class.getClassLoader()); + super(SlingServletDelegate.class.getClassLoader()); this.servletContext = servletContext; } Propchange: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java ------------------------------------------------------------------------------ svn:keywords = Author Date Id Revision Rev Url Propchange: incubator/sling/whiteboard/fmeschbe/launchpad/base/src/main/java/org/apache/sling/launchpad/base/webapp/SlingServletDelegate.java ------------------------------------------------------------------------------ svn:mergeinfo =