SZUT/ProjectManagmentTool
5
0
Fork 0
Code Issues Pull requests Releases Wiki Activity Actions

Compare commits

base: SZUT:d9b9e2f8158f34551e80bf3ccc493f0ce2f0d140
Branches Tags
SZUT:trunk
..
compare: SZUT:88c1b196b1632e69416287af22d0734d46197fa4
Branches Tags
SZUT:trunk

No commits in common. "d9b9e2f8158f34551e80bf3ccc493f0ce2f0d140" and "88c1b196b1632e69416287af22d0734d46197fa4" have entirely different histories.
d9b9e2f815 ... 88c1b196b1

15 changed files with 11 additions and 627 deletions
Show stats Expand all files Collapse all files

473
api/employee.yml
View file

@ -1,473 +0,0 @@
openapi: 3.0.1
info:
title: Employees Management Micro-Service
description: "\n## Overview\n\nEmployees Management Service API manages the employees\
\ of HighTec Gmbh including their qualifications. It offers the possibility to\
\ create, read, update and delete employees and qualifications. Existing employees\
\ can be assigned new qualifications or have them withdrawn. \nThe API is organized\
\ around REST. It has predictable resource-oriented URLs, accepts JSON-encoded\
\ request bodies, returns JSON-encoded responses, uses standard HTTP response\
\ codes and authentication.\n\n## Authentication\n\nEmployees Management Service\
\ API uses JWTs to authenticate requests. You will receive a bearer token by making\
\ a POST-Request in IntelliJ on:\n\n\n```\nPOST http://keycloak.szut.dev/auth/realms/szut/protocol/openid-connect/token\n\
Content-Type: application/x-www-form-urlencoded\ngrant_type=password&client_id=employee-management-service&username=user&password=test\n\
```\n\n\nor by CURL\n```\ncurl -X POST 'http://keycloak.szut.dev/auth/realms/szut/protocol/openid-connect/token'\n\
--header 'Content-Type: application/x-www-form-urlencoded'\n--data-urlencode 'grant_type=password'\n\
--data-urlencode 'client_id=employee-management-service'\n--data-urlencode 'username=user'\n\
--data-urlencode 'password=test'\n```\n\nTo get a bearer-token in Postman, you\
\ have to follow the instructions in \n [Postman-Documentation](https://documenter.getpostman.com/view/7294517/SzmfZHnd).\n\
\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail.\
\ API requests without authentication will also fail. Each request has the URL\
\ \n `https://employee.szut.dev` and the address of the desired resource."
version: 1.0.1
servers:
- url: ""
security:
- bearerAuth: []
paths:
/qualifications/{id}:
put:
tags:
- qualification-controller
summary: updates a qualification
operationId: updateQualification
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QualificationPostDTO'
required: true
responses:
"401":
description: not authorized
"400":
description: invalid JSON posted
"200":
description: updated qualification
content:
application/json:
schema:
$ref: '#/components/schemas/QualificationPostDTO'
"404":
description: resource not found
delete:
tags:
- qualification-controller
summary: deletes a qualification by id
operationId: deleteQualificationByDesignation
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
"401":
description: not authorized
"403":
description: qualification is in use
"204":
description: delete successful
"404":
description: resource not found
/employees/{id}:
get:
tags:
- employee-controller
summary: find employee by id
operationId: findById
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
"401":
description: not authorized
"200":
description: employee
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeResponseDTO'
"404":
description: resource not found
put:
tags:
- employee-controller
summary: updates employee by id - only changes the fields that are posted
operationId: updateEmployee
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeRequestPutDTO'
required: true
responses:
"401":
description: not authorized
"200":
description: employee
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeResponseDTO'
"404":
description: resource not found
delete:
tags:
- employee-controller
summary: deletes a employee by id
operationId: deleteCustomer
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
"401":
description: not authorized
"204":
description: delete successful
"404":
description: resource not found
/qualifications:
get:
tags:
- qualification-controller
summary: delivers a list of all available qualifications
operationId: findAll
responses:
"401":
description: not authorized
"200":
description: list of qualifications
content:
application/json:
schema:
$ref: '#/components/schemas/QualificationPostDTO'
post:
tags:
- qualification-controller
summary: creates a new qualification with its id and designation
operationId: createQualification
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QualificationPostDTO'
required: true
responses:
"401":
description: not authorized
"201":
description: created qualification
content:
application/json:
schema:
$ref: '#/components/schemas/QualificationPostDTO'
"400":
description: invalid JSON posted
/employees:
get:
tags:
- employee-controller
summary: delivers a list of all employees
operationId: findAll_1
responses:
"401":
description: not authorized
"200":
description: list of employees
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/EmployeeResponseDTO'
post:
tags:
- employee-controller
summary: creates a new employee
operationId: createEmployee
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeRequestDTO'
required: true
responses:
"401":
description: not authorized
"400":
description: invalid JSON posted
"201":
description: created employee
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeResponseDTO'
/employees/{id}/qualifications:
get:
tags:
- employee-controller
summary: finds all qualifications of an employee by id
operationId: findAllQualificationOfAEmployeeById
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
"401":
description: not authorized
"200":
description: employee with a list of his qualifications
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeNameAndSkillDataDTO'
"404":
description: resource not found
post:
tags:
- employee-controller
summary: adds a qualification to an employee by id
operationId: addQualificationToEmployeeById
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QualificationPostDTO'
required: true
responses:
"401":
description: not authorized
"400":
description: invalid JSON posted or employee already has this qualification
"200":
description: employee with a list of his qualifications
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeNameAndSkillDataDTO'
"404":
description: resource not found
delete:
tags:
- employee-controller
summary: deletes a qualification of an employee by id
operationId: removeQualificationFromEmployee
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QualificationPostDTO'
required: true
responses:
"401":
description: not authorized
"200":
description: employee with a list of his qualifications
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeeNameAndSkillDataDTO'
"404":
description: resource not found
/qualifications/{id}/employees:
get:
tags:
- qualification-controller
summary: find employees by qualification id
operationId: findAllEmployeesByQualification
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: List of employees who have the desired qualification
content:
application/json:
schema:
$ref: '#/components/schemas/EmployeesForAQualificationDTO'
"401":
description: not authorized
"404":
description: qualification id does not exist
components:
schemas:
QualificationPostDTO:
required:
- skill
type: object
properties:
skill:
type: string
EmployeeRequestPutDTO:
type: object
properties:
lastName:
type: string
firstName:
type: string
street:
type: string
postcode:
type: string
city:
type: string
phone:
type: string
skillSet:
type: array
items:
type: integer
format: int64
EmployeeResponseDTO:
required:
- city
- firstName
- lastName
- phone
- postcode
- street
type: object
properties:
id:
type: integer
format: int64
lastName:
type: string
firstName:
type: string
street:
type: string
postcode:
maxLength: 5
minLength: 5
type: string
city:
type: string
phone:
type: string
skillSet:
type: array
items:
$ref: '#/components/schemas/QualificationGetDTO'
QualificationGetDTO:
type: object
properties:
skill:
type: string
id:
type: integer
format: int64
EmployeeRequestDTO:
required:
- city
- firstName
- lastName
- phone
- postcode
- street
type: object
properties:
lastName:
type: string
firstName:
type: string
street:
type: string
postcode:
maxLength: 5
minLength: 5
type: string
city:
type: string
phone:
type: string
skillSet:
type: array
items:
type: integer
format: int64
EmployeeNameAndSkillDataDTO:
type: object
properties:
id:
type: integer
format: int64
lastName:
type: string
firstName:
type: string
skillSet:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/QualificationPostDTO'
EmployeeNameDataDTO:
type: object
properties:
id:
type: integer
format: int64
lastName:
type: string
firstName:
type: string
EmployeesForAQualificationDTO:
type: object
properties:
qualification:
$ref: '#/components/schemas/QualificationGetDTO'
employees:
uniqueItems: true
type: array
items:
$ref: '#/components/schemas/EmployeeNameDataDTO'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT

