001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.deployment.scanner;
023:
024: import java.net.MalformedURLException;
025: import java.net.URL;
026: import java.util.List;
027:
028: import org.jboss.net.protocol.URLLister.URLFilter;
029:
030: /**
031: * URLDeploymentScanner MBean interface.
032: *
033: * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
034: * @author <a href="mailto:dimitris@jboss.org">Dimitris Andreadis</a>
035: * @version $Revision: 57205 $
036: */
037: public interface URLDeploymentScannerMBean extends
038: DeploymentScannerMBean {
039: // Attributes ----------------------------------------------------
040:
041: void setRecursiveSearch(boolean recurse);
042:
043: boolean getRecursiveSearch();
044:
045: void setURLList(List list);
046:
047: List getURLList();
048:
049: void setURLComparator(String classname)
050: throws ClassNotFoundException, IllegalAccessException,
051: InstantiationException;
052:
053: String getURLComparator();
054:
055: void setFilter(String classname) throws ClassNotFoundException,
056: IllegalAccessException, InstantiationException;
057:
058: String getFilter();
059:
060: void setFilterInstance(URLFilter filter);
061:
062: URLFilter getFilterInstance();
063:
064: void setURLs(String listspec) throws MalformedURLException;
065:
066: // Operations ----------------------------------------------------
067:
068: void addURL(URL url);
069:
070: void removeURL(URL url);
071:
072: boolean hasURL(URL url);
073:
074: void addURL(String urlspec) throws MalformedURLException;
075:
076: void removeURL(String urlspec) throws MalformedURLException;
077:
078: boolean hasURL(String urlspec) throws MalformedURLException;
079:
080: /**
081: * Temporarily ignore changes (addition, updates, removal) to a particular
082: * deployment, identified by its deployment URL. The deployment URL is different
083: * from the 'base' URLs that are scanned by the scanner (e.g. the full path to
084: * deploy/jmx-console.war vs. deploy/). This can be used to avoid an attempt
085: * by the scanner to deploy/redeploy/undeploy a URL that is being modified.
086: *
087: * To re-enable scanning of changes for a URL, use resumeDeployment(URL, boolean).
088: */
089: void suspendDeployment(URL url);
090:
091: /**
092: * Re-enables scanning of a particular deployment URL, previously suspended
093: * using suspendDeployment(URL). If the markUpToDate flag is true then the
094: * deployment module will be considered up-to-date during the next scan.
095: * If the flag is false, at the next scan the scanner will check the
096: * modification date to decide if the module needs deploy/redeploy/undeploy.
097: */
098: void resumeDeployment(URL url, boolean markUpToDate);
099:
100: /**
101: * Lists all urls deployed by the scanner, each URL on a new line.
102: */
103: public String listDeployedURLs();
104:
105: }
|