Skip to content

Commit c441bc2

Browse files
WeltraumschafManuelNeuer
authored andcommitted
#36 Remove DefectDojo prefix since most types does not follow this pattern
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
1 parent b9bb068 commit c441bc2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+185
-183
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The client is supposed to be compatible with DefectDojo 1.10 and later, older ve
1616

1717
```java
1818
import com.fasterxml.jackson.core.JsonProcessingException;
19-
import io.securecodebox.persistence.defectdojo.config.DefectDojoConfig;
19+
import io.securecodebox.persistence.defectdojo.config.Config;
2020
import io.securecodebox.persistence.defectdojo.service.ProductTypeService;
2121

2222
import java.net.URISyntaxException;
@@ -39,4 +39,4 @@ public class DefectDojoClientTest {
3939
```
4040

4141
## Testing a modified client
42-
To build a gradle project that depends on this client one can use `./gradlew build --include-build <path_to_this_folder>`. Gradle will then build the project with this local version of the the client.
42+
To build a gradle project that depends on this client one can use `./gradlew build --include-build <path_to_this_folder>`. Gradle will then build the project with this local version of the the client.

src/main/java/io/securecodebox/persistence/defectdojo/config/DefectDojoConfig.java renamed to src/main/java/io/securecodebox/persistence/defectdojo/config/Config.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
@Getter
1515
@ToString
1616
@AllArgsConstructor
17-
public class DefectDojoConfig {
17+
public class Config {
1818
private final String url;
1919

2020
private final String apiKey;
@@ -31,11 +31,11 @@ public class DefectDojoConfig {
3131
*/
3232
private final Long userId;
3333

34-
public DefectDojoConfig(String url, String apiKey, String username, int maxPageCountForGets) {
34+
public Config(String url, String apiKey, String username, int maxPageCountForGets) {
3535
this(url, apiKey, username, maxPageCountForGets, null);
3636
}
3737

38-
public static DefectDojoConfig fromEnv() {
38+
public static Config fromEnv() {
3939
String url = System.getenv("DEFECTDOJO_URL");
4040
String username = System.getenv("DEFECTDOJO_USERNAME");
4141
String apiKey = System.getenv("DEFECTDOJO_APIKEY");
@@ -45,6 +45,6 @@ public static DefectDojoConfig fromEnv() {
4545
if (System.getenv("DEFECTDOJO_MAX_PAGE_COUNT_FOR_GETS") != null) {
4646
maxPageCountForGets = Integer.parseInt(System.getenv("DEFECTDOJO_MAX_PAGE_COUNT_FOR_GETS"));
4747
}
48-
return new DefectDojoConfig(url, apiKey, username, maxPageCountForGets, userId);
48+
return new Config(url, apiKey, username, maxPageCountForGets, userId);
4949
}
5050
}

src/main/java/io/securecodebox/persistence/defectdojo/exception/DefectDojoLoopException.java renamed to src/main/java/io/securecodebox/persistence/defectdojo/exception/LoopException.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55

66
package io.securecodebox.persistence.defectdojo.exception;
77

8-
public class DefectDojoLoopException extends RuntimeException {
9-
public DefectDojoLoopException(String message) {
8+
public class LoopException extends RuntimeException {
9+
public LoopException(String message) {
1010
super(message);
1111
}
1212

13-
public DefectDojoLoopException(String message, Throwable cause) {
13+
public LoopException(String message, Throwable cause) {
1414
super(message, cause);
1515
}
1616
}

src/main/java/io/securecodebox/persistence/defectdojo/exception/DefectDojoPersistenceException.java renamed to src/main/java/io/securecodebox/persistence/defectdojo/exception/PersistenceException.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55

66
package io.securecodebox.persistence.defectdojo.exception;
77

8-
public class DefectDojoPersistenceException extends RuntimeException {
9-
public DefectDojoPersistenceException(String message) {
8+
public class PersistenceException extends RuntimeException {
9+
public PersistenceException(String message) {
1010
super(message);
1111
}
1212

13-
public DefectDojoPersistenceException(String message, Throwable cause) {
13+
public PersistenceException(String message, Throwable cause) {
1414
super(message, cause);
1515
}
1616
}

src/main/java/io/securecodebox/persistence/defectdojo/model/DefectDojoModel.java renamed to src/main/java/io/securecodebox/persistence/defectdojo/model/BaseModel.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
import lombok.EqualsAndHashCode;
1010

1111
@EqualsAndHashCode // FIXME: Implement hashCode/equals in inheritance is problematic (https://www.artima.com/articles/how-to-write-an-equality-method-in-java)
12-
abstract public class DefectDojoModel {
12+
// #FIXME: Should be package private because implementation detail
13+
abstract public class BaseModel {
1314
public abstract boolean equalsQueryString(Map<String, Object> queryParams);
1415
}

src/main/java/io/securecodebox/persistence/defectdojo/model/Endpoint.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
@AllArgsConstructor
1818
@EqualsAndHashCode(callSuper = true)
1919
@JsonInclude(JsonInclude.Include.NON_NULL)
20-
public class Endpoint extends DefectDojoModel {
20+
public class Endpoint extends BaseModel {
2121
@JsonProperty
2222
Long id;
2323

src/main/java/io/securecodebox/persistence/defectdojo/model/Engagement.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
@AllArgsConstructor
1919
@EqualsAndHashCode(callSuper = true)
2020
@JsonInclude(JsonInclude.Include.NON_NULL)
21-
public class Engagement extends DefectDojoModel {
21+
public class Engagement extends BaseModel {
2222
@JsonProperty("branch_tag")
2323
public String branch;
2424

src/main/java/io/securecodebox/persistence/defectdojo/model/Finding.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import com.fasterxml.jackson.annotation.JsonAlias;
99
import com.fasterxml.jackson.annotation.JsonInclude;
1010
import com.fasterxml.jackson.annotation.JsonProperty;
11-
import io.securecodebox.persistence.defectdojo.exception.DefectDojoPersistenceException;
11+
import io.securecodebox.persistence.defectdojo.exception.PersistenceException;
1212
import lombok.*;
1313

1414
import java.time.LocalDateTime;
@@ -22,7 +22,7 @@
2222
@AllArgsConstructor
2323
@EqualsAndHashCode(callSuper = true)
2424
@JsonInclude(JsonInclude.Include.NON_NULL)
25-
public class Finding extends DefectDojoModel {
25+
public class Finding extends BaseModel {
2626
@JsonProperty
2727
Long id;
2828

@@ -123,7 +123,7 @@ public String getNumericalSeverity() {
123123
case Informational:
124124
return "S4";
125125
default:
126-
throw new DefectDojoPersistenceException("Unknown severity: '" + this.severity + "'");
126+
throw new PersistenceException("Unknown severity: '" + this.severity + "'");
127127
}
128128
}
129129

src/main/java/io/securecodebox/persistence/defectdojo/model/DojoGroup.java renamed to src/main/java/io/securecodebox/persistence/defectdojo/model/Group.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
@AllArgsConstructor
1818
@EqualsAndHashCode(callSuper = true)
1919
@JsonInclude(JsonInclude.Include.NON_NULL)
20-
public class DojoGroup extends DefectDojoModel {
20+
public class Group extends BaseModel {
2121
@JsonProperty
2222
Long id;
2323

src/main/java/io/securecodebox/persistence/defectdojo/model/DojoGroupMember.java renamed to src/main/java/io/securecodebox/persistence/defectdojo/model/GroupMember.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
@AllArgsConstructor
1717
@EqualsAndHashCode(callSuper = true)
1818
@JsonInclude(JsonInclude.Include.NON_NULL)
19-
public class DojoGroupMember extends DefectDojoModel {
19+
public class GroupMember extends BaseModel {
2020
@JsonProperty
2121
Long id;
2222

0 commit comments

Comments
 (0)