01: /*
02: * <copyright>
03: *
04: * Copyright 2002-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.servicediscovery.description;
28:
29: import java.net.URL;
30: import java.util.Collection;
31:
32: /**
33: * The ProviderDescription object represents a description of a provider
34: * agent. Each provider should have only one corresponding ProviderDescription.
35: * A ProviderDescription is somewhat analogous to the UDDI concept of a
36: * BusinessEntity. In a cougaar society, it is required that every agent has
37: * a unique name; thus ProviderDescription provider names are also unique.
38: */
39:
40: public interface ProviderDescription {
41:
42: /**
43: * Returns the provider (agent) name.
44: */
45: public String getProviderName();
46:
47: public String getOrganizationType();
48:
49: public Collection getBusinessCategories();
50:
51: /**
52: * Returns the ServiceProfiles for this provider;
53: * will be empty if this provider does not describe any
54: * services. The Collection contains ServiceProfiles.
55: */
56: public Collection getServiceProfiles();
57:
58: /**
59: * Writes the OWL files that describe this provider. The
60: * outputFileBase may be an entire directory and base, such
61: * as "C:/cougaar/servicedisovery/data/agentXYZ" or just a base
62: * such as "agentXYZ". If outputFileBase is the empty string,
63: * the provider name will be used as a default base. Right
64: * now the only file that will be written is outputFileBase.profile.owl,
65: * but later grounding file(s) will aslo be written.
66: */
67: public void writeOWLFiles(String outputFileBase);
68:
69: /**
70: * Returns a URI that can be used to get the ProviderDescription.
71: * Typically the URI might be something like "cougaar://125-FSB"
72: */
73: public String getProviderDescriptionURI();
74:
75: /**
76: * Would be some other methods for accessing additional characteristics
77: * of the provider, such as their location and contact information.
78: */
79:
80: public boolean parseOWL(String fileName);
81:
82: public boolean parseOWL(URL serviceProfileURL, String fileName);
83: }
|