com.structurizr.view.Shape Java Examples
The following examples show how to use
com.structurizr.view.Shape.
You can vote up the ones you like or vote down the ones you don't like,
and go to the original project or source file by following the links above each example. You may check out the related API usage on the sidebar.
Example #1
Source File: AutomaticDocumentationTemplateExample.java From java with Apache License 2.0 | 6 votes |
public static void main(String[] args) throws Exception { Workspace workspace = new Workspace("Documentation - Automatic", "An empty software architecture document using the Structurizr template."); Model model = workspace.getModel(); ViewSet views = workspace.getViews(); Person user = model.addPerson("User", "A user of my software system."); SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system."); user.uses(softwareSystem, "Uses"); SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram."); contextView.addAllSoftwareSystems(); contextView.addAllPeople(); Styles styles = views.getConfiguration().getStyles(); styles.addElementStyle(Tags.PERSON).shape(Shape.Person); // this directory includes a mix of Markdown and AsciiDoc files File documentationRoot = new File("./structurizr-examples/src/com/structurizr/example/documentation/automatic"); AutomaticDocumentationTemplate template = new AutomaticDocumentationTemplate(workspace); template.addSections(softwareSystem, documentationRoot); StructurizrClient structurizrClient = new StructurizrClient(API_KEY, API_SECRET); structurizrClient.putWorkspace(WORKSPACE_ID, workspace); }
Example #2
Source File: ClientSideEncryption.java From java with Apache License 2.0 | 6 votes |
public static void main(String[] args) throws Exception { Workspace workspace = new Workspace("Client-side encrypted workspace", "This is a client-side encrypted workspace. The passphrase is 'password'."); Model model = workspace.getModel(); Person user = model.addPerson("User", "A user of my software system."); SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system."); user.uses(softwareSystem, "Uses"); ViewSet views = workspace.getViews(); SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram."); contextView.addAllSoftwareSystems(); contextView.addAllPeople(); Styles styles = views.getConfiguration().getStyles(); styles.addElementStyle(Tags.SOFTWARE_SYSTEM).background("#d34407").color("#ffffff"); styles.addElementStyle(Tags.PERSON).background("#f86628").color("#ffffff").shape(Shape.Person); StructurizrClient structurizrClient = new StructurizrClient(API_KEY, API_SECRET); structurizrClient.setEncryptionStrategy(new AesEncryptionStrategy("password")); structurizrClient.putWorkspace(WORKSPACE_ID, workspace); }
Example #3
Source File: GettingStarted.java From java with Apache License 2.0 | 6 votes |
public static void main(String[] args) throws Exception { // all software architecture models belong to a workspace Workspace workspace = new Workspace("Getting Started", "This is a model of my software system."); Model model = workspace.getModel(); // create a model to describe a user using a software system Person user = model.addPerson("User", "A user of my software system."); SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system."); user.uses(softwareSystem, "Uses"); // create a system context diagram showing people and software systems ViewSet views = workspace.getViews(); SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram."); contextView.addAllSoftwareSystems(); contextView.addAllPeople(); // add some styling to the diagram elements Styles styles = views.getConfiguration().getStyles(); styles.addElementStyle(Tags.SOFTWARE_SYSTEM).background("#1168bd").color("#ffffff"); styles.addElementStyle(Tags.PERSON).background("#08427b").color("#ffffff").shape(Shape.Person); // upload to structurizr.com (you'll need your own workspace ID, API key and API secret) StructurizrClient structurizrClient = new StructurizrClient(API_KEY, API_SECRET); structurizrClient.putWorkspace(WORKSPACE_ID, workspace); }
Example #4
Source File: StyleProvider.java From structurizr-extensions with Apache License 2.0 | 5 votes |
public StyleProvider(Workspace workspace) { Styles styles = workspace.getViews().getConfiguration().getStyles(); styles.addElementStyle(Tags.ELEMENT).width(500).height(350).color("#ffffff").fontSize(30).shape(Shape.RoundedBox); styles.addElementStyle(Tags.SOFTWARE_SYSTEM).background("#2A4E6E"); styles.addElementStyle(Tags.CONTAINER).background("#007F0E"); styles.addElementStyle(Tags.COMPONENT).background("#3059BA"); styles.addElementStyle(Tags.PERSON).width(475).background("#728da5").shape(Shape.Person); styles.addRelationshipStyle(Tags.RELATIONSHIP).dashed(true).thickness(5).fontSize(40).width(400); styles.addRelationshipStyle(Tags.SYNCHRONOUS).dashed(false); styles.addRelationshipStyle(Tags.ASYNCHRONOUS).dashed(true); }
Example #5
Source File: HttpHealthChecks.java From java with Apache License 2.0 | 5 votes |
public static void main(String[] args) throws Exception { Workspace workspace = new Workspace("HTTP-based health checks example", "An example of how to use the HTTP-based health checks feature"); Model model = workspace.getModel(); ViewSet views = workspace.getViews(); SoftwareSystem structurizr = model.addSoftwareSystem("Structurizr", "A publishing platform for software architecture diagrams and documentation based upon the C4 model."); Container webApplication = structurizr.addContainer("structurizr.com", "Provides all of the server-side functionality of Structurizr, serving static and dynamic content to users.", "Java and Spring MVC"); Container database = structurizr.addContainer("Database", "Stores information about users, workspaces, etc.", "Relational Database Schema"); database.addTags(DATABASE_TAG); webApplication.uses(database, "Reads from and writes to", "JDBC"); DeploymentNode amazonWebServices = model.addDeploymentNode("Amazon Web Services", "", "us-east-1"); DeploymentNode pivotalWebServices = amazonWebServices.addDeploymentNode("Pivotal Web Services", "Platform as a Service provider.", "Cloud Foundry"); ContainerInstance liveWebApplication = pivotalWebServices.addDeploymentNode("www.structurizr.com", "An open source Java EE web server.", "Apache Tomcat") .add(webApplication); ContainerInstance liveDatabaseInstance = amazonWebServices.addDeploymentNode("Amazon RDS", "Database as a Service provider.", "MySQL") .add(database); // add health checks to the container instances, which return a simple HTTP 200 to say everything is okay liveWebApplication.addHealthCheck("Web Application is running", "https://www.structurizr.com/health"); liveDatabaseInstance.addHealthCheck("Database is accessible from Web Application", "https://www.structurizr.com/health/database"); // the pass/fail status from the health checks is used to supplement any deployment views that include the container instances that have health checks defined DeploymentView deploymentView = views.createDeploymentView(structurizr, "Deployment", "A deployment diagram showing the live environment."); deploymentView.setEnvironment("Live"); deploymentView.addAllDeploymentNodes(); views.getConfiguration().getStyles().addElementStyle(Tags.ELEMENT).color("#ffffff"); views.getConfiguration().getStyles().addElementStyle(DATABASE_TAG).shape(Shape.Cylinder); StructurizrClient structurizrClient = new StructurizrClient(API_KEY, API_SECRET); structurizrClient.putWorkspace(WORKSPACE_ID, workspace); }
Example #6
Source File: StructurizrSimple.java From tutorials with MIT License | 5 votes |
private static void addStyles(ViewSet viewSet) { Styles styles = viewSet.getConfiguration().getStyles(); styles.addElementStyle(Tags.ELEMENT).color("#000000"); styles.addElementStyle(Tags.PERSON).background("#ffbf00").shape(Shape.Person); styles.addElementStyle(Tags.CONTAINER).background("#facc2E"); styles.addRelationshipStyle(Tags.RELATIONSHIP).routing(Routing.Orthogonal); styles.addRelationshipStyle(Tags.ASYNCHRONOUS).dashed(true); styles.addRelationshipStyle(Tags.SYNCHRONOUS).dashed(false); }
Example #7
Source File: ViewCreator.java From architecture-guild with Apache License 2.0 | 4 votes |
private static void setupStyles(ViewSet views) { Styles styles = views.getConfiguration().getStyles(); styles.addElementStyle(Tags.SOFTWARE_SYSTEM).background("#1168bd").color("#ffffff"); styles.addElementStyle(Tags.PERSON).background("#08427b").color("#ffffff").shape(Shape.Person); }
Example #8
Source File: AwsPublicSystemDocumentation.java From cia with Apache License 2.0 | 4 votes |
/** * The main method. * * @param args * the arguments * @throws Exception * the exception */ public static void main(final String[] args) throws Exception { final Workspace workspace = new Workspace("Citizen Intelligence Agency", "Public Aws System Documentation"); final Model model = workspace.getModel(); final ViewSet viewSet = workspace.getViews(); final SoftwareSystem ciaSystem = model.addSoftwareSystem("Citizen Intelligence Agency", "Tracking politicians like bugs!"); final DeploymentNode masterAccountNode = model.addDeploymentNode("Master Account", "AWS", "Aws Account"); final Container awsAccountContainer = ciaSystem.addContainer("Master Account", "AWS", "Aws Account"); final DeploymentNode iamAccountNode = model.addDeploymentNode("IAM Account", "AWS", "Aws Account"); final Container iamAccountContainer = ciaSystem.addContainer("IAM Account", "AWS", "Aws Account"); final DeploymentNode devAccountNode = model.addDeploymentNode("Development Account", "AWS", "Aws Account"); final Container devAccountContainer = ciaSystem.addContainer("Development Account", "AWS", "Aws Account"); final DeploymentNode opCenterAccountNode = model.addDeploymentNode("Operation Center Account", "AWS", "Aws Account"); final Container opCenterAccountContainer = ciaSystem.addContainer("Operation Center Account", "AWS", "Aws Account"); final DeploymentNode auditAccountNode = model.addDeploymentNode("Audit Account", "AWS", "Aws Account"); final Container auditAccountContainer = ciaSystem.addContainer("Audit Account", "AWS", "Aws Account"); final DeploymentNode appAccountNode = model.addDeploymentNode("Application Account", "AWS", "Aws Account"); final Container appAccountContainer = ciaSystem.addContainer("Application Account", "AWS", "Aws Account"); awsAccountContainer.uses(iamAccountContainer, "create/restrict"); awsAccountContainer.uses(devAccountContainer, "create/restrict"); awsAccountContainer.uses(opCenterAccountContainer, "create/restrict"); awsAccountContainer.uses(auditAccountContainer, "create/restrict"); awsAccountContainer.uses(appAccountContainer, "create/restrict"); awsAccountContainer.uses(auditAccountContainer, "publish event/audit"); iamAccountContainer.uses(auditAccountContainer, "publish event/audit"); devAccountContainer.uses(auditAccountContainer, "publish event/audit"); opCenterAccountContainer.uses(auditAccountContainer, "publish event/audit"); appAccountContainer.uses(auditAccountContainer, "publish event/audit"); opCenterAccountContainer.uses(auditAccountContainer, "Monitor event/audit"); iamAccountContainer.uses(devAccountContainer, "manage access"); iamAccountContainer.uses(appAccountContainer, "manage access"); iamAccountContainer.uses(opCenterAccountContainer, "manage access"); opCenterAccountNode.add(opCenterAccountContainer); devAccountNode.add(devAccountContainer); auditAccountNode.add(auditAccountContainer); appAccountNode.add(appAccountContainer); iamAccountNode.add(iamAccountContainer); masterAccountNode.add(awsAccountContainer); final DeploymentView developmentDeploymentView = viewSet.createDeploymentView(ciaSystem, "\"Production Aws Account structure\"", "\"Production Aws Account structure\""); developmentDeploymentView.add(masterAccountNode); developmentDeploymentView.add(iamAccountNode); developmentDeploymentView.add(devAccountNode); developmentDeploymentView.add(opCenterAccountNode); developmentDeploymentView.add(auditAccountNode); developmentDeploymentView.add(appAccountNode); final Styles styles = viewSet.getConfiguration().getStyles(); styles.addElementStyle(Tags.COMPONENT).background("#1168bd").color("#ffffff"); styles.addElementStyle(Tags.CONTAINER).background("#1168bd").color("#ffffff"); styles.addElementStyle(Tags.SOFTWARE_SYSTEM).background("#1168bd").color("#ffffff"); styles.addElementStyle(Tags.PERSON).background("#519823").color("#ffffff").shape(Shape.Person); styles.addElementStyle("Database").shape(Shape.Cylinder); printPlantUml(workspace); System.setProperty("PLANTUML_LIMIT_SIZE", "8192"); Run.main(new String[] { Paths.get(".").toAbsolutePath().normalize().toString() + File.separator + "target" + File.separator + "site" + File.separator + "architecture" + File.separator }); }
Example #9
Source File: ViewpointsAndPerspectivesDocumentationExample.java From java with Apache License 2.0 | 4 votes |
public static void main(String[] args) throws Exception { Workspace workspace = new Workspace("Documentation - Viewpoints and Perspectives", "An empty software architecture document using the Viewpoints and Perspectives template."); Model model = workspace.getModel(); ViewSet views = workspace.getViews(); Person user = model.addPerson("User", "A user of my software system."); SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system."); user.uses(softwareSystem, "Uses"); SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram."); contextView.addAllSoftwareSystems(); contextView.addAllPeople(); Styles styles = views.getConfiguration().getStyles(); styles.addElementStyle(Tags.PERSON).shape(Shape.Person); ViewpointsAndPerspectivesDocumentationTemplate template = new ViewpointsAndPerspectivesDocumentationTemplate(workspace); // this is the Markdown version File documentationRoot = new File("./structurizr-examples/src/com/structurizr/example/documentation/viewpointsandperspectives/markdown"); template.addIntroductionSection(softwareSystem, new File(documentationRoot, "01-introduction.md")); template.addGlossarySection(softwareSystem, new File(documentationRoot, "02-glossary.md")); template.addSystemStakeholdersAndRequirementsSection(softwareSystem, new File(documentationRoot, "03-system-stakeholders-and-requirements.md")); template.addArchitecturalForcesSection(softwareSystem, new File(documentationRoot, "04-architectural-forces.md")); template.addArchitecturalViewsSection(softwareSystem, new File(documentationRoot, "05-architectural-views")); template.addSystemQualitiesSection(softwareSystem, new File(documentationRoot, "06-system-qualities.md")); template.addAppendicesSection(softwareSystem, new File(documentationRoot, "07-appendices.md")); // this is the AsciiDoc version // File documentationRoot = new File("./structurizr-examples/src/com/structurizr/example/documentation/viewpointsandperspectives/asciidoc"); // template.addIntroductionSection(softwareSystem, new File(documentationRoot, "01-introduction.adoc")); // template.addGlossarySection(softwareSystem, new File(documentationRoot, "02-glossary.adoc")); // template.addSystemStakeholdersAndRequirementsSection(softwareSystem, new File(documentationRoot, "03-system-stakeholders-and-requirements.adoc")); // template.addArchitecturalForcesSection(softwareSystem, new File(documentationRoot, "04-architectural-forces.adoc")); // template.addArchitecturalViewsSection(softwareSystem, new File(documentationRoot, "05-architectural-views")); // template.addSystemQualitiesSection(softwareSystem, new File(documentationRoot, "06-system-qualities.adoc")); // template.addAppendicesSection(softwareSystem, new File(documentationRoot, "07-appendices.adoc")); StructurizrClient structurizrClient = new StructurizrClient(API_KEY, API_SECRET); structurizrClient.putWorkspace(WORKSPACE_ID, workspace); }
Example #10
Source File: Arc42DocumentationExample.java From java with Apache License 2.0 | 4 votes |
public static void main(String[] args) throws Exception { Workspace workspace = new Workspace("Documentation - arc42", "An empty software architecture document using the arc42 template."); Model model = workspace.getModel(); ViewSet views = workspace.getViews(); Person user = model.addPerson("User", "A user of my software system."); SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system."); user.uses(softwareSystem, "Uses"); SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram."); contextView.addAllSoftwareSystems(); contextView.addAllPeople(); Styles styles = views.getConfiguration().getStyles(); styles.addElementStyle(Tags.PERSON).shape(Shape.Person); Arc42DocumentationTemplate template = new Arc42DocumentationTemplate(workspace); // this is the Markdown version File documentationRoot = new File("./structurizr-examples/src/com/structurizr/example/documentation/arc42/markdown"); template.addIntroductionAndGoalsSection(softwareSystem, new File(documentationRoot, "01-introduction-and-goals.md")); template.addConstraintsSection(softwareSystem, new File(documentationRoot, "02-architecture-constraints.md")); template.addContextAndScopeSection(softwareSystem, new File(documentationRoot, "03-system-scope-and-context.md")); template.addSolutionStrategySection(softwareSystem, new File(documentationRoot, "04-solution-strategy.md")); template.addBuildingBlockViewSection(softwareSystem, new File(documentationRoot, "05-building-block-view.md")); template.addRuntimeViewSection(softwareSystem, new File(documentationRoot, "06-runtime-view.md")); template.addDeploymentViewSection(softwareSystem, new File(documentationRoot, "07-deployment-view.md")); template.addCrosscuttingConceptsSection(softwareSystem, new File(documentationRoot, "08-crosscutting-concepts.md")); template.addArchitecturalDecisionsSection(softwareSystem, new File(documentationRoot, "09-architecture-decisions.md")); template.addRisksAndTechnicalDebtSection(softwareSystem, new File(documentationRoot, "10-quality-requirements.md")); template.addQualityRequirementsSection(softwareSystem, new File(documentationRoot, "11-risks-and-technical-debt.md")); template.addGlossarySection(softwareSystem, new File(documentationRoot, "12-glossary.md")); // this is the AsciiDoc version // File documentationRoot = new File("./structurizr-examples/src/com/structurizr/example/documentation/arc42/asciidoc"); // template.addIntroductionAndGoalsSection(softwareSystem, new File(documentationRoot, "01-introduction-and-goals.adoc")); // template.addConstraintsSection(softwareSystem, new File(documentationRoot, "02-architecture-constraints.adoc")); // template.addContextAndScopeSection(softwareSystem, new File(documentationRoot, "03-system-scope-and-context.adoc")); // template.addSolutionStrategySection(softwareSystem, new File(documentationRoot, "04-solution-strategy.adoc")); // template.addBuildingBlockViewSection(softwareSystem, new File(documentationRoot, "05-building-block-view.adoc")); // template.addRuntimeViewSection(softwareSystem, new File(documentationRoot, "06-runtime-view.adoc")); // template.addDeploymentViewSection(softwareSystem, new File(documentationRoot, "07-deployment-view.adoc")); // template.addCrosscuttingConceptsSection(softwareSystem, new File(documentationRoot, "08-crosscutting-concepts.adoc")); // template.addArchitecturalDecisionsSection(softwareSystem, new File(documentationRoot, "09-architecture-decisions.adoc")); // template.addRisksAndTechnicalDebtSection(softwareSystem, new File(documentationRoot, "10-quality-requirements.adoc")); // template.addQualityRequirementsSection(softwareSystem, new File(documentationRoot, "11-risks-and-technical-debt.adoc")); // template.addGlossarySection(softwareSystem, new File(documentationRoot, "12-glossary.adoc")); StructurizrClient structurizrClient = new StructurizrClient(API_KEY, API_SECRET); structurizrClient.putWorkspace(WORKSPACE_ID, workspace); }
Example #11
Source File: StructurizrDocumentationExample.java From java with Apache License 2.0 | 4 votes |
public static void main(String[] args) throws Exception { Workspace workspace = new Workspace("Documentation - Structurizr", "An empty software architecture document using the Structurizr template."); Model model = workspace.getModel(); ViewSet views = workspace.getViews(); Person user = model.addPerson("User", "A user of my software system."); SoftwareSystem softwareSystem = model.addSoftwareSystem("Software System", "My software system."); user.uses(softwareSystem, "Uses"); SystemContextView contextView = views.createSystemContextView(softwareSystem, "SystemContext", "An example of a System Context diagram."); contextView.addAllSoftwareSystems(); contextView.addAllPeople(); Styles styles = views.getConfiguration().getStyles(); styles.addElementStyle(Tags.PERSON).shape(Shape.Person); StructurizrDocumentationTemplate template = new StructurizrDocumentationTemplate(workspace); // this is the Markdown version File documentationRoot = new File("./structurizr-examples/src/com/structurizr/example/documentation/structurizr/markdown"); template.addContextSection(softwareSystem, new File(documentationRoot, "01-context.md")); template.addFunctionalOverviewSection(softwareSystem, new File(documentationRoot, "02-functional-overview.md")); template.addQualityAttributesSection(softwareSystem, new File(documentationRoot, "03-quality-attributes.md")); template.addConstraintsSection(softwareSystem, new File(documentationRoot, "04-constraints.md")); template.addPrinciplesSection(softwareSystem, new File(documentationRoot, "05-principles.md")); template.addSoftwareArchitectureSection(softwareSystem, new File(documentationRoot, "06-software-architecture.md")); template.addDataSection(softwareSystem, new File(documentationRoot, "07-data.md")); template.addInfrastructureArchitectureSection(softwareSystem, new File(documentationRoot, "08-infrastructure-architecture.md")); template.addDeploymentSection(softwareSystem, new File(documentationRoot, "09-deployment.md")); template.addDevelopmentEnvironmentSection(softwareSystem, new File(documentationRoot, "10-development-environment.md")); template.addOperationAndSupportSection(softwareSystem, new File(documentationRoot, "11-operation-and-support.md")); template.addDecisionLogSection(softwareSystem, new File(documentationRoot, "12-decision-log.md")); // this is the AsciiDoc version // File documentationRoot = new File("./structurizr-examples/src/com/structurizr/example/documentation/structurizr/asciidoc"); // template.addContextSection(softwareSystem, new File(documentationRoot, "01-context.adoc")); // template.addFunctionalOverviewSection(softwareSystem, new File(documentationRoot, "02-functional-overview.adoc")); // template.addQualityAttributesSection(softwareSystem, new File(documentationRoot, "03-quality-attributes.adoc")); // template.addConstraintsSection(softwareSystem, new File(documentationRoot, "04-constraints.adoc")); // template.addPrinciplesSection(softwareSystem, new File(documentationRoot, "05-principles.adoc")); // template.addSoftwareArchitectureSection(softwareSystem, new File(documentationRoot, "06-software-architecture.adoc")); // template.addDataSection(softwareSystem, new File(documentationRoot, "07-data.adoc")); // template.addInfrastructureArchitectureSection(softwareSystem, new File(documentationRoot, "08-infrastructure-architecture.adoc")); // template.addDeploymentSection(softwareSystem, new File(documentationRoot, "09-deployment.adoc")); // template.addDevelopmentEnvironmentSection(softwareSystem, new File(documentationRoot, "10-development-environment.adoc")); // template.addOperationAndSupportSection(softwareSystem, new File(documentationRoot, "11-operation-and-support.adoc")); // template.addDecisionLogSection(softwareSystem, new File(documentationRoot, "12-decision-log.adoc")); StructurizrClient structurizrClient = new StructurizrClient(API_KEY, API_SECRET); structurizrClient.putWorkspace(WORKSPACE_ID, workspace); }