com.structurizr.model.DeploymentNode Maven / Gradle / Ivy
package com.structurizr.model;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonSetter;
import java.util.*;
/**
*
* Represents a deployment node, which is something like:
*
*
*
* - Physical infrastructure (e.g. a physical server or device)
* - Virtualised infrastructure (e.g. IaaS, PaaS, a virtual machine)
* - Containerised infrastructure (e.g. a Docker container)
* - Database server
* - Java EE web/application server
* - Microsoft IIS
* - etc
*
*/
public final class DeploymentNode extends DeploymentElement {
private String technology;
private String instances = "1";
private Set children = new TreeSet<>();
private Set infrastructureNodes = new TreeSet<>();
private Set softwareSystemInstances = new TreeSet<>();
private Set containerInstances = new TreeSet<>();
/**
* Adds a software system instance to this deployment node, replicating relationships.
*
* @param softwareSystem the SoftwareSystem to add an instance of
* @return a SoftwareSystemInstance object
*/
public SoftwareSystemInstance add(SoftwareSystem softwareSystem) {
return add(softwareSystem, DEFAULT_DEPLOYMENT_GROUP);
}
/**
* Adds a software system instance to this deployment node, replicating relationships.
*
* @param softwareSystem the SoftwareSystem to add an instance of
* @param deploymentGroups the deployment group(s)
* @return a SoftwareSystemInstance object
*/
public SoftwareSystemInstance add(SoftwareSystem softwareSystem, String... deploymentGroups) {
SoftwareSystemInstance softwareSystemInstance = getModel().addSoftwareSystemInstance(this, softwareSystem, deploymentGroups);
this.softwareSystemInstances.add(softwareSystemInstance);
return softwareSystemInstance;
}
void remove(SoftwareSystemInstance softwareSystemInstance) {
this.softwareSystemInstances.remove(softwareSystemInstance);
}
void remove(ContainerInstance containerInstance) {
this.containerInstances.remove(containerInstance);
}
/**
* Adds a container instance to this deployment node, replicating relationships.
*
* @param container the Container to add an instance of
* @return a ContainerInstance object
*/
public ContainerInstance add(Container container) {
return add(container, DEFAULT_DEPLOYMENT_GROUP);
}
/**
* Adds a container instance to this deployment node, optionally replicating relationships.
*
* @param container the Container to add an instance of
* @param deploymentGroups the deployment group(s)
* @return a ContainerInstance object
*/
public ContainerInstance add(Container container, String... deploymentGroups) {
ContainerInstance containerInstance = getModel().addContainerInstance(this, container, deploymentGroups);
this.containerInstances.add(containerInstance);
return containerInstance;
}
/**
* Adds a child deployment node.
*
* @param name the name of the deployment node
* @return a DeploymentNode object
*/
public DeploymentNode addDeploymentNode(String name) {
return addDeploymentNode(name, null, null);
}
/**
* Adds a child deployment node.
*
* @param name the name of the deployment node
* @param description a short description
* @param technology the technology
* @return a DeploymentNode object
*/
public DeploymentNode addDeploymentNode(String name, String description, String technology) {
return addDeploymentNode(name, description, technology, 1);
}
/**
* Adds a child deployment node.
*
* @param name the name of the deployment node
* @param description a short description
* @param technology the technology
* @param instances the number of instances
* @return a DeploymentNode object
*/
public DeploymentNode addDeploymentNode(String name, String description, String technology, int instances) {
return addDeploymentNode(name, description, technology, instances, null);
}
/**
* Adds a child deployment node.
*
* @param name the name of the deployment node
* @param description a short description
* @param technology the technology
* @param instances the number of instances
* @param properties a Map (String,String) describing name=value properties
* @return a DeploymentNode object
*/
public DeploymentNode addDeploymentNode(String name, String description, String technology, int instances, Map properties) {
DeploymentNode deploymentNode = getModel().addDeploymentNode(this, this.getEnvironment(), name, description, technology, instances, properties);
if (deploymentNode != null) {
children.add(deploymentNode);
}
return deploymentNode;
}
void remove(DeploymentNode deploymentNode) {
children.remove(deploymentNode);
}
/**
* Gets the DeploymentNode with the specified name.
*
* @param name the name of the deployment node
* @return the DeploymentNode instance with the specified name (or null if it doesn't exist).
*/
public DeploymentNode getDeploymentNodeWithName(String name) {
if (name == null || name.trim().length() == 0) {
throw new IllegalArgumentException("A name must be specified.");
}
for (DeploymentNode deploymentNode : getChildren()) {
if (deploymentNode.getName().equals(name)) {
return deploymentNode;
}
}
return null;
}
/**
* Gets the infrastructure node with the specified name.
*
* @param name the name of the infrastructure node
* @return the InfrastructureNode instance with the specified name (or null if it doesn't exist).
*/
public InfrastructureNode getInfrastructureNodeWithName(String name) {
if (name == null || name.trim().length() == 0) {
throw new IllegalArgumentException("A name must be specified.");
}
for (InfrastructureNode infrastructureNode : getInfrastructureNodes()) {
if (infrastructureNode.getName().equals(name)) {
return infrastructureNode;
}
}
return null;
}
/**
* Adds a child infrastructure node.
*
* @param name the name of the infrastructure node
* @return an InfrastructureNode object
*/
public InfrastructureNode addInfrastructureNode(String name) {
return addInfrastructureNode(name, null, null);
}
/**
* Adds a child infrastructure node.
*
* @param name the name of the infrastructure node
* @param description a short description
* @param technology the technology
* @return an InfrastructureNode object
*/
public InfrastructureNode addInfrastructureNode(String name, String description, String technology) {
return addInfrastructureNode(name, description, technology, null);
}
/**
* Adds a child infrastructure node.
*
* @param name the name of the infrastructure node
* @param description a short description
* @param technology the technology
* @param properties a Map (String,String) describing name=value properties
* @return an InfrastructureNode object
*/
public InfrastructureNode addInfrastructureNode(String name, String description, String technology, Map properties) {
InfrastructureNode infrastructureNode = getModel().addInfrastructureNode(this, name, description, technology, properties);
if (infrastructureNode != null) {
infrastructureNodes.add(infrastructureNode);
}
return infrastructureNode;
}
/**
* Adds a relationship between this and another deployment node.
*
* @param destination the destination DeploymentNode
* @param description a short description of the relationship
* @param technology the technology
* @return a Relationship object
*/
public Relationship uses(DeploymentNode destination, String description, String technology) {
return uses(destination, description, technology, null);
}
/**
* Adds a relationship between this and another deployment node.
*
* @param destination the destination DeploymentNode
* @param description a short description of the relationship
* @param technology the technology
* @param interactionStyle the interaction style (Synchronous vs Asynchronous)
* @return a Relationship object
*/
public Relationship uses(DeploymentNode destination, String description, String technology, InteractionStyle interactionStyle) {
return uses(destination, description, technology, interactionStyle, new String[0]);
}
/**
* Adds a relationship between this and another deployment node.
*
* @param destination the destination DeploymentNode
* @param description a short description of the relationship
* @param technology the technology
* @param interactionStyle the interaction style (Synchronous vs Asynchronous)
* @param tags an array of tags
* @return a Relationship object
*/
public Relationship uses(DeploymentNode destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) {
return getModel().addRelationship(this, destination, description, technology, interactionStyle, tags);
}
/**
* Adds a relationship between this deployment node and an infrastructure node.
*
* @param destination the destination InfrastructureNode
* @param description a short description of the relationship
* @param technology the technology
* @return a Relationship object
*/
public Relationship uses(InfrastructureNode destination, String description, String technology) {
return uses(destination, description, technology, null);
}
/**
* Adds a relationship between this deployment node and an infrastructure node.
*
* @param destination the destination InfrastructureNode
* @param description a short description of the relationship
* @param technology the technology
* @param interactionStyle the interaction style (Synchronous vs Asynchronous)
* @return a Relationship object
*/
public Relationship uses(InfrastructureNode destination, String description, String technology, InteractionStyle interactionStyle) {
return uses(destination, description, technology, interactionStyle, new String[0]);
}
/**
* Adds a relationship between this deployment node and an infrastructure node.
*
* @param destination the destination InfrastructureNode
* @param description a short description of the relationship
* @param technology the technology
* @param interactionStyle the interaction style (Synchronous vs Asynchronous)
* @param tags an array of tags
* @return a Relationship object
*/
public Relationship uses(InfrastructureNode destination, String description, String technology, InteractionStyle interactionStyle, String[] tags) {
return getModel().addRelationship(this, destination, description, technology, interactionStyle, tags);
}
/**
* Gets the set of child deployment nodes.
*
* @return a Set of DeploymentNode objects
*/
public Set getChildren() {
return new TreeSet<>(children);
}
void setChildren(Set children) {
if (children != null) {
this.children = new TreeSet<>(children);
}
}
/**
* Gets the set of child infrastructure nodes.
*
* @return a Set of InfrastructureNode objects
*/
public Set getInfrastructureNodes() {
return new TreeSet<>(infrastructureNodes);
}
void setInfrastructureNodes(Set infrastructureNodes) {
if (infrastructureNodes != null) {
this.infrastructureNodes = new TreeSet<>(infrastructureNodes);
}
}
/**
* Determines whether this deployment node has any infrastructure nodes.
*
* @return true if it has infrastructure nodes, false otherwise
*/
@JsonIgnore
public boolean hasInfrastructureNodes() {
return !infrastructureNodes.isEmpty();
}
/**
* Determines whether this deployment node has any child deployment nodes.
*
* @return true if it has child deployment nodes, false otherwise
*/
@JsonIgnore
public boolean hasChildren() {
return !children.isEmpty();
}
/**
* Determines whether this deployment node has any software system instances.
*
* @return true if it has software system instances, false otherwise
*/
@JsonIgnore
public boolean hasSoftwareSystemInstances() {
return !softwareSystemInstances.isEmpty();
}
/**
* Determines whether this deployment node has any container instances.
*
* @return true if it has container instances, false otherwise
*/
@JsonIgnore
public boolean hasContainerInstances() {
return !containerInstances.isEmpty();
}
/**
* Gets the set of software system instances associated with this deployment node.
*
* @return a Set of SoftwareSystemInstance objects
*/
public Set getSoftwareSystemInstances() {
return new TreeSet<>(softwareSystemInstances);
}
void setSoftwareSystemInstances(Set softwareSystemInstances) {
if (softwareSystemInstances != null) {
this.softwareSystemInstances = new TreeSet<>(softwareSystemInstances);
}
}
/**
* Gets the set of container instances associated with this deployment node.
*
* @return a Set of ContainerInstance objects
*/
public Set getContainerInstances() {
return new TreeSet<>(containerInstances);
}
void setContainerInstances(Set containerInstances) {
if (containerInstances != null) {
this.containerInstances = new TreeSet<>(containerInstances);
}
}
public String getTechnology() {
return technology;
}
public void setTechnology(String technology) {
this.technology = technology;
}
public String getInstances() {
return instances;
}
public void setInstances(int instances) {
setInstances("" + instances);
}
@JsonSetter
public void setInstances(String instances) {
try {
int instancesAsInteger = Integer.parseInt(instances);
if (instancesAsInteger < 1) {
throw new IllegalArgumentException("Number of instances must be a positive integer or a range.");
}
} catch (NumberFormatException nfe) {
if (instances.matches("\\d*\\.\\.\\d*")) {
String[] range = instances.split("\\.\\.");
if (Integer.parseInt(range[0]) > Integer.parseInt(range[1])) {
throw new IllegalArgumentException("Range upper bound must be greater than the lower bound.");
}
} else if (instances.matches("\\d*..N")) {
// okay
} else if (instances.matches("\\d*..\\*")) {
// okay
} else {
throw new IllegalArgumentException("Number of instances must be a positive integer or a range.");
}
}
this.instances = instances;
}
@JsonIgnore
public Set getDefaultTags() {
return new LinkedHashSet<>(Arrays.asList(Tags.ELEMENT, Tags.DEPLOYMENT_NODE));
}
@Override
public String getCanonicalName() {
return new CanonicalNameGenerator().generate(this);
}
}