Skip to content

Commit 92b46ba

Browse files
doddidoddi
authored
[MRESOLVER-600] RFC9457 Implementation (#576)
Added an RFC9457Reporter for each of the 3 Transporters. At the moment I tried to keep the original exception messages if the error response is not an [RFC9457](https://www.rfc-editor.org/rfc/rfc9457) type. This did create a little more complexity in the implementation than is perhaps necessary. If the exceptions to be thrown can be consisted throughout the transporters then this PR could also be simplified considerably. At the moment I have taken the stance not to make any potential breaking changes in messaging. --- https://issues.apache.org/jira/browse/MRESOLVER-600
1 parent 548ee0b commit 92b46ba

19 files changed

Lines changed: 757 additions & 8 deletions

File tree

‎maven-resolver-spi/pom.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@
4343
<groupId>org.apache.maven.resolver</groupId>
4444
<artifactId>maven-resolver-api</artifactId>
4545
</dependency>
46+
<dependency>
47+
<groupId>com.google.code.gson</groupId>
48+
<artifactId>gson</artifactId>
49+
</dependency>
4650
<dependency>
4751
<groupId>org.junit.jupiter</groupId>
4852
<artifactId>junit-jupiter-api</artifactId>

‎maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/BiConsumerChecked.java‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package org.eclipse.aether.spi.connector.transport.http.RFC9457;
20+
21+
@FunctionalInterface
22+
public interface BiConsumerChecked<T, U, E extends Exception> {
23+
void accept(T t, U u) throws E;
24+
}

‎maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/HttpRFC9457Exception.java‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package org.eclipse.aether.spi.connector.transport.http.RFC9457;
20+
21+
import java.io.IOException;
22+
23+
import org.eclipse.aether.spi.connector.transport.http.HttpTransporter;
24+
25+
/**
26+
* Exception thrown by {@link HttpTransporter} in case of errors.
27+
*
28+
* @since 2.0.2
29+
*/
30+
public class HttpRFC9457Exception extends IOException {
31+
private final int statusCode;
32+
33+
private final String reasonPhrase;
34+
35+
private final RFC9457Payload payload;
36+
37+
public HttpRFC9457Exception(int statusCode, String reasonPhrase, RFC9457Payload payload) {
38+
super(payload.toString());
39+
this.statusCode = statusCode;
40+
this.reasonPhrase = reasonPhrase;
41+
this.payload = payload;
42+
}
43+
44+
public int getStatusCode() {
45+
return statusCode;
46+
}
47+
48+
public String getReasonPhrase() {
49+
return reasonPhrase;
50+
}
51+
52+
public RFC9457Payload getPayload() {
53+
return payload;
54+
}
55+
}

‎maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457Parser.java‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package org.eclipse.aether.spi.connector.transport.http.RFC9457;
20+
21+
import java.lang.reflect.Type;
22+
import java.net.URI;
23+
24+
import com.google.gson.Gson;
25+
import com.google.gson.GsonBuilder;
26+
import com.google.gson.JsonDeserializationContext;
27+
import com.google.gson.JsonDeserializer;
28+
import com.google.gson.JsonElement;
29+
import com.google.gson.JsonObject;
30+
import com.google.gson.JsonParseException;
31+
32+
public class RFC9457Parser {
33+
private static Gson gson = new GsonBuilder()
34+
.registerTypeAdapter(RFC9457Payload.class, new RFC9457PayloadAdapter())
35+
.create();
36+
37+
public static RFC9457Payload parse(String data) {
38+
return gson.fromJson(data, RFC9457Payload.class);
39+
}
40+
41+
private static class RFC9457PayloadAdapter implements JsonDeserializer<RFC9457Payload> {
42+
@Override
43+
public RFC9457Payload deserialize(
44+
final JsonElement json, final Type typeOfT, final JsonDeserializationContext context)
45+
throws JsonParseException {
46+
JsonObject asJsonObject = json.getAsJsonObject();
47+
URI type = parseNullableURI(asJsonObject, "type", "about:blank");
48+
Integer status = parseStatus(asJsonObject);
49+
String title = parseNullableString(asJsonObject, "title");
50+
String detail = parseNullableString(asJsonObject, "detail");
51+
URI instance = parseNullableURI(asJsonObject, "instance", null);
52+
return new RFC9457Payload(type, status, title, detail, instance);
53+
}
54+
}
55+
56+
private static Integer parseStatus(JsonObject jsonObject) {
57+
return jsonObject.get("status") == null || jsonObject.get("status").isJsonNull()
58+
? null
59+
: jsonObject.get("status").getAsInt();
60+
}
61+
62+
private static String parseNullableString(JsonObject jsonObject, String key) {
63+
return jsonObject.get(key) == null || jsonObject.get(key).isJsonNull()
64+
? null
65+
: jsonObject.get(key).getAsString();
66+
}
67+
68+
private static URI parseNullableURI(JsonObject jsonObject, String key, String defaultValue) {
69+
return !jsonObject.has(key) || jsonObject.get(key).isJsonNull()
70+
? defaultValue != null ? URI.create(defaultValue) : null
71+
: URI.create(jsonObject.get(key).getAsString());
72+
}
73+
}

‎maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457Payload.java‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package org.eclipse.aether.spi.connector.transport.http.RFC9457;
20+
21+
import java.net.URI;
22+
23+
public class RFC9457Payload {
24+
public static final RFC9457Payload INSTANCE = new RFC9457Payload();
25+
26+
private final URI type;
27+
28+
private final Integer status;
29+
30+
private final String title;
31+
32+
private final String detail;
33+
34+
private final URI instance;
35+
36+
private RFC9457Payload() {
37+
this(null, null, null, null, null);
38+
}
39+
40+
public RFC9457Payload(
41+
final URI type, final Integer status, final String title, final String detail, final URI instance) {
42+
this.type = type;
43+
this.status = status;
44+
this.title = title;
45+
this.detail = detail;
46+
this.instance = instance;
47+
}
48+
49+
public URI getType() {
50+
return type;
51+
}
52+
53+
public Integer getStatus() {
54+
return status;
55+
}
56+
57+
public String getTitle() {
58+
return title;
59+
}
60+
61+
public String getDetail() {
62+
return detail;
63+
}
64+
65+
public URI getInstance() {
66+
return instance;
67+
}
68+
69+
@Override
70+
public String toString() {
71+
return "RFC9457Payload {" + "type="
72+
+ type + ", status="
73+
+ status + ", title='"
74+
+ title + ", detail='"
75+
+ detail + ", instance="
76+
+ instance + '}';
77+
}
78+
}

‎maven-resolver-spi/src/main/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457Reporter.java‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package org.eclipse.aether.spi.connector.transport.http.RFC9457;
20+
21+
import java.io.IOException;
22+
23+
/**
24+
* A reporter for RFC 9457 messages.
25+
* RFC 9457 is a standard for reporting problems in HTTP responses as a JSON object.
26+
* There are members specified in the RFC but none of those appear to be required,
27+
* @see <a href=https://www.rfc-editor.org/rfc/rfc9457#section-3-7>rfc9457 section 3.7</a>
28+
* Given the JSON fields are not mandatory, this reporter simply extracts the body of the
29+
* response without validation.
30+
* A RFC 9457 message is detected by the content type "application/problem+json".
31+
*
32+
* @param <T> The type of the response.
33+
* @param <E> The base exception type to throw if the response is not a RFC9457 message.
34+
*/
35+
public abstract class RFC9457Reporter<T, E extends Exception> {
36+
protected abstract boolean isRFC9457Message(T response);
37+
38+
protected abstract int getStatusCode(T response);
39+
40+
protected abstract String getReasonPhrase(T response);
41+
42+
protected abstract String getBody(T response) throws IOException;
43+
44+
protected boolean hasRFC9457ContentType(String contentType) {
45+
return "application/problem+json".equals(contentType);
46+
}
47+
48+
/**
49+
* Generates a {@link HttpRFC9457Exception} if the response type is a RFC 9457 message.
50+
* Otherwise, it throws the base exception
51+
*
52+
* @param response The response to check for RFC 9457 messages.
53+
* @param baseException The base exception to throw if the response is not a RFC 9457 message.
54+
*/
55+
public void generateException(T response, BiConsumerChecked<Integer, String, E> baseException)
56+
throws E, HttpRFC9457Exception {
57+
int statusCode = getStatusCode(response);
58+
String reasonPhrase = getReasonPhrase(response);
59+
60+
if (isRFC9457Message(response)) {
61+
String body;
62+
try {
63+
body = getBody(response);
64+
} catch (IOException ignore) {
65+
// No body found but it is representing a RFC 9457 message due to the content type.
66+
throw new HttpRFC9457Exception(statusCode, reasonPhrase, RFC9457Payload.INSTANCE);
67+
}
68+
69+
if (body != null && !body.isEmpty()) {
70+
RFC9457Payload rfc9457Payload = RFC9457Parser.parse(body);
71+
throw new HttpRFC9457Exception(statusCode, reasonPhrase, rfc9457Payload);
72+
}
73+
throw new HttpRFC9457Exception(statusCode, reasonPhrase, RFC9457Payload.INSTANCE);
74+
}
75+
baseException.accept(statusCode, reasonPhrase);
76+
}
77+
}

‎maven-resolver-spi/src/test/java/org/eclipse/aether/spi/connector/transport/http/RFC9457/RFC9457ParserTest.java‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
package org.eclipse.aether.spi.connector.transport.http.RFC9457;
20+
21+
import org.junit.jupiter.api.Test;
22+
23+
import static org.junit.jupiter.api.Assertions.*;
24+
25+
class RFC9457ParserTest {
26+
@Test
27+
void testParseAllFields() {
28+
String data =
29+
"{\"type\":\"https://example.com/error\",\"status\":400,\"title\":\"Bad Request\",\"detail\":\"The request could not be understood by the server due to malformed syntax.\",\"instance\":\"https://example.com/error/400\"}";
30+
RFC9457Payload payload = RFC9457Parser.parse(data);
31+
32+
assertEquals("https://example.com/error", payload.getType().toString());
33+
assertEquals(400, payload.getStatus());
34+
assertEquals("Bad Request", payload.getTitle());
35+
assertEquals("The request could not be understood by the server due to malformed syntax.", payload.getDetail());
36+
assertEquals("https://example.com/error/400", payload.getInstance().toString());
37+
}
38+
39+
@Test
40+
void testParseWithMissingFields() {
41+
String data = "{\"type\":\"https://example.com/other_error\",\"status\":403}";
42+
RFC9457Payload payload = RFC9457Parser.parse(data);
43+
44+
assertEquals("https://example.com/other_error", payload.getType().toString());
45+
assertEquals(403, payload.getStatus());
46+
assertNull(payload.getTitle());
47+
assertNull(payload.getDetail());
48+
assertNull(payload.getInstance());
49+
}
50+
51+
@Test
52+
void testParseWithNoFields() {
53+
String data = "{}";
54+
RFC9457Payload payload = RFC9457Parser.parse(data);
55+
56+
assertEquals("about:blank", payload.getType().toString());
57+
assertNull(payload.getStatus());
58+
assertNull(payload.getTitle());
59+
assertNull(payload.getDetail());
60+
assertNull(payload.getInstance());
61+
}
62+
63+
@Test
64+
void testParseWithNullFields() {
65+
String data = "{\"type\":null,\"status\":null,\"title\":null,\"detail\":null,\"instance\":null}";
66+
RFC9457Payload payload = RFC9457Parser.parse(data);
67+
68+
assertEquals("about:blank", payload.getType().toString());
69+
assertNull(payload.getStatus());
70+
assertNull(payload.getTitle());
71+
assertNull(payload.getDetail());
72+
assertNull(payload.getInstance());
73+
}
74+
}

0 commit comments

Comments
 (0)