Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CTI example #151

Open
wants to merge 27 commits into
base: master
Choose a base branch
from
Open

Add CTI example #151

wants to merge 27 commits into from

Conversation

SullivanDaly
Copy link
Contributor

What is the goal of this PR?

Adding a CTI example using Spring Boot and GraphiQL in order to get a graphql front end as well as a REST API.

What are the changes implemented in this PR?

This project utilizes Spring Boot and GraphQL to access a TypeDB database filled with Cyber Threat Intelligence (CTI) related dataset. The application provides a GraphQL API to interact with the CTI data stored in the TypeDB database.

We can also see how easy it is to create complex queries using query composition.

We are using the DAO design pattern on which our design depends to be able to treat data and demonstrate query composition in TypeDB.

Change Main README.md
@typedb-bot
Copy link
Member

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.


Trivial Change

  • This change is trivial and does not require a code or architecture review.

Code

  • Packages, classes, and methods have a single domain of responsibility.
  • Packages, classes, and methods are grouped into cohesive and consistent domain model.
  • The code is canonical and the minimum required to achieve the goal.
  • Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
  • Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
  • The code is algorithmically efficient and scalable for the whole application.

Architecture

  • Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
  • Any required build and release automations are updated and/or implemented.
  • Any new components follows a consistent style with respect to the pre-existing codebase.
  • The architecture intuitively reflects the application domain, and is easy to understand.
  • The architecture has a well-defined hierarchy of encapsulated components.
  • The architecture is extensible and scalable.

Copy link

@shane-k-j shane-k-j left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use the feedback here and fix all instance of it, and not just the ones I tagged.

import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfiguration {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@SullivanDaly This class isn't really necessary. It's be cleaner to use @ConfigurationProperties("db") right on the Controller, and inject values into host, port and db fields in it.

So in Contoller have:

@ConfigurationProperties("db")
@RestController
public class Controller {

private String host;
private String port;
private String db;

Then in application.properties, have:

db.host=localhost
db.port=1729
db.name=CTI_SPRING

For examples, see this blog

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, so for this one as I am using those information in the Controller, in the SessionWrapper and in the CTI Bean.

Is it better to retrieve info from the file in those three or keep the "centralized" class passed to the constructor?

Copy link

@shane-k-j shane-k-j left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of these should be fixed in every class

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants