/
Problem.java
153 lines (127 loc) · 3.51 KB
/
Problem.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
* Copyright 2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.hateoas.mediatype.problem;
import java.net.URI;
import java.util.Objects;
import org.springframework.http.HttpStatus;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
/**
* Encapsulation of an RFC-7807 {@literal Problem} code. While it complies out-of-the-box, it may also be extended to
* support domain-specific details.
*
* @author Greg Turnquist
*/
public class Problem<T extends Problem<? extends T>> {
private URI type;
private String title;
private HttpStatus status;
private String detail;
private URI instance;
public Problem() {
this(null, null, null, null, null);
}
public Problem(URI type, String title, HttpStatus status, String detail, URI instance) {
this.type = type;
this.title = title;
this.status = status;
this.detail = detail;
this.instance = instance;
}
/**
* A {@link Problem} that reflects an {@link HttpStatus} code.
*
* @see https://tools.ietf.org/html/rfc7807#section-4.2
*/
public Problem(HttpStatus httpStatus) {
this(URI.create("about:blank"), httpStatus.getReasonPhrase(), httpStatus, null, null);
}
@SuppressWarnings("unchecked")
public T withType(URI type) {
this.type = type;
return (T) this;
}
@SuppressWarnings("unchecked")
public T withTitle(String title) {
this.title = title;
return (T) this;
}
@SuppressWarnings("unchecked")
public T withStatus(HttpStatus status) {
this.status = status;
return (T) this;
}
@SuppressWarnings("unchecked")
public T withDetail(String detail) {
this.detail = detail;
return (T) this;
}
@SuppressWarnings("unchecked")
public T withInstance(URI instance) {
this.instance = instance;
return (T) this;
}
@JsonInclude(Include.NON_NULL)
public URI getType() {
return this.type;
}
@JsonInclude(Include.NON_NULL)
public String getTitle() {
return this.title;
}
@JsonInclude(Include.NON_NULL)
public Integer getStatus() {
if (status != null) {
return status.value();
}
return null;
}
@JsonInclude(Include.NON_NULL)
public String getDetail() {
return detail;
}
@JsonInclude(Include.NON_NULL)
public URI getInstance() {
return instance;
}
@Override
public boolean equals(Object o) {
if (this == o)
return true;
if (o == null || getClass() != o.getClass())
return false;
Problem problem = (Problem) o;
return Objects.equals(type, problem.type) && //
Objects.equals(title, problem.title) && //
status == problem.status && //
Objects.equals(detail, problem.detail) && //
Objects.equals(instance, problem.instance); //
}
@Override
public int hashCode() {
return Objects.hash(type, title, status, detail, instance);
}
@Override
public String toString() {
return "Problem{" + //
"type=" + type + //
", title='" + title + '\'' + //
", status=" + status + //
", detail='" + detail + '\'' + //
", instance=" + instance + //
'}';
}
}