22
build.gradle.kts
View file

@ -23,7 +23,7 @@ checkstyle {
} }
spotbugs { spotbugs {
toolVersion = "4.8.6" toolVersion = "4.8.6"
effort.set(Effort.MAX) effort.set(Effort.MAX)
reportLevel.set(Confidence.LOW) reportLevel.set(Confidence.LOW)
} }
@ -75,27 +75,20 @@ dependencies {
swaggerSources { swaggerSources {
register("pmt") { register("pmt") {
setInputFile(file("${rootDir}/api/pmt.yml")) setInputFile(file("${rootDir}/src/main/resources/api.yml"))
code.configFile = file("${rootDir}/gen/config-pmt.json") code.configFile = file("${rootDir}/src/main/resources/gen-config.json")
val validationTask = validation val validationTask = validation
code(delegateClosureOf<GenerateSwaggerCode> { code(delegateClosureOf<GenerateSwaggerCode> {
language = "spring" language = "spring"
code.rawOptions = code.rawOptions =
listOf("--ignore-file-override=" + file("${rootDir}/gen/.ignore-pmt").absolutePath) listOf("--ignore-file-override=" + file("${rootDir}/src/main/resources/.codegen-ignore").absolutePath)
dependsOn(validationTask) dependsOn(validationTask)
}) })
} }
create("employee") {
setInputFile(file("${rootDir}/api/employee.yml"))
code.configFile = file("${rootDir}/gen/config-employee.json")
code(delegateClosureOf<GenerateSwaggerCode> {
language = "java"
})
}
} }
tasks { tasks {
withType()
withType<Checkstyle> { withType<Checkstyle> {
reports { reports {
xml.required.set(true) xml.required.set(true)
@ -103,6 +96,7 @@ tasks {
} }
} }
withType<SpotBugsTask> { withType<SpotBugsTask> {
excludeFilter.set(file("${rootDir}/src/main/resources/spotbugs-exclude.xml")) excludeFilter.set(file("${rootDir}/src/main/resources/spotbugs-exclude.xml"))
} }
processResources { processResources {
@ -113,7 +107,6 @@ tasks {
} }
named("compileJava").configure { named("compileJava").configure {
dependsOn(swaggerSources.getByName("pmt").code) dependsOn(swaggerSources.getByName("pmt").code)
dependsOn(swaggerSources.getByName("employee").code)
} }
} }
@ -121,8 +114,5 @@ sourceSets {
main { main {
java.srcDir("${swaggerSources.getByName("pmt").code.outputDir}/src/main/java") java.srcDir("${swaggerSources.getByName("pmt").code.outputDir}/src/main/java")
resources.srcDir("${swaggerSources.getByName("pmt").code.outputDir}/src/main/resources") resources.srcDir("${swaggerSources.getByName("pmt").code.outputDir}/src/main/resources")
java.srcDir("${swaggerSources.getByName("employee").code.outputDir}/src/main/java")
resources.srcDir("${swaggerSources.getByName("employee").code.outputDir}/src/main/resources")
} }
} }

11
gen/config-employee.json
View file

@ -1,11 +0,0 @@
{
"modelPackage": "de.hmmh.pmt.employee.dtos",
"apiPackage": "de.hmmh.pmt.employee.api",
"invokerPackage": "de.hmmh.pmt.employee",
"java8": false,
"java11": true,
"dateLibrary": "java11",
"library": "resttemplate",
"serializableModel": true,
"jakarta": true
}

4
http/getToken.http
View file

@ -1,4 +0,0 @@
POST https://keycloak.szut.dev/auth/realms/szut/protocol/openid-connect/token
Content-Type: application/x-www-form-urlencoded
grant_type=password&client_id=employee-management-service&username=user&password=test

13
src/main/java/de/hmmh/pmt/ApiController.java
View file

@ -1,12 +1,9 @@
package de.hmmh.pmt; package de.hmmh.pmt;
import com.fasterxml.jackson.databind.ObjectMapper; import com.fasterxml.jackson.databind.ObjectMapper;
import de.hmmh.pmt.employee.ApiClientFactory;
import de.hmmh.pmt.employee.dtos.EmployeeResponseDTO;
import de.hmmh.pmt.oas.DefaultApi; import de.hmmh.pmt.oas.DefaultApi;
import de.hmmh.pmt.dtos.HelloOut; import de.hmmh.pmt.dtos.HelloOut;
import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletRequest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity; import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller; import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMapping;
@ -16,8 +13,6 @@ import java.util.Optional;
@Controller @Controller
@RequestMapping("${openapi.projectManagement.base-path:/api/v1}") @RequestMapping("${openapi.projectManagement.base-path:/api/v1}")
public class ApiController implements DefaultApi { public class ApiController implements DefaultApi {
@Autowired
private ApiClientFactory apiClientFactory;
@Override @Override
public Optional<ObjectMapper> getObjectMapper() { public Optional<ObjectMapper> getObjectMapper() {
@ -31,14 +26,8 @@ public class ApiController implements DefaultApi {
@Override @Override
public ResponseEntity<HelloOut> getHello() { public ResponseEntity<HelloOut> getHello() {
StringBuilder employees = new StringBuilder();
for (EmployeeResponseDTO employeeResponseDTO : apiClientFactory.getEmployeeApi().findAll1()) {
employees.append(employeeResponseDTO.toString());
}
HelloOut hello = new HelloOut(); HelloOut hello = new HelloOut();
hello.setMsg(employees.toString()); hello.setMsg("Hello World");
return ResponseEntity.ok(hello); return ResponseEntity.ok(hello);
} }
} }

13
src/main/java/de/hmmh/pmt/Config.java
View file

@ -1,13 +0,0 @@
package de.hmmh.pmt;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
@Configuration
public class Config {
@Bean
public RestTemplate restTemplate() {
return new RestTemplate();
}
}

4
src/main/java/de/hmmh/pmt/auth/JWT.java
View file

@ -2,7 +2,6 @@ package de.hmmh.pmt.auth;
import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse; import jakarta.servlet.http.HttpServletResponse;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity; import org.springframework.http.ResponseEntity;
import org.springframework.security.core.Authentication; import org.springframework.security.core.Authentication;
import org.springframework.security.core.GrantedAuthority; import org.springframework.security.core.GrantedAuthority;
@ -26,8 +25,7 @@ public class JWT implements LogoutHandler {
private static final String OIDC_LOGOUT_ROUTE = "/protocol/openid-connect/logout"; private static final String OIDC_LOGOUT_ROUTE = "/protocol/openid-connect/logout";
private static final String OIDC_TOKEN_HINT_QUERY_PARAMETER = "id_token_hin"; private static final String OIDC_TOKEN_HINT_QUERY_PARAMETER = "id_token_hin";
@Autowired private final RestTemplate template = new RestTemplate();
private RestTemplate template;
@Override @Override
public void logout(HttpServletRequest request, HttpServletResponse response, Authentication authentication) { public void logout(HttpServletRequest request, HttpServletResponse response, Authentication authentication) {

12
src/main/java/de/hmmh/pmt/auth/JwtToken.java
View file

@ -1,12 +0,0 @@
package de.hmmh.pmt.auth;
import lombok.Getter;
import lombok.Setter;
import org.springframework.stereotype.Component;
@Getter
@Setter
@Component
public class JwtToken{
private String token;
}

38
src/main/java/de/hmmh/pmt/auth/JwtTokenFilter.java
View file

@ -1,38 +0,0 @@
package de.hmmh.pmt.auth;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;
import java.io.IOException;
@Component
public class JwtTokenFilter extends OncePerRequestFilter {
@Autowired
private JwtToken token;
@Override
protected void doFilterInternal(
HttpServletRequest request,
HttpServletResponse response,
FilterChain filterChain
) throws ServletException, IOException {
token.setToken(null);
String authHeader = request.getHeader("Authorization");
if (authHeader == null) {
filterChain.doFilter(request, response);
return;
}
if (!authHeader.startsWith("Bearer ")) {
filterChain.doFilter(request, response);
return;
}
token.setToken(authHeader.substring("Bearer ".length()));
filterChain.doFilter(request, response);
}
}

37
src/main/java/de/hmmh/pmt/employee/ApiClientFactory.java
View file

@ -1,37 +0,0 @@
package de.hmmh.pmt.employee;
import de.hmmh.pmt.auth.JwtToken;
import de.hmmh.pmt.employee.api.EmployeeControllerApi;
import de.hmmh.pmt.employee.api.QualificationControllerApi;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class ApiClientFactory {
@Autowired
private ApiClient apiClient;
@Autowired
private JwtToken apiToken;
@Autowired
private EmployeeControllerApi employee;
@Autowired
private QualificationControllerApi qualification;
public EmployeeControllerApi getEmployeeApi() {
prepareApiClient();
employee.setApiClient(apiClient);
return employee;
}
public QualificationControllerApi getQualificationApi() {
prepareApiClient();
qualification.setApiClient(apiClient);
return qualification;
}
private void prepareApiClient() {
apiClient.setAccessToken(apiToken.getToken());
apiClient.setBasePath("https://employee.szut.dev");
}
}

0
gen/.ignore-pmt → src/main/resources/.codegen-ignore
View file

0
api/pmt.yml → src/main/resources/api.yml
View file

3
src/main/resources/checkstyle-ignore.xml
View file

@ -5,5 +5,6 @@
> >
<suppressions> <suppressions>
<suppress files="build[\\/]" checks="."/> <suppress files="[\\/]de[\\/]hmmh[\\/]pmt[\\/]oas" checks="."/>
<suppress files="[\\/]de[\\/]hmmh[\\/]pmt[\\/]dtos" checks="."/>
</suppressions> </suppressions>

0
gen/config-pmt.json → src/main/resources/gen-config.json
View file

8
src/main/resources/spotbugs-exclude.xml
View file

@ -1,11 +1,5 @@
<FindBugsFilter xmlns="https://raw.githubusercontent.com/spotbugs/spotbugs/4.8.6/spotbugs/etc/findbugsfilter.xsd"> <FindBugsFilter xmlns="https://raw.githubusercontent.com/spotbugs/spotbugs/4.8.6/spotbugs/etc/findbugsfilter.xsd">
<Match> <Match>
<!-- We Want This Exposure of Resources the Way it is for our usage --> <Class name="de.hmmh.pmt.OpenAPISpringBoot$ExitException"/>
<Class name="de.hmmh.pmt.employee.ApiClientFactory"/>
<Bug code="M,V,EI"/>
</Match>
<Match>
<!--Ignore Auto Generated Code -->
<Source name="~.*build/.*"/>
</Match> </Match>
</FindBugsFilter> </FindBugsFilter>