User: user57
Date: 01/12/09 17:51:26
Modified: src/main/org/jboss/deployment DeployerMBean.java
Log:
o added javadocs
Revision Changes Path
1.6 +38 -14 jboss/src/main/org/jboss/deployment/DeployerMBean.java
Index: DeployerMBean.java
===================================================================
RCS file: /cvsroot/jboss/jboss/src/main/org/jboss/deployment/DeployerMBean.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- DeployerMBean.java 2001/08/29 22:53:00 1.5
+++ DeployerMBean.java 2001/12/10 01:51:26 1.6
@@ -4,6 +4,7 @@
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
+
package org.jboss.deployment;
import java.io.IOException;
@@ -13,36 +14,59 @@
import org.jboss.system.ServiceMBean;
/**
- * The common interface for services that deploy application
- * components.
+ * The common interface for services that deploy application
+ * components.
*
- * @author <a href="mailto:[EMAIL PROTECTED]";>Toby Allsopp</a>
- * @version $Revision: 1.5 $
+ * @author <a href="mailto:[EMAIL PROTECTED]";>Toby Allsopp</a>
+ * @version $Revision: 1.6 $
*/
public interface DeployerMBean
extends ServiceMBean
{
- // Constants -----------------------------------------------------
-
- // Public --------------------------------------------------------
-
/**
* Provides a filter that decides whether a file can be deployed by
* this deployer based on the filename. This is for the benefit of
* the {@link org.jboss.deployer.AutoDeployer} service.
*
- * @return a <code>FilenameFilter</code> that only
- * <code>accept</code>s files with names that can be
+ * @return a <tt>FilenameFilter</tt> that only
+ * <tt>accept</tt>s files with names that can be
* deployed by this deployer
*/
FilenameFilter getDeployableFilter();
-
- void deploy (String url)
+
+ /**
+ * Deploy a given URL.
+ *
+ * @param url The URL to deploy.
+ *
+ * @throws MalformedURLException Invalid URL
+ * @throws IOException Failed to fetch content
+ * @throws DeploymentException Failed to deploy
+ */
+ void deploy(String url)
throws MalformedURLException, IOException, DeploymentException;
- void undeploy (String url)
+ /**
+ * Undeploy a given URL.
+ *
+ * @param url The URL to undeploy.
+ *
+ * @throws MalformedURLException Invalid URL
+ * @throws IOException Failed to fetch content
+ * @throws DeploymentException Failed to undeploy
+ */
+ void undeploy(String url)
throws MalformedURLException, IOException, DeploymentException;
- boolean isDeployed (String url)
+ /**
+ * Check if a URL corresponds to a deployment.
+ *
+ * @param url The URL to check.
+ * @return True if the URL corresponds to a deployment.
+ *
+ * @throws MalformedURLException Invalid URL
+ * @throws DeploymentException Failed to undeploy
+ */
+ boolean isDeployed(String url)
throws MalformedURLException, DeploymentException;
}
_______________________________________________
Jboss-development mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/jboss-development
