org.fabric3.spi.model.instance.LogicalWire 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 target attribute of a
* reference element or using the wire element. Furthermore, a wire may be unbound or explicitly configured with a binding.
* If the wire is unbound and crosses process boundaries, it will be bound by the runtime using the SCA binding.
*
* During deployment, wires are created and resolved incrementally. A wire is created for When a wire is instantiated, its source reference and target
* service URI are resolved against the domain.
*
* @version $Rev: 9763 $ $Date: 2011-01-03 00:48:06 +0000 (Mon, 03 Jan 2011) $
*/
public class LogicalWire extends LogicalScaArtifact> {
private static final long serialVersionUID = -643283191171197255L;
private LogicalReference source;
private LogicalService target;
private LogicalBinding sourceBinding;
private LogicalBinding targetBinding;
private boolean replaces;
private boolean replaceable;
private QName deployable;
private LogicalState state = LogicalState.NEW;
/**
* Instantiates a logical wire.
*
* @param parent component within which the wire is defined.
* @param source the source reference of the wire
* @param target the target service
* @param deployable the target service deployable
*/
public LogicalWire(LogicalComponent parent, LogicalReference source, LogicalService target, QName deployable) {
super(parent);
this.source = source;
this.target = target;
this.deployable = deployable;
}
/**
* Instantiates a logical wire.
*
* @param parent component within which the wire is defined.
* @param source the source reference of the wire
* @param target the target service
* @param deployable the target service deployable
* @param replaceable true if the wire was created from a reference @target attribute and can be replaced by a wire created from an explicit wire
* element at the composite level.
*/
public LogicalWire(LogicalComponent parent, LogicalReference source, LogicalService target, QName deployable, boolean replaceable) {
super(parent);
this.source = source;
this.target = target;
this.deployable = deployable;
this.replaceable = replaceable;
}
/**
* Gets the source of the wire.
*
* @return source of the wire.
*/
public LogicalReference getSource() {
return source;
}
/**
* Gets the target service of the wire.
*
* @return target service of the wire.
*/
public LogicalService getTarget() {
return target;
}
/**
* Returns true if the wire replaces wires specified by the @target attribute on a reference.
*
* @return true if the wire replaces wires specified by the @target attribute on a reference
*/
public boolean isReplaces() {
return replaces;
}
/**
* Ses if the wire replaces wires specified by the @target attribute on a reference.
*
* @param replaces true if the wire replaces wires specified by the @target attribute on a reference
*/
public void setReplaces(boolean replaces) {
this.replaces = replaces;
}
/**
* Returns true if the wire was created from a reference @target attribute and can be replaced by a wire created from an explicit wire element at
* the composite level.
*
* @return true if the wire is replaceable
*/
public boolean isReplaceable() {
return replaceable;
}
/**
* Returns the wire state.
*
* @return the wire state
*/
public LogicalState getState() {
return state;
}
/**
* Sets the wire state.
*
* @param state the wire state
*/
public void setState(LogicalState state) {
this.state = state;
}
/**
* Returns the deployable of the target for this wire. A source of a wire may be deployed via a different deployable thant its target. This value
* is used to track the target deployable so the wire may be undeployed along wih the target even if the source is not.
*
* @return the deployable that provisioned the wire.
*/
public QName getTargetDeployable() {
return deployable;
}
public LogicalBinding getSourceBinding() {
return sourceBinding;
}
public void setSourceBinding(LogicalBinding sourceBinding) {
this.sourceBinding = sourceBinding;
}
public LogicalBinding getTargetBinding() {
return targetBinding;
}
public void setTargetBinding(LogicalBinding targetBinding) {
this.targetBinding = targetBinding;
}
public QName getDeployable() {
return deployable;
}
public void setDeployable(QName deployable) {
this.deployable = deployable;
}
/**
* Tests for quality whether the source and target URIs are the same.
*
* @param obj Object to be tested against.
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if ((obj == null) || (obj.getClass() != this.getClass())) {
return false;
}
LogicalWire test = (LogicalWire) obj;
return target.equals(test.target) && source.equals(test.source);
}
/**
* Hash code based on the source and target URIs.
*
* @return Hash code based on the source and target URIs.
*/
public int hashCode() {
int hash = 7;
hash = 31 * hash + source.hashCode();
hash = 31 * hash + target.hashCode();
return hash;
}
}