001: /*
002: * <copyright>
003: *
004: * Copyright 2003-2004 BBNT Solutions, LLC
005: * under sponsorship of the Defense Advanced Research Projects
006: * Agency (DARPA).
007: *
008: * You can redistribute this software and/or modify it under the
009: * terms of the Cougaar Open Source License as published on the
010: * Cougaar Open Source Website (www.cougaar.org).
011: *
012: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
013: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
014: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
015: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
016: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
017: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
018: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
019: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
020: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
021: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
022: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
023: *
024: * </copyright>
025: */
026:
027: package org.cougaar.core.service;
028:
029: import org.cougaar.core.component.Service;
030:
031: import java.io.File;
032: import java.io.FileNotFoundException;
033: import java.io.IOException;
034: import java.io.InputStream;
035: import java.io.InputStreamReader;
036: import java.net.MalformedURLException;
037: import java.net.URL;
038: import java.util.Iterator;
039: import java.util.List;
040:
041: import org.w3c.dom.Document;
042:
043: /**
044: * This service provides access to the file system by searching
045: * the configuration path.
046: * <p>
047: * The standard implementation is backed by the {@link
048: * org.cougaar.util.ConfigFinder}. See the {@link
049: * org.cougaar.util.ConfigFinder} javadoc for the default
050: * configuration path and configurable system properties.
051: */
052: public interface ConfigurationService extends Service {
053: /** the (immutable) set of configuration URLs used by this Service */
054: List getConfigurationPath();
055:
056: /**
057: * Locate an actual file in the config path. This will skip over
058: * elements of org.cougaar.config.path that are not file: urls.
059: */
060: File locateFile(String filename);
061:
062: /**
063: * Resolve a logical reference to a URL.
064: * @return null if unresolvable.
065: */
066: URL resolveName(String logicalName) throws MalformedURLException;
067:
068: /**
069: * Opens an InputStream to access the named file. The file is sought
070: * in all the places specified in configPath.
071: * @throws IOException if the resource cannot be found.
072: */
073: InputStream open(String aURL) throws IOException;
074:
075: /**
076: * Attempt to find the URL which would be opened by the open method.
077: * Note that this must actually attempt to open the various URLs
078: * under consideration, so this is <em>not</em> an inexpensive operation.
079: */
080: URL find(String aURL) throws IOException;
081:
082: /** Read and parse an XML file somewhere in the configpath */
083: Document parseXMLConfigFile(String xmlfile) throws IOException;
084:
085: /** Delegate class for easing implementation of Binders, etc */
086: class Delegate implements ConfigurationService {
087: private final ConfigurationService _delegate;
088:
089: protected final ConfigurationService getDelegate() {
090: return _delegate;
091: }
092:
093: public Delegate(ConfigurationService cs) {
094: _delegate = cs;
095: }
096:
097: public List getConfigurationPath() {
098: return _delegate.getConfigurationPath();
099: }
100:
101: public File locateFile(String filename) {
102: return _delegate.locateFile(filename);
103: }
104:
105: public URL resolveName(String name)
106: throws MalformedURLException {
107: return _delegate.resolveName(name);
108: }
109:
110: public InputStream open(String u) throws IOException {
111: return _delegate.open(u);
112: }
113:
114: public URL find(String u) throws IOException {
115: return _delegate.find(u);
116: }
117:
118: public Document parseXMLConfigFile(String f) throws IOException {
119: return _delegate.parseXMLConfigFile(f);
120: }
121: }
122: }
|