001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.serviceapi;
043:
044: import java.beans.PropertyChangeListener;
045: import java.beans.PropertyChangeSupport;
046: import java.util.Collection;
047: import java.util.List;
048: import org.openide.nodes.Node;
049:
050: /**
051: * Represents an implementation unit corresponding of one or multiple
052: * service interfaces, co-locate in a single implementation unit such as a plain
053: * Java class, a BPEL process, an EJB or Servlet.
054: *
055: * @author Nam Nguyen
056: * @author Chris Webster
057: * @author Jiri Kopsa
058: */
059: public abstract class ServiceComponent {
060:
061: public static final String SERVICE_INTERFACE_ADDED_PROPERTY = "serviceInterfaceAdded";
062: public static final String SERVICE_INTERFACE_REMOVED_PROPERTY = "serviceInterfaceRemoved";
063:
064: private PropertyChangeSupport propSupport;
065:
066: /**
067: * Add property change listener.
068: */
069: public void addPropertyChangeListener(
070: PropertyChangeListener listener) {
071: propSupport.addPropertyChangeListener(listener);
072: }
073:
074: /**
075: * Remove property change listener.
076: */
077: public void removePropertyChangeListener(
078: PropertyChangeListener listener) {
079: propSupport.removePropertyChangeListener(listener);
080: }
081:
082: /**
083: * Returns the service interfaces this component provides
084: * the implementation for.
085: */
086: public abstract List<ServiceInterface> getServiceProviders();
087:
088: /**
089: * Returns the service interfaces this component consumes.
090: */
091: public abstract List<ServiceInterface> getServiceConsumers();
092:
093: /**
094: * Returns the service coordination information if applicable.
095: */
096: public abstract Collection<ServiceLink> getServiceLinks();
097:
098: /**
099: * Returns the visualization of the service component. The node should provide
100: * navigation to the component editors and access to its content.
101: * @return visualization node for the service component.
102: */
103: public abstract Node getNode();
104:
105: //CR: where should Categorization and CategorizationProvider come from
106:
107: /**
108: * Ensures this component provide for or consume the given interface.
109: *
110: * @param description the interface to create consumer or provider service for.
111: * @provider whether the service interface to create is provider or consumer.
112: * @return the service interface object.
113: */
114: public abstract ServiceInterface createServiceInterface(
115: InterfaceDescription description, boolean provider);
116:
117: /**
118: * Creates the counter-part service interface of the given service interface.
119: */
120: public abstract ServiceInterface createServiceInterface(
121: ServiceInterface other);
122:
123: /**
124: * Removes service interface from this component. Will also remove
125: * any associated connections from the containing service module container.
126: * Note that the related service interfaces and service links are not removed.
127: */
128: public abstract void removeServiceInterface(
129: ServiceInterface serviceInterface);
130:
131: }
|