├── src ├── test │ ├── java │ │ └── com │ │ │ └── example │ │ │ ├── .gitkeep │ │ │ └── it │ │ │ ├── TaskRepositoryTest.java │ │ │ └── TaskResourceTest.java │ └── resources │ │ └── arquillian.xml └── main │ ├── java │ └── com │ │ └── example │ │ ├── infrastructure │ │ ├── package-info.java │ │ └── persistence │ │ │ └── jpa │ │ │ ├── AbstractRepository.java │ │ │ └── JpaTaskRepository.java │ │ ├── interfaces │ │ ├── RestActivator.java │ │ ├── common │ │ │ ├── cors │ │ │ │ ├── package-info.java │ │ │ │ ├── CorsFeature.java │ │ │ │ ├── CorsHeaders.java │ │ │ │ └── CorsFilter.java │ │ │ ├── PagedResult.java │ │ │ ├── PageParam.java │ │ │ ├── exceptionMapper │ │ │ │ └── ConstraintViolationExceptionMapper.java │ │ │ └── PrimitiveConverterProvider.java │ │ └── task │ │ │ ├── UpdateStatusRequest.java │ │ │ ├── TaskNotFoundException.java │ │ │ ├── UpdateTaskCommand.java │ │ │ ├── CreateTaskCommand.java │ │ │ ├── TaskNotFoundExceptionMapper.java │ │ │ ├── TaskResources.java │ │ │ └── TaskResource.java │ │ ├── domain │ │ ├── common │ │ │ ├── Username.java │ │ │ ├── Boolean2StringConverter.java │ │ │ ├── AbstractEntity.java │ │ │ ├── AuditingEntityListener.java │ │ │ └── AbstractAuditableEntity.java │ │ └── task │ │ │ ├── TaskRepository.java │ │ │ └── Task.java │ │ └── application │ │ └── util │ │ ├── LoggerProducer.java │ │ └── SampleDataPopulator.java │ ├── webapp │ └── WEB-INF │ │ └── beans.xml │ └── resources │ └── META-INF │ ├── orm.xml │ └── persistence.xml ├── .gitignore ├── .github ├── workflows │ ├── build.yml │ └── dependabot-automerge.yml ├── ISSUE_TEMPLATE │ └── bug_report.md └── dependabot.yml ├── README.md ├── pom.xml └── LICENSE /src/test/java/com/example/.gitkeep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target/ 2 | /.idea 3 | *.iml 4 | -------------------------------------------------------------------------------- /src/main/java/com/example/infrastructure/package-info.java: -------------------------------------------------------------------------------- 1 | /** 2 | * The infrastructure codes. 3 | */ 4 | package com.example.infrastructure; -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/RestActivator.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces; 2 | 3 | import jakarta.ws.rs.ApplicationPath; 4 | import jakarta.ws.rs.core.Application; 5 | 6 | @ApplicationPath("api") 7 | public class RestActivator extends Application { 8 | 9 | } 10 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/common/cors/package-info.java: -------------------------------------------------------------------------------- 1 | /** 2 | * The `CorsFilter` is copied from Resteasy and do some small modifications. 3 | * 4 | * Use the restesy built-in one instead if you are using Resteasy. 5 | */ 6 | package com.example.interfaces.common.cors; -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/task/UpdateStatusRequest.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.task; 2 | 3 | import jakarta.validation.constraints.NotBlank; 4 | 5 | 6 | public record UpdateStatusRequest( 7 | @NotBlank 8 | String status 9 | ) { 10 | 11 | } 12 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/task/TaskNotFoundException.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.task; 2 | 3 | public class TaskNotFoundException extends RuntimeException { 4 | 5 | public TaskNotFoundException(Long postId) { 6 | super(String.format("post id:%s not found!", postId)); 7 | } 8 | 9 | } 10 | -------------------------------------------------------------------------------- /src/main/webapp/WEB-INF/beans.xml: -------------------------------------------------------------------------------- 1 | 2 | 6 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/common/PagedResult.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.common; 2 | 3 | import java.util.List; 4 | 5 | 6 | public record PagedResult( 7 | List content, 8 | long count 9 | ) { 10 | public static PagedResult of(List content, long count) { 11 | return new PagedResult<>(content, count); 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/task/UpdateTaskCommand.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.task; 2 | 3 | import jakarta.validation.constraints.NotBlank; 4 | import jakarta.validation.constraints.Size; 5 | 6 | public record UpdateTaskCommand( 7 | @NotBlank 8 | String name, 9 | 10 | @NotBlank 11 | @Size(min = 10, max = 2000) 12 | String description 13 | ) { 14 | 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/task/CreateTaskCommand.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.task; 2 | 3 | import jakarta.validation.constraints.NotBlank; 4 | import jakarta.validation.constraints.Size; 5 | 6 | public record CreateTaskCommand( 7 | @NotBlank 8 | String name, 9 | 10 | @NotBlank 11 | @Size(min = 10, max = 2000) 12 | String description 13 | ) { 14 | 15 | } 16 | -------------------------------------------------------------------------------- /src/main/java/com/example/domain/common/Username.java: -------------------------------------------------------------------------------- 1 | /* 2 | * To change this license header, choose License Headers in Project Properties. 3 | * To change this template file, choose Tools | Templates 4 | * and open the template in the editor. 5 | */ 6 | package com.example.domain.common; 7 | 8 | import jakarta.persistence.Embeddable; 9 | 10 | /** 11 | * @author hantsy 12 | */ 13 | @Embeddable 14 | public record Username( 15 | String username 16 | ){} 17 | -------------------------------------------------------------------------------- /src/main/java/com/example/application/util/LoggerProducer.java: -------------------------------------------------------------------------------- 1 | package com.example.application.util; 2 | 3 | import java.util.logging.Logger; 4 | import jakarta.enterprise.context.Dependent; 5 | import jakarta.enterprise.inject.Produces; 6 | import jakarta.enterprise.inject.spi.InjectionPoint; 7 | 8 | /** 9 | * 10 | * @author hantsy 11 | */ 12 | @Dependent 13 | public class LoggerProducer { 14 | 15 | @Produces 16 | public Logger getLogger(InjectionPoint p) { 17 | return Logger.getLogger(p.getMember().getDeclaringClass().getName()); 18 | } 19 | 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/com/example/domain/common/Boolean2StringConverter.java: -------------------------------------------------------------------------------- 1 | package com.example.domain.common; 2 | 3 | import jakarta.persistence.AttributeConverter; 4 | import jakarta.persistence.Converter; 5 | 6 | @Converter(autoApply = true) 7 | public class Boolean2StringConverter implements AttributeConverter { 8 | 9 | @Override 10 | public String convertToDatabaseColumn(Boolean attribute) { 11 | return attribute ? "on" : "off"; 12 | } 13 | 14 | @Override 15 | public Boolean convertToEntityAttribute(String dbData) { 16 | return "on".equals(dbData) || Boolean.parseBoolean(dbData) || Boolean.FALSE; 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/example/domain/task/TaskRepository.java: -------------------------------------------------------------------------------- 1 | package com.example.domain.task; 2 | 3 | import java.util.List; 4 | import java.util.Optional; 5 | 6 | public interface TaskRepository { 7 | long countByKeyword(String keyword, Task.Status status); 8 | 9 | List searchByKeyword(String keyword, 10 | Task.Status status, 11 | int offset, 12 | int limit); 13 | 14 | List findByCreatedBy(String name); 15 | 16 | Task save(Task task); 17 | 18 | Optional findOptionalById(Long id); 19 | 20 | boolean delete(Task task); 21 | } 22 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/common/cors/CorsFeature.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.common.cors; 2 | 3 | import jakarta.ws.rs.core.Feature; 4 | import jakarta.ws.rs.core.FeatureContext; 5 | import jakarta.ws.rs.ext.Provider; 6 | import java.util.Set; 7 | 8 | /** 9 | * Activate CorsFilter. 10 | */ 11 | @Provider 12 | public class CorsFeature implements Feature { 13 | 14 | @Override 15 | public boolean configure(FeatureContext context) { 16 | CorsFilter corsFilter = new CorsFilter(); 17 | corsFilter.getAllowedOrigins().addAll(Set.of("http://localhost:4200")); 18 | context.register(corsFilter); 19 | return true; 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: build 2 | 3 | on: 4 | push: 5 | paths-ignore: 6 | - "docs/**" 7 | branches: 8 | - master 9 | pull_request: 10 | types: 11 | - opened 12 | - synchronize 13 | - reopened 14 | 15 | jobs: 16 | build: 17 | runs-on: ubuntu-latest 18 | 19 | steps: 20 | - uses: actions/checkout@v6 21 | - name: Set up JDK 22 | uses: actions/setup-java@v5 23 | with: 24 | java-version: '21' 25 | distribution: 'adopt' 26 | cache: 'maven' 27 | 28 | - name: Run integration test with -Parq-glassfish-managed 29 | run: mvn clean verify -Parq-glassfish-managed 30 | -------------------------------------------------------------------------------- /src/test/resources/arquillian.xml: -------------------------------------------------------------------------------- 1 | 4 | 5 | 6 | 7 | domain1 8 | admin 9 | 10 | ${enableDerby:true} 11 | 12 | 13 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/orm.xml: -------------------------------------------------------------------------------- 1 | 2 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /src/main/resources/META-INF/persistence.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | java:comp/DefaultDataSource 7 | false 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: bug 6 | assignees: hantsy 7 | 8 | --- 9 | 10 | Firstly make sure you are using Java 8 and Maven 3.1+ for building this project. 11 | 12 | **Describe the bug** 13 | A clear and concise description of what the bug is. 14 | 15 | **To Reproduce** 16 | Steps to reproduce the behavior: 17 | 1. Go to '...' 18 | 2. Click on '....' 19 | 3. Scroll down to '....' 20 | 4. See error 21 | 22 | **Expected behavior** 23 | A clear and concise description of what you expected to happen. 24 | 25 | **Screenshots** 26 | If applicable, add screenshots to help explain your problem. 27 | 28 | **Additional context** 29 | Add any other context about the problem here. 30 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/task/TaskNotFoundExceptionMapper.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.task; 2 | 3 | import jakarta.inject.Inject; 4 | import jakarta.ws.rs.core.Response; 5 | import jakarta.ws.rs.ext.ExceptionMapper; 6 | import jakarta.ws.rs.ext.Provider; 7 | import java.util.logging.Level; 8 | import java.util.logging.Logger; 9 | 10 | /** 11 | * @author hantsy 12 | */ 13 | @Provider 14 | public class TaskNotFoundExceptionMapper implements ExceptionMapper { 15 | 16 | @Inject 17 | Logger log; 18 | 19 | @Override 20 | public Response toResponse(TaskNotFoundException exception) { 21 | log.log(Level.INFO, "handling exception : PostNotFoundException"); 22 | 23 | return Response.status(Response.Status.NOT_FOUND) 24 | .header("Content-Type", "application/json") 25 | .entity(exception.getMessage()) 26 | .build(); 27 | } 28 | 29 | } 30 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/common/cors/CorsHeaders.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.common.cors; 2 | 3 | public class CorsHeaders 4 | { 5 | public static final String ACCESS_CONTROL_ALLOW_ORIGIN = "Access-Control-Allow-Origin"; 6 | public static final String ACCESS_CONTROL_ALLOW_CREDENTIALS = "Access-Control-Allow-Credentials"; 7 | public static final String ACCESS_CONTROL_ALLOW_METHODS = "Access-Control-Allow-Methods"; 8 | public static final String ACCESS_CONTROL_ALLOW_HEADERS = "Access-Control-Allow-Headers"; 9 | public static final String ACCESS_CONTROL_MAX_AGE = "Access-Control-Max-Age"; 10 | public static final String ORIGIN = "Origin"; 11 | public static final String ACCESS_CONTROL_REQUEST_METHOD = "Access-Control-Request-Method"; 12 | public static final String ACCESS_CONTROL_EXPOSE_HEADERS = "Access-Control-Expose-Headers"; 13 | public static final String ACCESS_CONTROL_REQUEST_HEADERS = "Access-Control-Request-Headers"; 14 | public static final String VARY = "Vary"; 15 | } -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: github-actions 4 | directory: "/" 5 | schedule: 6 | interval: weekly 7 | # time: "21:00" 8 | - package-ecosystem: maven 9 | directory: "/" 10 | schedule: 11 | interval: weekly 12 | time: "21:00" 13 | open-pull-requests-limit: 10 14 | # Overwrite any ignores created using `@dependabot ignore` commands 15 | ignore: 16 | # # Ignore updates to packages that start 'aws' 17 | # # Wildcards match zero or more arbitrary characters 18 | # #- dependency-name: "aws*" 19 | # # Ignore some updates to the 'resteasy' package 20 | # - dependency-name: "resteasy" 21 | # # Ignore only new versions for 4.x 22 | # versions: ["3.x, 4.x"] 23 | # - dependency-name: "jakarta.jakartaee-api" 24 | - dependency-name: "org.glassfish.*" 25 | versions: ["10.0.0-jdk17-M10"] 26 | # - dependency-name: "jersey" 27 | # - dependency-name: "eclipselink" 28 | # - dependency-name: "org.glassfish.jaxb:jaxb-runtime" 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /.github/workflows/dependabot-automerge.yml: -------------------------------------------------------------------------------- 1 | name: Dependabot auto-merge 2 | on: 3 | pull_request: 4 | types: 5 | - opened 6 | - synchronize 7 | - reopened 8 | workflow_run: 9 | workflows: ["build"] 10 | types: 11 | - completed 12 | permissions: 13 | pull-requests: write 14 | contents: write 15 | 16 | jobs: 17 | dependabot: 18 | runs-on: ubuntu-latest 19 | if: ${{ github.actor == 'dependabot[bot]' }} && ${{ github.event.workflow_run.conclusion == 'success' }} 20 | steps: 21 | - name: Dependabot metadata 22 | id: metadata 23 | uses: dependabot/fetch-metadata@v2.4.0 24 | with: 25 | github-token: "${{ secrets.GITHUB_TOKEN }}" 26 | - name: Enable auto-merge for Dependabot PRs 27 | # if: ${{contains(steps.metadata.outputs.dependency-names, 'my-dependency') && steps.metadata.outputs.update-type == 'version-update:semver-patch'}} 28 | run: gh pr merge --auto --merge "$PR_URL" 29 | env: 30 | PR_URL: ${{github.event.pull_request.html_url}} 31 | GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} 32 | -------------------------------------------------------------------------------- /src/main/java/com/example/domain/common/AbstractEntity.java: -------------------------------------------------------------------------------- 1 | /* 2 | * To change this license header, choose License Headers in Project Properties. 3 | * To change this template file, choose Tools | Templates 4 | * and open the template in the editor. 5 | */ 6 | package com.example.domain.common; 7 | 8 | import jakarta.persistence.*; 9 | 10 | import java.io.Serializable; 11 | 12 | /** 13 | * @author hantsy 14 | */ 15 | @MappedSuperclass 16 | public class AbstractEntity implements Serializable { 17 | 18 | private static final long serialVersionUID = 1L; 19 | 20 | @Id 21 | @GeneratedValue(strategy = GenerationType.AUTO) 22 | @Column(name = "id") 23 | private ID id; 24 | 25 | @Version 26 | @Column(name = "version") 27 | private Long version; 28 | 29 | public ID getId() { 30 | return id; 31 | } 32 | 33 | public void setId(ID id) { 34 | this.id = id; 35 | } 36 | 37 | public Long getVersion() { 38 | return version; 39 | } 40 | 41 | public void setVersion(Long version) { 42 | this.version = version; 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/common/PageParam.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.common; 2 | 3 | import jakarta.ws.rs.DefaultValue; 4 | import jakarta.ws.rs.QueryParam; 5 | 6 | 7 | public class PageParam { 8 | @QueryParam("offset") 9 | @DefaultValue("0") 10 | private int offset; 11 | 12 | @QueryParam("limit") 13 | @DefaultValue("10") 14 | private int limit; 15 | 16 | public int getOffset() { 17 | return offset; 18 | } 19 | 20 | public void setOffset(int offset) { 21 | this.offset = offset; 22 | } 23 | 24 | public int getLimit() { 25 | return limit; 26 | } 27 | 28 | public void setLimit(int limit) { 29 | this.limit = limit; 30 | } 31 | 32 | @Override 33 | public String toString() { 34 | return "PageParam{" + 35 | "offset=" + offset + 36 | ", limit=" + limit + 37 | '}'; 38 | } 39 | } 40 | // see: https://github.com/jakartaee/rest/issues/1300s 41 | /* 42 | public record PageParam( 43 | @QueryParam("offset") 44 | @DefaultValue("0") 45 | int offset, 46 | 47 | @QueryParam("limit") 48 | @DefaultValue("10") 49 | int limit 50 | ) { 51 | }*/ 52 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/common/exceptionMapper/ConstraintViolationExceptionMapper.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.common.exceptionMapper; 2 | 3 | import jakarta.validation.ConstraintViolationException; 4 | import jakarta.validation.Path; 5 | import jakarta.ws.rs.core.Response; 6 | import jakarta.ws.rs.ext.ExceptionMapper; 7 | import jakarta.ws.rs.ext.Provider; 8 | import java.util.HashMap; 9 | import java.util.Iterator; 10 | import java.util.Map; 11 | 12 | import static jakarta.ws.rs.core.Response.status; 13 | 14 | @Provider 15 | public class ConstraintViolationExceptionMapper implements ExceptionMapper { 16 | 17 | @Override 18 | public Response toResponse(ConstraintViolationException exception) { 19 | Map errors = new HashMap<>(); 20 | exception.getConstraintViolations() 21 | .forEach(v -> errors.put(lastFieldName(v.getPropertyPath().iterator()), v.getMessage())); 22 | return status(Response.Status.BAD_REQUEST).entity(errors).build(); 23 | } 24 | 25 | private String lastFieldName(Iterator nodes) { 26 | Path.Node last = null; 27 | while (nodes.hasNext()) { 28 | last = nodes.next(); 29 | } 30 | return last.getName(); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/com/example/domain/common/AuditingEntityListener.java: -------------------------------------------------------------------------------- 1 | /* 2 | * To change this license header, choose License Headers in Project Properties. 3 | * To change this template file, choose Tools | Templates 4 | * and open the template in the editor. 5 | */ 6 | package com.example.domain.common; 7 | 8 | 9 | import jakarta.persistence.PrePersist; 10 | import jakarta.persistence.PreUpdate; 11 | 12 | import java.time.LocalDateTime; 13 | import java.util.logging.Level; 14 | import java.util.logging.Logger; 15 | 16 | /** 17 | * @author hantsy 18 | */ 19 | public class AuditingEntityListener { 20 | 21 | private static final Logger LOG = Logger.getLogger(AuditingEntityListener.class.getName()); 22 | 23 | @PrePersist 24 | public void beforePersist(Object entity) { 25 | LOG.log(Level.INFO, "before persist: {0}", new Object[]{entity}); 26 | if (entity instanceof AbstractAuditableEntity o) { 27 | final LocalDateTime now = LocalDateTime.now(); 28 | o.setCreatedDate(now); 29 | o.setLastModifiedDate(now); 30 | } 31 | } 32 | 33 | @PreUpdate 34 | public void beforeUpdate(Object entity) { 35 | LOG.log(Level.INFO, "before update: {0}", new Object[]{entity}); 36 | if (entity instanceof AbstractAuditableEntity o) { 37 | o.setLastModifiedDate(LocalDateTime.now()); 38 | } 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/main/java/com/example/application/util/SampleDataPopulator.java: -------------------------------------------------------------------------------- 1 | package com.example.application.util; 2 | 3 | import com.example.domain.task.Task; 4 | import com.example.domain.task.TaskRepository; 5 | import jakarta.enterprise.context.ApplicationScoped; 6 | import jakarta.enterprise.event.Observes; 7 | import jakarta.enterprise.event.Startup; 8 | import jakarta.inject.Inject; 9 | import jakarta.persistence.EntityManager; 10 | import jakarta.persistence.PersistenceContext; 11 | import jakarta.transaction.Transactional; 12 | 13 | import java.util.logging.Level; 14 | import java.util.logging.Logger; 15 | import java.util.stream.Stream; 16 | 17 | /** 18 | * @author hantsy 19 | */ 20 | @ApplicationScoped 21 | @Transactional 22 | public class SampleDataPopulator { 23 | 24 | @Inject 25 | Logger LOG; 26 | 27 | @Inject 28 | TaskRepository tasks; 29 | 30 | @PersistenceContext 31 | EntityManager entityManager; 32 | 33 | public void init(@Observes Startup startup) { 34 | initTasks(); 35 | } 36 | 37 | public void initTasks() { 38 | LOG.log(Level.INFO, " >> initializing tasks ..."); 39 | 40 | var deleted = this.entityManager.createQuery("delete from Task").executeUpdate(); 41 | LOG.log(Level.INFO, " deleted existed tasks: {0}", new Object[]{deleted}); 42 | 43 | Stream.of("first", "second") 44 | .map(s -> { 45 | Task task = new Task(); 46 | task.setName("My " + s + " task"); 47 | task.setDescription("The description of my " + s + " task"); 48 | task.setStatus(Task.Status.TODO); 49 | return task; 50 | }) 51 | .map(data -> tasks.save(data)) 52 | .toList() 53 | .forEach(task -> LOG.log(Level.INFO, "saved task: {0}", new Object[]{task})); 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/common/PrimitiveConverterProvider.java: -------------------------------------------------------------------------------- 1 | /* 2 | * To change this license header, choose License Headers in Project Properties. 3 | * To change this template file, choose Tools | Templates 4 | * and open the template in the editor. 5 | */ 6 | package com.example.interfaces.common; 7 | 8 | import java.lang.annotation.Annotation; 9 | import java.lang.reflect.Type; 10 | import jakarta.ws.rs.ext.ParamConverter; 11 | import jakarta.ws.rs.ext.ParamConverterProvider; 12 | import jakarta.ws.rs.ext.Provider; 13 | 14 | @Provider 15 | public class PrimitiveConverterProvider implements ParamConverterProvider { 16 | 17 | @Override 18 | public ParamConverter getConverter(Class rawType, Type genericType, Annotation[] annotations) { 19 | 20 | if (rawType.getName().equals(boolean.class.getName())) { 21 | 22 | return new ParamConverter() { 23 | @Override 24 | public T fromString(String value) { 25 | return (T) Boolean.valueOf(value != null && value.equals("on")); 26 | } 27 | 28 | @Override 29 | public String toString(T value) { 30 | return ((Boolean) value) ? "on" : ""; 31 | } 32 | }; 33 | 34 | } else if (rawType.getName().equals(int.class.getName())) { 35 | 36 | return new ParamConverter() { 37 | @Override 38 | public T fromString(String value) { 39 | 40 | try { 41 | return (T) (Integer) Integer.parseInt(value); 42 | } catch (NumberFormatException e) { 43 | } 44 | 45 | return (T) (Integer) 0; 46 | } 47 | 48 | @Override 49 | public String toString(T value) { 50 | return "" + value; 51 | } 52 | }; 53 | 54 | } else { 55 | return null; 56 | } 57 | } 58 | } 59 | -------------------------------------------------------------------------------- /src/main/java/com/example/domain/common/AbstractAuditableEntity.java: -------------------------------------------------------------------------------- 1 | /* 2 | * To change this license header, choose License Headers in Project Properties. 3 | * To change this template file, choose Tools | Templates 4 | * and open the template in the editor. 5 | */ 6 | package com.example.domain.common; 7 | 8 | import jakarta.persistence.AttributeOverride; 9 | import jakarta.persistence.Column; 10 | import jakarta.persistence.MappedSuperclass; 11 | 12 | import java.time.LocalDateTime; 13 | 14 | /** 15 | * @param 16 | * @author hantsy 17 | */ 18 | @MappedSuperclass 19 | // applied it in orm.xml instead. 20 | //@EntityListeners(AuditEntityListener.class) 21 | public class AbstractAuditableEntity extends AbstractEntity { 22 | 23 | private static final long serialVersionUID = 1L; 24 | 25 | @Column(name = "created_at") 26 | private LocalDateTime createdDate; 27 | 28 | @Column(name = "last_modified_at") 29 | private LocalDateTime lastModifiedDate; 30 | 31 | @AttributeOverride(name = "username", column = @Column(name = "created_by")) 32 | private Username createdBy; 33 | 34 | @AttributeOverride(name = "username", column = @Column(name = "last_modified_by")) 35 | private Username lastModifiedBy; 36 | 37 | public LocalDateTime getCreatedDate() { 38 | return createdDate; 39 | } 40 | 41 | public void setCreatedDate(LocalDateTime createdDate) { 42 | this.createdDate = createdDate; 43 | } 44 | 45 | public LocalDateTime getLastModifiedDate() { 46 | return lastModifiedDate; 47 | } 48 | 49 | public void setLastModifiedDate(LocalDateTime lastModifiedDate) { 50 | this.lastModifiedDate = lastModifiedDate; 51 | } 52 | 53 | public Username getCreatedBy() { 54 | return createdBy; 55 | } 56 | 57 | public void setCreatedBy(Username createdBy) { 58 | this.createdBy = createdBy; 59 | } 60 | 61 | public Username getLastModifiedBy() { 62 | return lastModifiedBy; 63 | } 64 | 65 | public void setLastModifiedBy(Username lastModifiedBy) { 66 | this.lastModifiedBy = lastModifiedBy; 67 | } 68 | } 69 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Jakarta REST Example 2 | 3 | [![build](https://github.com/hantsy/jakartaee-rest-sample/actions/workflows/build.yml/badge.svg)](https://github.com/hantsy/jakartaee-rest-sample/actions/workflows/build.yml) 4 | 5 | The repository has already been upgraded to Jakarta EE 11. 6 | 7 | * For the Jakarta EE 10 version, please check the [EE10 archive](https://github.com/hantsy/jakartaee-rest-sample/releases/tag/ee10) or [EE10 tag](https://github.com/hantsy/jakartaee-rest-sample/tree/ee10). 8 | * For the Jakarta EE 8 version, please check the [EE8 archive](https://github.com/hantsy/jakartaee-rest-sample/releases/tag/1.0.0) and [EE8 tag](https://github.com/hantsy/jakartaee-rest-sample/tree/1.0.0). 9 | 10 | For the example projects before Jakarta EE 8, check the following repositories instead. 11 | 12 | * [Java EE 8 Jaxrs Sample](https://github.com/hantsy/javaee8-jaxrs-sample) 13 | * [Java EE 7 Jaxrs Sample](https://github.com/hantsy/ee7-jaxrs-sample) 14 | 15 | Compared to the previous Jakarta EE 10 version, the following changes are applied: 16 | 17 | * Update Jakarta EE API to 11.0.0 and Glassfish to 8.0.0 18 | * Replace all EJB codes with pure CDI codes 19 | * Use record type as possible 20 | 21 | ## Prerequisites 22 | 23 | * Java 21 24 | * The latest Apache Maven 3.x or 4.x 25 | 26 | ## Build 27 | 28 | 1. Clone a copy of the source codes. 29 | 30 | ```bash 31 | git clone https://github.com/hantsy/jakartaee-jaxrs-sample 32 | ``` 33 | 34 | 2. Run on Glassfish. 35 | 36 | ```bash 37 | mvn clean package cargo:run -Pglassfish 38 | ``` 39 | 40 | 3. Run Integration Tests against Arquillian Glassfish Managed Adapter 41 | 42 | ```bash 43 | mvn clean verify -Parq-glassfish-managed 44 | ``` 45 | 46 | ## Reference 47 | 48 | * [Securing JAX-RS Endpoints with JWT](https://antoniogoncalves.org/2016/10/03/securing-jax-rs-endpoints-with-jwt/) 49 | * [Java EE Security Essentials](https://dzone.com/refcardz/getting-started-java-ee?chapter=1) 50 | * [JAX-RS, JWT & a pinch of JSR 375](https://abhirockzz.wordpress.com/2016/03/21/jax-rs-jwt-a-pinch-of-jsr-375/) 51 | * [JSON Web Token in action with JAX-RS](https://abhirockzz.wordpress.com/2016/03/18/json-web-token-in-action-with-jax-rs/) 52 | * [Java Magazine Hub](https://java-magazine-hub.zeef.com/) 53 | * [Efficient JAX-RS: Conditional GETs & PUTs](https://abhirockzz.wordpress.com/2016/03/27/efficient-jax-rs-conditional-gets-puts/) 54 | * [Java EE Security API - Soteria](https://www.n-k.de/2018/07/java-ee-security-api-jsr-375-soteria.html) 55 | 56 | 57 | -------------------------------------------------------------------------------- /src/test/java/com/example/it/TaskRepositoryTest.java: -------------------------------------------------------------------------------- 1 | package com.example.it; 2 | 3 | import com.example.domain.common.AbstractEntity; 4 | import com.example.domain.task.Task; 5 | import com.example.domain.task.TaskRepository; 6 | import com.example.infrastructure.persistence.jpa.AbstractRepository; 7 | import com.example.infrastructure.persistence.jpa.JpaTaskRepository; 8 | import jakarta.inject.Inject; 9 | import jakarta.persistence.EntityManager; 10 | import jakarta.persistence.PersistenceContext; 11 | import org.jboss.arquillian.container.test.api.Deployment; 12 | import org.jboss.arquillian.junit5.ArquillianExtension; 13 | import org.jboss.shrinkwrap.api.ShrinkWrap; 14 | import org.jboss.shrinkwrap.api.spec.JavaArchive; 15 | import org.junit.jupiter.api.AfterEach; 16 | import org.junit.jupiter.api.BeforeEach; 17 | import org.junit.jupiter.api.Test; 18 | import org.junit.jupiter.api.extension.ExtendWith; 19 | 20 | import java.util.logging.Level; 21 | import java.util.logging.Logger; 22 | 23 | import static org.junit.jupiter.api.Assertions.assertEquals; 24 | 25 | 26 | @ExtendWith(ArquillianExtension.class) 27 | public class TaskRepositoryTest { 28 | private static final Logger LOGGER = Logger.getLogger(TaskRepositoryTest.class.getName()); 29 | 30 | @Deployment() 31 | public static JavaArchive createDeployment() { 32 | JavaArchive jar = ShrinkWrap.create(JavaArchive.class, "test.jar") 33 | .addPackage(AbstractEntity.class.getPackage()) 34 | .addPackage(Task.class.getPackage()) 35 | .addClass(JpaTaskRepository.class).addClass(AbstractRepository.class) 36 | //Add JPA persistence configuration. 37 | //WARN: In a jar archive, persistence.xml should be put into /META-INF 38 | .addAsManifestResource("META-INF/persistence.xml", "persistence.xml"); 39 | 40 | LOGGER.log(Level.INFO, "deployment unit: {0}", jar.toString(true)); 41 | 42 | return jar; 43 | } 44 | 45 | @Inject 46 | TaskRepository tasks; 47 | 48 | @PersistenceContext 49 | EntityManager em; 50 | 51 | Task saved; 52 | 53 | @BeforeEach 54 | public void setup() { 55 | saved = tasks.save(Task.of("test task", "desc of test task")); 56 | } 57 | 58 | @AfterEach 59 | public void teardown() { 60 | tasks.delete(saved); 61 | } 62 | 63 | @Test 64 | public void shouldCreated() { 65 | Task found = em.find(Task.class, saved.getId()); 66 | 67 | assertEquals("test task", found.getName(), "name is 'test task'"); 68 | assertEquals("desc of test task", found.getDescription(), "description is 'desc of test task'"); 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/task/TaskResources.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.task; 2 | 3 | import com.example.domain.task.TaskRepository; 4 | import com.example.interfaces.common.PageParam; 5 | import com.example.domain.task.Task; 6 | import com.example.interfaces.common.PagedResult; 7 | 8 | import jakarta.annotation.PostConstruct; 9 | import jakarta.enterprise.context.RequestScoped; 10 | import jakarta.inject.Inject; 11 | import jakarta.validation.Valid; 12 | import jakarta.ws.rs.*; 13 | import jakarta.ws.rs.container.ResourceContext; 14 | import jakarta.ws.rs.core.Context; 15 | import jakarta.ws.rs.core.MediaType; 16 | import jakarta.ws.rs.core.Response; 17 | import jakarta.ws.rs.core.UriInfo; 18 | import java.util.List; 19 | import java.util.logging.Level; 20 | import java.util.logging.Logger; 21 | 22 | import static jakarta.ws.rs.core.Response.*; 23 | 24 | @Path("tasks") 25 | @RequestScoped 26 | public class TaskResources { 27 | 28 | @Inject 29 | Logger log; 30 | 31 | @Inject 32 | TaskRepository taskRepository; 33 | 34 | @Context 35 | ResourceContext resourceContext; 36 | 37 | @Context 38 | UriInfo uriInfo; 39 | 40 | @GET 41 | @Produces(MediaType.APPLICATION_JSON) 42 | public Response allTasks( 43 | @QueryParam("q") String keyword, 44 | @QueryParam("status") String status, 45 | @BeanParam PageParam page 46 | ) { 47 | log.log(Level.INFO, "fetching all tasks, keyword: {0} status:{1}", new Object[]{keyword, status}); 48 | 49 | Task.Status taskStatus; 50 | try { 51 | taskStatus = Task.Status.valueOf(status); 52 | } catch (Exception e) { 53 | log.log(Level.SEVERE, "can not parse task status value:{0}", status); 54 | taskStatus = null; 55 | } 56 | 57 | List tasks = taskRepository.searchByKeyword(keyword, taskStatus, page.getOffset(), page.getLimit()); 58 | long count = taskRepository.countByKeyword(keyword, taskStatus); 59 | return ok(PagedResult.of(tasks, count)).build(); 60 | } 61 | 62 | 63 | @POST 64 | @Consumes(MediaType.APPLICATION_JSON) 65 | public Response save(@Valid CreateTaskCommand form) { 66 | log.log(Level.INFO, "saving new task @{0}", form); 67 | 68 | Task task = new Task(); 69 | task.setName(form.name()); 70 | task.setDescription(form.description()); 71 | 72 | Task saved = taskRepository.save(task); 73 | 74 | return created(uriInfo.getBaseUriBuilder().path("/tasks/{id}").build(saved.getId())).build(); 75 | } 76 | 77 | @Path("{id}") 78 | public TaskResource taskResource() { 79 | return resourceContext.getResource(TaskResource.class); 80 | } 81 | 82 | 83 | @PostConstruct 84 | private void init() { 85 | log.config(() -> this.getClass().getSimpleName() + " created"); 86 | } 87 | } 88 | -------------------------------------------------------------------------------- /src/main/java/com/example/infrastructure/persistence/jpa/AbstractRepository.java: -------------------------------------------------------------------------------- 1 | /* 2 | * To change this license header, choose License Headers in Project Properties. 3 | * To change this template file, choose Tools | Templates 4 | * and open the template in the editor. 5 | */ 6 | package com.example.infrastructure.persistence.jpa; 7 | 8 | import com.example.domain.common.AbstractEntity; 9 | 10 | import jakarta.persistence.EntityManager; 11 | import jakarta.persistence.criteria.CriteriaBuilder; 12 | import jakarta.persistence.criteria.CriteriaDelete; 13 | import jakarta.persistence.criteria.CriteriaQuery; 14 | import jakarta.persistence.criteria.Root; 15 | import java.lang.reflect.ParameterizedType; 16 | import java.util.List; 17 | import java.util.Optional; 18 | import java.util.stream.Stream; 19 | 20 | /** 21 | * @param Entity type. 22 | * @param Entity ID type. 23 | * @author hantsy 24 | */ 25 | public abstract class AbstractRepository, ID> { 26 | 27 | protected abstract EntityManager entityManager(); 28 | 29 | private Class entityClass() { 30 | @SuppressWarnings("unchecked") 31 | ParameterizedType parameterizedType = (ParameterizedType) this.getClass().getGenericSuperclass(); 32 | return (Class) parameterizedType.getActualTypeArguments()[0]; 33 | } 34 | 35 | public List findAll() { 36 | 37 | CriteriaBuilder cb = this.entityManager().getCriteriaBuilder(); 38 | 39 | CriteriaQuery q = cb.createQuery(entityClass()); 40 | Root c = q.from(entityClass()); 41 | 42 | return entityManager().createQuery(q).getResultList(); 43 | } 44 | 45 | public T save(T entity) { 46 | if (entity.getId() == null) { 47 | entityManager().persist(entity); 48 | 49 | return entity; 50 | } else { 51 | return entityManager().merge(entity); 52 | } 53 | } 54 | 55 | public T findById(ID id) { 56 | return entityManager().find(entityClass(), id); 57 | } 58 | 59 | public boolean delete(T entity) { 60 | T _entity = entityManager().merge(entity); 61 | entityManager().remove(_entity); 62 | return true; 63 | } 64 | 65 | public int deleteAll() { 66 | CriteriaBuilder cb = this.entityManager().getCriteriaBuilder(); 67 | CriteriaDelete q = cb.createCriteriaDelete(entityClass()); 68 | return entityManager().createQuery(q).executeUpdate(); 69 | } 70 | 71 | public int deleteById(ID id) { 72 | CriteriaBuilder cb = this.entityManager().getCriteriaBuilder(); 73 | CriteriaDelete q = cb.createCriteriaDelete(entityClass()); 74 | Root c = q.from(entityClass()); 75 | q.where(cb.equal(c.get("id"), id)); 76 | return entityManager().createQuery(q).executeUpdate(); 77 | } 78 | 79 | public Stream stream() { 80 | CriteriaBuilder cb = this.entityManager().getCriteriaBuilder(); 81 | CriteriaQuery q = cb.createQuery(entityClass()); 82 | Root c = q.from(entityClass()); 83 | 84 | return entityManager().createQuery(q).getResultStream(); 85 | } 86 | 87 | public Optional findOptionalById(ID id) { 88 | return Optional.ofNullable(findById(id)); 89 | } 90 | 91 | } 92 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/task/TaskResource.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.task; 2 | 3 | import com.example.domain.task.Task; 4 | import com.example.domain.task.TaskRepository; 5 | 6 | import jakarta.annotation.PostConstruct; 7 | import jakarta.enterprise.context.RequestScoped; 8 | import jakarta.inject.Inject; 9 | import jakarta.validation.Valid; 10 | import jakarta.ws.rs.*; 11 | import jakarta.ws.rs.core.MediaType; 12 | import jakarta.ws.rs.core.Response; 13 | import java.util.logging.Level; 14 | import java.util.logging.Logger; 15 | 16 | import static jakarta.ws.rs.core.Response.*; 17 | 18 | @RequestScoped 19 | public class TaskResource { 20 | 21 | @Inject 22 | Logger log; 23 | 24 | @PathParam("id") 25 | Long id; 26 | 27 | @Inject 28 | TaskRepository taskRepository; 29 | 30 | @GET 31 | @Produces(MediaType.APPLICATION_JSON) 32 | public Response taskDetails() { 33 | log.log(Level.INFO, "get task by id@{0}", id); 34 | 35 | return taskRepository.findOptionalById(id) 36 | .map(data -> ok(data).build()) 37 | .orElseThrow(() -> new TaskNotFoundException(id)); 38 | } 39 | 40 | @PUT 41 | @Consumes(MediaType.APPLICATION_JSON) 42 | public Response update(@Valid UpdateTaskCommand form) { 43 | log.log(Level.INFO, "updating existed task@id:{0}, form data:{1}", new Object[]{id, form}); 44 | 45 | return taskRepository.findOptionalById(id) 46 | .map(data -> { 47 | data.setName(form.name()); 48 | data.setDescription(form.description()); 49 | 50 | taskRepository.save(data); 51 | return noContent().build(); 52 | }) 53 | .orElseThrow(() -> new TaskNotFoundException(id)); 54 | } 55 | 56 | @PUT 57 | @Path("status") 58 | @Consumes(MediaType.APPLICATION_JSON) 59 | public Response updateStatus(@Valid UpdateStatusRequest status) { 60 | log.log(Level.INFO, "updating status of the existed task@id:{0}, status:{1}", new Object[]{id, status}); 61 | 62 | Task.Status taskStatus = null; 63 | try { 64 | taskStatus = Task.Status.valueOf(status.status()); 65 | } catch (Exception e) { 66 | log.log(Level.SEVERE, "can not parse task status value:{}", status); 67 | taskStatus = null; 68 | } 69 | 70 | Task.Status finalTaskStatus = taskStatus; 71 | return taskRepository.findOptionalById(id) 72 | .map(data -> { 73 | data.setStatus(finalTaskStatus); 74 | taskRepository.save(data); 75 | return noContent().build(); 76 | }) 77 | .orElseThrow(() -> new TaskNotFoundException(id)); 78 | } 79 | 80 | @DELETE 81 | public Response delete() { 82 | log.log(Level.INFO, "deleting task @{0}", id); 83 | 84 | return taskRepository.findOptionalById(id) 85 | .map(data -> { 86 | taskRepository.delete(data); 87 | return noContent().build(); 88 | }) 89 | .orElseThrow(() -> new TaskNotFoundException(id)); 90 | } 91 | 92 | @PostConstruct 93 | private void init() { 94 | log.config(() -> this.getClass().getSimpleName() + " created"); 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /src/main/java/com/example/infrastructure/persistence/jpa/JpaTaskRepository.java: -------------------------------------------------------------------------------- 1 | package com.example.infrastructure.persistence.jpa; 2 | 3 | import com.example.domain.task.Task; 4 | import com.example.domain.task.TaskRepository; 5 | import com.example.domain.task.Task_; 6 | import jakarta.enterprise.context.ApplicationScoped; 7 | import jakarta.inject.Inject; 8 | import jakarta.persistence.EntityManager; 9 | import jakarta.persistence.TypedQuery; 10 | import jakarta.persistence.criteria.CriteriaBuilder; 11 | import jakarta.persistence.criteria.CriteriaQuery; 12 | import jakarta.persistence.criteria.Predicate; 13 | import jakarta.persistence.criteria.Root; 14 | import jakarta.transaction.Transactional; 15 | 16 | import java.util.ArrayList; 17 | import java.util.List; 18 | import java.util.Objects; 19 | import java.util.stream.Collectors; 20 | 21 | /** 22 | * @author hantsy 23 | */ 24 | @ApplicationScoped 25 | @Transactional 26 | public class JpaTaskRepository extends AbstractRepository implements TaskRepository { 27 | 28 | @Inject 29 | EntityManager em; 30 | 31 | @Override 32 | public long countByKeyword(String keyword, Task.Status status) { 33 | CriteriaBuilder cb = this.em.getCriteriaBuilder(); 34 | CriteriaQuery q = cb.createQuery(Long.class); 35 | Root c = q.from(Task.class); 36 | List predicates = new ArrayList<>(); 37 | 38 | if (keyword != null && !keyword.trim().isEmpty()) { 39 | predicates.add( 40 | cb.or( 41 | cb.like(c.get(Task_.name), '%' + keyword + '%'), 42 | cb.like(c.get(Task_.description), '%' + keyword + '%') 43 | ) 44 | ); 45 | } 46 | if (status != null) { 47 | predicates.add(cb.equal(c.get(Task_.status), status)); 48 | } 49 | 50 | q.where(predicates.toArray(new Predicate[0])); 51 | TypedQuery query = em.createQuery(q.select(cb.count(c))); 52 | 53 | return query.getSingleResult(); 54 | } 55 | 56 | @Override 57 | public List searchByKeyword(String keyword, 58 | Task.Status status, 59 | int offset, 60 | int limit) { 61 | CriteriaBuilder cb = this.em.getCriteriaBuilder(); 62 | 63 | CriteriaQuery q = cb.createQuery(Task.class); 64 | Root c = q.from(Task.class); 65 | List predicates = new ArrayList<>(); 66 | 67 | if (keyword != null && !keyword.trim().isEmpty()) { 68 | predicates.add( 69 | cb.or( 70 | cb.like(c.get(Task_.name), '%' + keyword + '%'), 71 | cb.like(c.get(Task_.description), '%' + keyword + '%') 72 | ) 73 | ); 74 | } 75 | if (status != null) { 76 | predicates.add(cb.equal(c.get(Task_.status), status)); 77 | } 78 | 79 | q.where(predicates.toArray(new Predicate[0])); 80 | TypedQuery query = em.createQuery(q).setFirstResult(offset).setMaxResults(limit); 81 | 82 | return query.getResultList(); 83 | } 84 | 85 | @Override 86 | public List findByCreatedBy(String name) { 87 | Objects.requireNonNull(name, "username can not be null"); 88 | return this.stream().filter(t -> name.equals(t.getCreatedBy().username())).collect(Collectors.toList()); 89 | } 90 | 91 | @Override 92 | protected EntityManager entityManager() { 93 | return this.em; 94 | } 95 | 96 | } 97 | -------------------------------------------------------------------------------- /src/test/java/com/example/it/TaskResourceTest.java: -------------------------------------------------------------------------------- 1 | package com.example.it; 2 | 3 | import com.example.application.util.SampleDataPopulator; 4 | import com.example.domain.common.AbstractEntity; 5 | import com.example.domain.task.Task; 6 | import com.example.infrastructure.persistence.jpa.AbstractRepository; 7 | import com.example.infrastructure.persistence.jpa.JpaTaskRepository; 8 | import com.example.interfaces.RestActivator; 9 | import com.example.interfaces.common.PageParam; 10 | import com.example.interfaces.common.PagedResult; 11 | import com.example.interfaces.task.TaskResources; 12 | import jakarta.ws.rs.client.Client; 13 | import jakarta.ws.rs.client.ClientBuilder; 14 | import jakarta.ws.rs.client.WebTarget; 15 | import jakarta.ws.rs.core.GenericType; 16 | import jakarta.ws.rs.core.MediaType; 17 | import jakarta.ws.rs.core.Response; 18 | import org.jboss.arquillian.container.test.api.Deployment; 19 | import org.jboss.arquillian.junit5.ArquillianExtension; 20 | import org.jboss.arquillian.test.api.ArquillianResource; 21 | import org.jboss.shrinkwrap.api.ShrinkWrap; 22 | import org.jboss.shrinkwrap.api.asset.EmptyAsset; 23 | import org.jboss.shrinkwrap.api.spec.WebArchive; 24 | import org.junit.jupiter.api.AfterEach; 25 | import org.junit.jupiter.api.BeforeEach; 26 | import org.junit.jupiter.api.Test; 27 | import org.junit.jupiter.api.extension.ExtendWith; 28 | 29 | import java.net.MalformedURLException; 30 | import java.net.URI; 31 | import java.net.URL; 32 | import java.util.logging.Level; 33 | import java.util.logging.Logger; 34 | 35 | import static org.junit.jupiter.api.Assertions.assertEquals; 36 | 37 | 38 | @ExtendWith(ArquillianExtension.class) 39 | public class TaskResourceTest { 40 | private static final Logger LOGGER = Logger.getLogger(TaskResourceTest.class.getName()); 41 | 42 | @Deployment(testable = false) 43 | public static WebArchive createDeployment() { 44 | WebArchive war = ShrinkWrap.create(WebArchive.class, "rest.war") 45 | 46 | // entities 47 | .addPackage(AbstractEntity.class.getPackage()) 48 | .addPackage(Task.class.getPackage()) 49 | .addClass(JpaTaskRepository.class).addClass(AbstractRepository.class) 50 | 51 | //sample data 52 | .addPackages(true, SampleDataPopulator.class.getPackage()) 53 | 54 | // rest 55 | .addPackage(TaskResources.class.getPackage()) 56 | .addPackage(PageParam.class.getPackage()) 57 | 58 | //rest config 59 | .addClass(RestActivator.class) 60 | 61 | //Add JPA persistence configuration. 62 | //WARN: In a war archive, persistence.xml should be put into /WEB-INF/classes/META-INF/, not /META-INF 63 | .addAsResource("META-INF/persistence.xml", "META-INF/persistence.xml") 64 | // Enable CDI 65 | .addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml"); 66 | 67 | LOGGER.log(Level.INFO, "deployment unit: {0}", war.toString(true)); 68 | 69 | return war; 70 | } 71 | 72 | @ArquillianResource 73 | private URL base; 74 | 75 | private Client client; 76 | 77 | @BeforeEach 78 | public void setup() { 79 | this.client = ClientBuilder.newClient(); 80 | } 81 | 82 | @AfterEach 83 | public void teardown() { 84 | if (this.client != null) { 85 | this.client.close(); 86 | } 87 | } 88 | 89 | @Test 90 | public void shouldFoundTasks() throws MalformedURLException { 91 | final WebTarget getAllTasksTarget = client.target(URI.create(base.toExternalForm() + "api/tasks")); 92 | try (final Response getAllTasksResponse = getAllTasksTarget.request() 93 | .accept(MediaType.APPLICATION_JSON) 94 | .get()) { 95 | assertEquals(200, getAllTasksResponse.getStatus(), "status is ok"); 96 | assertEquals(2, getAllTasksResponse.readEntity(new GenericType>() { 97 | }).content().size(), "response should contain two tasks"); 98 | } 99 | } 100 | } 101 | -------------------------------------------------------------------------------- /src/main/java/com/example/domain/task/Task.java: -------------------------------------------------------------------------------- 1 | /* 2 | * To change this license header, choose License Headers in Project Properties. 3 | * To change this template file, choose Tools | Templates 4 | * and open the template in the editor. 5 | */ 6 | package com.example.domain.task; 7 | 8 | import com.example.domain.common.AbstractAuditableEntity; 9 | import jakarta.persistence.*; 10 | 11 | import java.time.LocalDateTime; 12 | import java.util.Comparator; 13 | import java.util.Objects; 14 | import java.util.function.Function; 15 | 16 | import static com.example.domain.task.Task.Status.TODO; 17 | 18 | /** 19 | * @author hantsy 20 | */ 21 | @Entity 22 | public class Task extends AbstractAuditableEntity { 23 | 24 | private static final long serialVersionUID = 1L; 25 | 26 | public static enum Status { 27 | TODO, DOING, DONE; 28 | } 29 | 30 | public static Comparator COMPARATOR = Comparator 31 | .comparing(Task::getName) 32 | .thenComparing(Task::getDescription); 33 | 34 | public static Function TO_STRING = t 35 | -> "Post[" 36 | + "\n title:" + t.getName() 37 | + "\n content:" + t.getDescription() 38 | + "\n status:" + t.getStatus() 39 | + "\n createdAt:" + t.getCreatedDate() 40 | + "\n lastModifiedAt:" + t.getLastModifiedDate() 41 | + "]"; 42 | 43 | 44 | public static Task of(String name, String description) { 45 | final Task task = new Task(); 46 | task.setName(name); 47 | task.setDescription(description); 48 | 49 | return task; 50 | } 51 | 52 | @Id 53 | @GeneratedValue(strategy = GenerationType.AUTO) 54 | private Long id; 55 | 56 | @Column(name = "name") 57 | private String name; 58 | 59 | @Column(name = "description") 60 | private String description; 61 | 62 | @Enumerated(EnumType.STRING) 63 | @Column(name = "status") 64 | private Status status = TODO; 65 | 66 | @Column(name = "created_date") 67 | private LocalDateTime createdDate; 68 | 69 | @Column(name = "last_modified_date") 70 | private LocalDateTime lastModifiedDate; 71 | 72 | public Task() { 73 | } 74 | 75 | public Long getId() { 76 | return id; 77 | } 78 | 79 | public void setId(Long id) { 80 | this.id = id; 81 | } 82 | 83 | public String getName() { 84 | return name; 85 | } 86 | 87 | public void setName(String name) { 88 | this.name = name; 89 | } 90 | 91 | public String getDescription() { 92 | return description; 93 | } 94 | 95 | public void setDescription(String description) { 96 | this.description = description; 97 | } 98 | 99 | public Status getStatus() { 100 | return status; 101 | } 102 | 103 | public void setStatus(Status status) { 104 | this.status = status; 105 | } 106 | 107 | public LocalDateTime getCreatedDate() { 108 | return createdDate; 109 | } 110 | 111 | public void setCreatedDate(LocalDateTime createdDate) { 112 | this.createdDate = createdDate; 113 | } 114 | 115 | public LocalDateTime getLastModifiedDate() { 116 | return lastModifiedDate; 117 | } 118 | 119 | public void setLastModifiedDate(LocalDateTime lastModifiedDate) { 120 | this.lastModifiedDate = lastModifiedDate; 121 | } 122 | 123 | @Override 124 | public boolean equals(Object o) { 125 | if (o == null || getClass() != o.getClass()) return false; 126 | Task task = (Task) o; 127 | return Objects.equals(id, task.id) && Objects.equals(name, task.name) && Objects.equals(description, task.description) && status == task.status && Objects.equals(createdDate, task.createdDate) && Objects.equals(lastModifiedDate, task.lastModifiedDate); 128 | } 129 | 130 | @Override 131 | public int hashCode() { 132 | return Objects.hash(id, name, description, status, createdDate, lastModifiedDate); 133 | } 134 | 135 | @Override 136 | public String toString() { 137 | return "Task{" + 138 | "id=" + id + 139 | ", name='" + name + '\'' + 140 | ", description='" + description + '\'' + 141 | ", status=" + status + 142 | ", createdDate=" + createdDate + 143 | ", lastModifiedDate=" + lastModifiedDate + 144 | '}'; 145 | } 146 | } 147 | -------------------------------------------------------------------------------- /src/main/java/com/example/interfaces/common/cors/CorsFilter.java: -------------------------------------------------------------------------------- 1 | package com.example.interfaces.common.cors; 2 | 3 | import jakarta.ws.rs.ForbiddenException; 4 | import jakarta.ws.rs.container.ContainerRequestContext; 5 | import jakarta.ws.rs.container.ContainerRequestFilter; 6 | import jakarta.ws.rs.container.ContainerResponseContext; 7 | import jakarta.ws.rs.container.ContainerResponseFilter; 8 | import jakarta.ws.rs.container.PreMatching; 9 | import jakarta.ws.rs.core.Response; 10 | 11 | import java.io.IOException; 12 | import java.util.HashSet; 13 | import java.util.Set; 14 | 15 | /** 16 | * Handles CORS requests both preflight and simple CORS requests. 17 | * You must bind this as a singleton and set up allowedOrigins and other settings to use. 18 | * 19 | * @author Bill Burke 20 | * @version $Revision: 1 $ 21 | */ 22 | @PreMatching 23 | public class CorsFilter implements ContainerRequestFilter, ContainerResponseFilter 24 | { 25 | protected boolean allowCredentials = true; 26 | protected String allowedMethods; 27 | protected String allowedHeaders; 28 | protected String exposedHeaders; 29 | protected int corsMaxAge = -1; 30 | protected Set allowedOrigins = new HashSet(); 31 | 32 | /** 33 | * Put "*" if you want to accept all origins. 34 | * 35 | * @return allowed origins 36 | */ 37 | public Set getAllowedOrigins() 38 | { 39 | return allowedOrigins; 40 | } 41 | 42 | /** 43 | * Defaults to true. 44 | * 45 | * @return allow credentials 46 | */ 47 | public boolean isAllowCredentials() 48 | { 49 | return allowCredentials; 50 | } 51 | 52 | public void setAllowCredentials(boolean allowCredentials) 53 | { 54 | this.allowCredentials = allowCredentials; 55 | } 56 | 57 | /** 58 | * Will allow all by default. 59 | * 60 | * @return allowed methods 61 | */ 62 | public String getAllowedMethods() 63 | { 64 | return allowedMethods; 65 | } 66 | 67 | /** 68 | * Will allow all by default 69 | * comma delimited string for Access-Control-Allow-Methods. 70 | * 71 | * @param allowedMethods allowed methods 72 | */ 73 | public void setAllowedMethods(String allowedMethods) 74 | { 75 | this.allowedMethods = allowedMethods; 76 | } 77 | 78 | public String getAllowedHeaders() 79 | { 80 | return allowedHeaders; 81 | } 82 | 83 | /** 84 | * Will allow all by default 85 | * comma delimited string for Access-Control-Allow-Headers. 86 | * 87 | * @param allowedHeaders allowed headers 88 | */ 89 | public void setAllowedHeaders(String allowedHeaders) 90 | { 91 | this.allowedHeaders = allowedHeaders; 92 | } 93 | 94 | public int getCorsMaxAge() 95 | { 96 | return corsMaxAge; 97 | } 98 | 99 | public void setCorsMaxAge(int corsMaxAge) 100 | { 101 | this.corsMaxAge = corsMaxAge; 102 | } 103 | 104 | public String getExposedHeaders() 105 | { 106 | return exposedHeaders; 107 | } 108 | 109 | /** 110 | * Comma delimited list. 111 | * 112 | * @param exposedHeaders exposed headers 113 | */ 114 | public void setExposedHeaders(String exposedHeaders) 115 | { 116 | this.exposedHeaders = exposedHeaders; 117 | } 118 | 119 | @Override 120 | public void filter(ContainerRequestContext requestContext) throws IOException 121 | { 122 | String origin = requestContext.getHeaderString(CorsHeaders.ORIGIN); 123 | if (origin == null) 124 | { 125 | return; 126 | } 127 | if (requestContext.getMethod().equalsIgnoreCase("OPTIONS")) 128 | { 129 | preflight(origin, requestContext); 130 | } 131 | else 132 | { 133 | checkOrigin(requestContext, origin); 134 | } 135 | } 136 | 137 | @Override 138 | public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext) throws IOException 139 | { 140 | String origin = requestContext.getHeaderString(CorsHeaders.ORIGIN); 141 | if (origin == null || requestContext.getMethod().equalsIgnoreCase("OPTIONS") || requestContext.getProperty("cors.failure") != null) 142 | { 143 | // don't do anything if origin is null, its an OPTIONS request, or cors.failure is set 144 | return; 145 | } 146 | responseContext.getHeaders().putSingle(CorsHeaders.ACCESS_CONTROL_ALLOW_ORIGIN, origin); 147 | responseContext.getHeaders().putSingle(CorsHeaders.VARY, CorsHeaders.ORIGIN); 148 | if (allowCredentials) responseContext.getHeaders().putSingle(CorsHeaders.ACCESS_CONTROL_ALLOW_CREDENTIALS, "true"); 149 | 150 | if (exposedHeaders != null) { 151 | responseContext.getHeaders().putSingle(CorsHeaders.ACCESS_CONTROL_EXPOSE_HEADERS, exposedHeaders); 152 | } 153 | } 154 | 155 | 156 | protected void preflight(String origin, ContainerRequestContext requestContext) throws IOException 157 | { 158 | checkOrigin(requestContext, origin); 159 | 160 | Response.ResponseBuilder builder = Response.ok(); 161 | builder.header(CorsHeaders.ACCESS_CONTROL_ALLOW_ORIGIN, origin); 162 | builder.header(CorsHeaders.VARY, CorsHeaders.ORIGIN); 163 | if (allowCredentials) builder.header(CorsHeaders.ACCESS_CONTROL_ALLOW_CREDENTIALS, "true"); 164 | String requestMethods = requestContext.getHeaderString(CorsHeaders.ACCESS_CONTROL_REQUEST_METHOD); 165 | if (requestMethods != null) 166 | { 167 | if (allowedMethods != null) 168 | { 169 | requestMethods = this.allowedMethods; 170 | } 171 | builder.header(CorsHeaders.ACCESS_CONTROL_ALLOW_METHODS, requestMethods); 172 | } 173 | String allowHeaders = requestContext.getHeaderString(CorsHeaders.ACCESS_CONTROL_REQUEST_HEADERS); 174 | if (allowHeaders != null) 175 | { 176 | if (allowedHeaders != null) 177 | { 178 | allowHeaders = this.allowedHeaders; 179 | } 180 | builder.header(CorsHeaders.ACCESS_CONTROL_ALLOW_HEADERS, allowHeaders); 181 | } 182 | if (corsMaxAge > -1) 183 | { 184 | builder.header(CorsHeaders.ACCESS_CONTROL_MAX_AGE, corsMaxAge); 185 | } 186 | requestContext.abortWith(builder.build()); 187 | 188 | } 189 | 190 | protected void checkOrigin(ContainerRequestContext requestContext, String origin) 191 | { 192 | if (!allowedOrigins.contains("*") && !allowedOrigins.contains(origin)) 193 | { 194 | requestContext.setProperty("cors.failure", true); 195 | throw new ForbiddenException("Origin: "+ origin+ " is not allowed"); 196 | } 197 | } 198 | } -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | com.example 8 | jakartaee-rest-sample 9 | 1.0-SNAPSHOT 10 | war 11 | jakartaee-rest-sample 12 | A Jakarta EE 11 REST Example project 13 | 14 | 15 | UTF-8 16 | UTF-8 17 | 18 | 19 | 20 | 21 | 21 22 | 23 | 24 | 11.0.0 25 | 26 | 27 | 3.14.1 28 | 3.5.1 29 | 1.10.25 30 | 3.9.0 31 | 3.5.4 32 | 3.5.4 33 | 3.5.4 34 | 35 | 36 | 1.10.0.Final 37 | 38 | 10.0.0.Final 39 | 3.3.4 40 | 5.13.4 41 | 5.21.0 42 | 4.3.0 43 | 3.0 44 | 45 | 46 | 8.0.0-M14 47 | 4.0.0 48 | 5.0.0-B11 49 | 10.17.1.0 50 | 7.0.14 51 | 52 | 53 | true 54 | 55 | 56 | 57 | 58 | jakarta.platform 59 | jakarta.jakartaee-api 60 | ${jakartaee-api.version} 61 | provided 62 | 63 | 64 | org.jboss.arquillian 65 | arquillian-bom 66 | ${arquillian-bom.version} 67 | import 68 | pom 69 | 70 | 71 | org.jboss.arquillian.jakarta 72 | arquillian-jakarta-bom 73 | ${arquillian-jakarta-bom.version} 74 | pom 75 | import 76 | 77 | 78 | org.jboss.shrinkwrap.resolver 79 | shrinkwrap-resolver-bom 80 | ${shrinkwrap-resolver-bom.version} 81 | import 82 | pom 83 | 84 | 85 | org.junit 86 | junit-bom 87 | ${junit-bom.version} 88 | pom 89 | import 90 | 91 | 92 | 93 | org.hamcrest 94 | hamcrest 95 | ${hamcrest.version} 96 | test 97 | 98 | 99 | 100 | org.awaitility 101 | awaitility 102 | ${awaitility.version} 103 | test 104 | 105 | 106 | 107 | 108 | org.mockito 109 | mockito-bom 110 | ${mockito-bom.version} 111 | pom 112 | import 113 | 114 | 115 | 116 | 117 | 118 | jakarta.platform 119 | jakarta.jakartaee-api 120 | 121 | 122 | 123 | org.eclipse.persistence 124 | org.eclipse.persistence.jpa.modelgen.processor 125 | ${eclipselink.version} 126 | provided 127 | 128 | 129 | org.jboss.arquillian.junit5 130 | arquillian-junit5-container 131 | test 132 | 133 | 134 | org.jboss.arquillian.protocol 135 | arquillian-protocol-servlet-jakarta 136 | test 137 | 138 | 139 | 140 | org.jboss.shrinkwrap.resolver 141 | shrinkwrap-resolver-depchain 142 | test 143 | pom 144 | 145 | 146 | org.junit.jupiter 147 | junit-jupiter 148 | test 149 | 150 | 151 | org.mockito 152 | mockito-core 153 | test 154 | 155 | 156 | org.hamcrest 157 | hamcrest 158 | test 159 | 160 | 161 | org.awaitility 162 | awaitility 163 | test 164 | 165 | 166 | 167 | ${project.artifactId} 168 | 169 | 170 | 171 | 172 | org.apache.maven.plugins 173 | maven-clean-plugin 174 | 3.5.0 175 | 176 | 177 | org.apache.maven.plugins 178 | maven-resources-plugin 179 | 3.4.0 180 | 181 | 182 | 183 | 184 | 185 | org.apache.maven.plugins 186 | maven-compiler-plugin 187 | ${maven-compiler-plugin.version} 188 | 189 | 190 | org.apache.maven.plugins 191 | maven-war-plugin 192 | ${maven-war-plugin.version} 193 | 194 | 195 | org.apache.maven.plugins 196 | maven-surefire-plugin 197 | ${maven-surefire-plugin.version} 198 | 199 | ${skipTests} 200 | 201 | 202 | 203 | test 204 | default-test 205 | 206 | 207 | **/it/** 208 | 209 | 210 | 211 | 212 | 213 | 214 | org.apache.maven.plugins 215 | maven-failsafe-plugin 216 | ${maven-failsafe-plugin.version} 217 | 218 | ${skipTests} 219 | 220 | 221 | 222 | integration-test 223 | integration-test 224 | 225 | integration-test 226 | verify 227 | 228 | 229 | 230 | **/it/** 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 241 | glassfish 242 | 243 | true 244 | 245 | 246 | ${project.basedir}/installs 247 | 248 | 249 | 250 | 251 | 252 | 253 | org.codehaus.cargo 254 | cargo-maven3-plugin 255 | ${cargo-maven3-plugin.version} 256 | 257 | 258 | glassfish8x 259 | 260 | 261 | https://github.com/eclipse-ee4j/glassfish/releases/download/${glassfish.version}/glassfish-${glassfish.version}.zip 262 | 263 | ${cargo.zipUrlInstaller.downloadDir} 264 | 265 | 266 | 267 | 268 | ${project.build.directory}/glassfish8x-home 269 | 270 | 271 | true 272 | 273 | 274 | 275 | 276 | org.apache.derby.jdbc.EmbeddedDriver 277 | jdbc:derby:derbyDB;create=true 278 | jdbc/__default 279 | APP 280 | nonemptypassword 281 | 282 | 283 | 284 | 285 | 286 | 287 | 288 | 289 | 290 | arq-glassfish-managed 291 | 292 | false 293 | 294 | 295 | 296 | io.github.hantsy.arquillian 297 | arquillian-glassfish-managed 298 | ${arquillian-glassfish.version} 299 | test 300 | 301 | 302 | 303 | org.apache.derby 304 | derbyclient 305 | ${derbyclient.version} 306 | test 307 | 308 | 309 | org.glassfish.jersey.media 310 | jersey-media-json-binding 311 | ${jersey.version} 312 | test 313 | 314 | 315 | org.glassfish.jersey.inject 316 | jersey-hk2 317 | ${jersey.version} 318 | test 319 | 320 | 321 | org.glassfish.jersey.core 322 | jersey-client 323 | ${jersey.version} 324 | test 325 | 326 | 327 | 328 | 329 | 330 | org.apache.maven.plugins 331 | maven-dependency-plugin 332 | ${maven-dependency-plugin.version} 333 | 334 | 335 | unpack 336 | pre-integration-test 337 | 338 | unpack 339 | 340 | 341 | 342 | 343 | org.glassfish.main.distributions 344 | glassfish 345 | ${glassfish.version} 346 | zip 347 | false 348 | ${project.build.directory} 349 | 350 | 351 | 352 | 353 | 354 | 416 | 417 | 418 | 419 | org.apache.maven.plugins 420 | maven-failsafe-plugin 421 | ${maven-failsafe-plugin.version} 422 | 423 | 424 | --add-opens java.base/java.lang=ALL-UNNAMED 425 | 426 | 427 | ${project.build.directory}/glassfish8 428 | 429 | 430 | 431 | 432 | 433 | 434 | 435 | 436 | 437 | 438 | org.apache.maven.plugins 439 | maven-surefire-report-plugin 440 | ${maven-surefire-report-plugin.version} 441 | 442 | 443 | 444 | 445 | 446 | 447 | sonatype-nexus-staging 448 | Sonatype Nexus Staging 449 | https://jakarta.oss.sonatype.org/content/repositories/staging/ 450 | 451 | true 452 | 453 | 454 | true 455 | 456 | 457 | 458 | 459 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------