Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration Parameter

Required / Optional / Default

Description

generateServiceObjects

false

Switch defines whether service objects should be generated or not.

generateServiceInterfaces

false

Switch defines whether service interfaces should be generated or not.

generateServiceProxies

false

Switch defines whether service proxies should be generated or not.

generateRESTResources

false

Switch defines whether REST resources should be generated or not.

generateSecurityAnnotation

false

Switch defines if target runtime specific security annotations (e.g. @RolesAllowed from JSR-250 or @Secured @PreAuthorize from Spring Security) should be generated or not.

useDeprecatedSpringSecuredAnnotation

false

Switch defines if in case of Spring deprecated @Secured annotation should be used instead of recommended @PreAuthorize.

generateRESTRequestValidation

false

Switch defines if request validation for REST Resources / Controllers or REST Clients (aka REST Service Proxies) should be generated. If it is enabled then the generated code will have a dependency on one of the following artifacts:

Spring Boot:

Code Block
languagexml
<dependency>
  <groupId>com.anaptecs.jeaf.validation</groupId>
  <artifactId>jeaf-validation-api-spring</artifactId>
  <version>${1.6.0 or higher}</version>
</dependency> 

JEAF:

Code Block
languagexml
<dependency>
  <groupId>com.anaptecs.jeaf.validation</groupId>
  <artifactId>jeaf-validation-api-service-provider</artifactId>
  <version>${1.6.0 or higher}</version>
</dependency> 

Depending on the implementation of class com.anaptecs.jeaf.validation.api.ValidationExecutor if might still be possible to disable / enable request validation without changing the code.

generateRESTResponseValidation

false

Switch defines if request validation for REST Resources / Controllers or REST Clients (aka REST Service Proxies) should be generated. If it is enabled then the generated code will have a dependency on one of the following artifacts:

Spring Boot:

Code Block
languagexml
<dependency>
  <groupId>com.anaptecs.jeaf.validation</groupId>
  <artifactId>jeaf-validation-api-spring</artifactId>
  <version>${1.6.0 or higher}</version>
</dependency>

JEAF:

Code Block
languagexml
<dependency>
  <groupId>com.anaptecs.jeaf.validation</groupId>
  <artifactId>jeaf-validation-api-service-provider</artifactId>
  <version>${1.6.0 or higher}</version>
</dependency> 

Depending on the implementation of class com.anaptecs.jeaf.validation.api.ValidationExecutor if might still be possible to disable / enable response validation without changing the code.

suppressTechnicalHeaders

false

Switch can be used to suppress technical http headers in generated Java code.

filterCustomHeaders

true

Switch defines whether custom headers of a REST resource should be filtered or not. Default is true. If custom header filtering is defined then a com.anaptecs.jeaf.rest.resource.api.CustomHeaderFilter has to be provided via configuration.t's strongly recommended to not use custom headers at all. However, if needed then at least they should be filtered.

restPathPrefix

optional

Parameter defines the prefix that should be used for REST paths of generated REST resources / controllers. The value provided here will be used as prefix. To be a valid path it has to start with '/' and must not end with '/'.

generateRESTServiceProxies

false

Switch defines whether REST service proxies should be generated or not.

generateRESTServiceProxyConfigFile

false

Switch defines whether a default config file for REST service proxies should be generated or not.

restDefaultSuccessStatusCode

200

Parameter can be used to define the default http status code that should be used when REST requests are successful. By default 200 ("OK") is used. This value will only be used if there is no explicit status code defined on the «RESTOperation».

restDefaultVoidStatusCode

204

Parameter can be used to define the default http status code that should be used when REST requests are successful for operations with return type void. By default 204 (NO_CONTENT) is used. This value will only be used if there is no explicit status code defined on the «RESTOperation».

generateExceptionClasses

false

Switch defines whether exception classes should be generated or not.

generateJUnitTests

false

Switch defines whether a JUnit test case for every service should be generated or not.

...