portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wea...@apache.org
Subject cvs commit: jakarta-jetspeed-2/portal/src/java/org/apache/jetspeed/tools/pamanager/servletcontainer ApplicationServerManager.java
Date Thu, 15 Jul 2004 14:30:11 GMT
weaver      2004/07/15 07:30:11

  Modified:    portal/src/java/org/apache/jetspeed/tools/pamanager/servletcontainer
                        ApplicationServerManager.java
  Log:
  Added javadocs
  
  Revision  Changes    Path
  1.3       +112 -5    jakarta-jetspeed-2/portal/src/java/org/apache/jetspeed/tools/pamanager/servletcontainer/ApplicationServerManager.java
  
  Index: ApplicationServerManager.java
  ===================================================================
  RCS file: /home/cvs/jakarta-jetspeed-2/portal/src/java/org/apache/jetspeed/tools/pamanager/servletcontainer/ApplicationServerManager.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- ApplicationServerManager.java	2 Jul 2004 15:12:54 -0000	1.2
  +++ ApplicationServerManager.java	15 Jul 2004 14:30:11 -0000	1.3
  @@ -21,32 +21,139 @@
   import org.apache.commons.httpclient.HttpException;
   
   /**
  + * 
  + * <p>
  + * ApplicationServerManager
  + * </p>
  + * <p>
  + * Implementations of this interface are used primarily by the
  + * {@link org.apache.jetspeed.tools.pamanager.ApplicationServerPAM}
  + * to interact with the servlet container that is supporting the web
  + * appliaction portion of deployed the portlet applications.
  + * </p>
    * @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
  + * @version $Id$
    *
    */
   public interface ApplicationServerManager
   {
  +    /**
  +     * 
  +     * <p>
  +     * start
  +     * </p>
  +     * Starts the application represented by the context path, <code>appPath</code>
  +     *
  +     * @param appPath path to restart
  +     * @return container-specific status message
  +     * @throws HttpException
  +     * @throws IOException
  +     */
       String start( String appPath ) throws HttpException, IOException;
  -
  +    
  +    /**
  +     * 
  +     * <p>
  +     * stop
  +     * </p>
  +     * Stops the application represented by the context path, <code>appPath</code>
  +     * 
  +     * @param appPath
  +     * @return container-specific status message
  +     * @throws HttpException
  +     * @throws IOException
  +     */
       String stop( String appPath ) throws HttpException, IOException;
  -
  +    
  +    /**
  +     * 
  +     * <p>
  +     * reload
  +     * </p>
  +     * Reloads the application represented by the context path, <code>appPath</code>.
 This
  +     * must included re-reading the web.xml and reloading all classpath resources.
  +     *
  +     * @param appPath
  +     * @return container-specific status message
  +     * @throws HttpException
  +     * @throws IOException
  +     */
       String reload( String appPath ) throws HttpException, IOException;
  -
  +    
  +    /**
  +     * 
  +     * <p>
  +     * remove
  +     * </p>
  +     * Removes the application represented by the context path, <code>appPath</cod
  +     * @param appPath
  +     * @return container-specific status message
  +     * @throws HttpException
  +     * @throws IOException
  +     */
       String remove( String appPath ) throws HttpException, IOException;
  -
  +    
  +    /**
  +     * 
  +     * <p>
  +     * install
  +     * </p>
  +     * Installs the web application represented by the <code>warPath</code>
into the parent servlet
  +     * container using the specified <code>appPath</code> as the context. 
  +     * 
  +     * @param warPath
  +     * @param contexPath
  +     * @return
  +     * @throws HttpException
  +     * @throws IOException
  +     */
       String install( String warPath, String contexPath ) throws HttpException, IOException;
  -
  +    
  +    /**
  +     * 
  +     * <p>
  +     * deploy
  +     * </p>
  +     *
  +     * Deploys the contents of the InputStream, <code>is</code>, into the parent
servlet
  +     * container using the specified <code>appPath</code> as the context path.
  +     * 
  +     * @param appPath
  +     * @param is
  +     * @param size size (in bytes) of InputStream <code>is</code>
  +     * @return
  +     * @throws HttpException
  +     * @throws IOException
  +     */
       String deploy( String appPath, InputStream is, int size ) throws HttpException, IOException;
   
       /**
  +     * 
  +     * <p>
  +     * getHostPort
  +     * </p>
  +     *
        * @return
        */
       int getHostPort();
   
       /**
  +     * 
  +     * <p>
  +     * getHostUrl
  +     * </p>
  +     *
        * @return
        */
       String getHostUrl();
       
  +    /**
  +     * 
  +     * <p>
  +     * isConnected
  +     * </p>
  +     *
  +     * @return
  +     */
       boolean isConnected();
   }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org


Mime
View raw message