org.fabric3.spi.model.instance.LogicalComponent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation
Show all versions of fabric3-spi Show documentation
SPIs for runtime extensions
/*
* Fabric3
* Copyright (c) 2009-2011 Metaform Systems
*
* Fabric3 is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as
* published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version, with the
* following exception:
*
* Linking this software statically or dynamically with other
* modules is making a combined work based on this software.
* Thus, the terms and conditions of the GNU General Public
* License cover the whole combination.
*
* As a special exception, the copyright holders of this software
* give you permission to link this software with independent
* modules to produce an executable, regardless of the license
* terms of these independent modules, and to copy and distribute
* the resulting executable under terms of your choice, provided
* that you also meet, for each linked independent module, the
* terms and conditions of the license of that module. An
* independent module is a module which is not derived from or
* based on this software. If you modify this software, you may
* extend this exception to your version of the software, but
* you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version.
*
* Fabric3 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
* You should have received a copy of the
* GNU General Public License along with Fabric3.
* If not, see {
private static final long serialVersionUID = -3520150701040845117L;
public static final String LOCAL_ZONE = "LocalZone";
private URI uri;
private ComponentDefinition definition;
private Map properties = new HashMap();
private Map services = new HashMap();
private Map references = new HashMap();
private Map producers = new HashMap();
private Map consumers = new HashMap();
private Map> resourceReferences = new HashMap>();
private String zone = LOCAL_ZONE;
private QName deployable;
private Autowire autowire;
private LogicalState state = LogicalState.NEW;
/**
* @param uri URI of the component.
* @param definition Definition of the component.
* @param parent Parent of the component.
*/
public LogicalComponent(URI uri, ComponentDefinition definition, LogicalCompositeComponent parent) {
super(parent);
this.uri = uri;
this.definition = definition;
if (definition != null) {
// null check for testing so full model does not need to be instantiated
addIntents(definition.getIntents());
addPolicySets(definition.getPolicySets());
}
}
/**
* Returns the component uri.
*
* @return the uri
*/
public URI getUri() {
return uri;
}
/**
* Returns the zone name where the component is provisioned.
*
* @return the zone name where the component is provisioned
*/
public String getZone() {
return zone;
}
/**
* Sets the zone name where the component is provisioned.
*
* @param zone the zone name where the component is provisioned
*/
public void setZone(String zone) {
this.zone = zone;
}
/**
* Returns the deployable composite name this logical component was instantiated from.
*
* @return the deployable name
*/
public QName getDeployable() {
return deployable;
}
/**
* Sets the name of the deployable composite this component was instantiated from.
*
* @param deployable the deployable name
*/
public void setDeployable(QName deployable) {
this.deployable = deployable;
}
/**
* Returns the autowire value based on the component autowire inheritence hierarchy.
*
* @return the autowire value
*/
public Autowire getAutowire() {
return autowire;
}
/**
* Sets the autowire value based on the component autowire inheritence hierarchy.
*
* @param autowire the autowire value
*/
public void setAutowire(Autowire autowire) {
this.autowire = autowire;
}
/**
* Returns the services offered by the current component.
*
* @return the services offered by the current component
*/
public Collection getServices() {
return services.values();
}
/**
* Returns a service with the given URI.
*
* @param name the service name
* @return the service.
*/
public LogicalService getService(String name) {
return services.get(name);
}
/**
* Adds a the resolved service
*
* @param service the service to add
*/
public void addService(LogicalService service) {
services.put(service.getUri().getFragment(), service);
}
/**
* Returns the resource references required by the current component.
*
* @return the resources references required by the current component
*/
public Collection> getResourceReferences() {
return resourceReferences.values();
}
/**
* Returns a resource reference with the given URI.
*
* @param name the resource name
* @return the resource.
*/
public LogicalResourceReference getResourceReference(String name) {
return resourceReferences.get(name);
}
/**
* Adds a the resolved resource
*
* @param resourceReference the resource to add
*/
public void addResource(LogicalResourceReference resourceReference) {
resourceReferences.put(resourceReference.getUri().getFragment(), resourceReference);
}
/**
* Returns the resolved component references.
*
* @return the component references
*/
public Collection getReferences() {
return references.values();
}
/**
* Returns a the resolved reference with the given URI.
*
* @param name the reference name
* @return the reference.
*/
public LogicalReference getReference(String name) {
return references.get(name);
}
/**
* Adds a resolved reference
*
* @param reference the reference to add
*/
public void addReference(LogicalReference reference) {
references.put(reference.getUri().getFragment(), reference);
}
/**
* Returns the component producers.
*
* @return the producers
*/
public Collection getProducers() {
return producers.values();
}
/**
* Returns a producer with the given URI.
*
* @param name the producer name
* @return the producer.
*/
public LogicalProducer getProducer(String name) {
return producers.get(name);
}
/**
* Adds a producer.
*
* @param producer the producer to add
*/
public void addProducer(LogicalProducer producer) {
producers.put(producer.getUri().getFragment(), producer);
}
/**
* Returns the component consumer.
*
* @return the producers
*/
public Collection getConsumers() {
return consumers.values();
}
/**
* Returns a consumer with the given URI.
*
* @param name the producer name
* @return the producer.
*/
public LogicalConsumer getConsumer(String name) {
return consumers.get(name);
}
/**
* Adds a the consumer.
*
* @param consumer the consumer to add
*/
public void addConsumer(LogicalConsumer consumer) {
consumers.put(consumer.getUri().getFragment(), consumer);
}
/**
* Returns the resolved properties for the component.
*
* @return the resolved properties for the component
*/
public Map getAllProperties() {
return properties;
}
/**
* Gets a property.
*
* @param name the name of the property.
* @return the property or null if not found
*/
public LogicalProperty getProperties(String name) {
return properties.get(name);
}
/**
* Sets a collection of resolved property values
*
* @param property the parsed property
*/
public void setProperties(LogicalProperty property) {
properties.put(property.getName(), property);
}
/**
* Returns the component implementation type.
*
* @return the component implementation type
*/
public ComponentDefinition getDefinition() {
return definition;
}
/**
* Returns the instance state.
*
* @return the instance state
*/
public LogicalState getState() {
return state;
}
/**
* Sets the instance state.
*
* @param state the instance state
*/
public void setState(LogicalState state) {
this.state = state;
}
}