This repository has been archived by the owner on Apr 23, 2019. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add higher level 'RPCResponse' class to represent successful RPC resp…
…onse bodies as implementers may think they have to check and handle errors in RPCMessage, rather than handling the future completing exceptionally.
- Loading branch information
Showing
7 changed files
with
159 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
74 changes: 74 additions & 0 deletions
74
scuttlebutt-rpc/src/main/java/net/consensys/cava/scuttlebutt/rpc/RPCResponse.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| * Copyright 2019 ConsenSys AG. | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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 net.consensys.cava.scuttlebutt.rpc; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
|
|
||
| import net.consensys.cava.bytes.Bytes; | ||
| import net.consensys.cava.scuttlebutt.rpc.RPCFlag.BodyType; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
|
|
||
| /** | ||
| * A successful RPC response. | ||
| */ | ||
| public class RPCResponse { | ||
|
|
||
| private final Bytes body; | ||
| private final BodyType bodyType; | ||
|
|
||
| /** | ||
| * A successful RPC response. | ||
| * | ||
| * @param body the body of the response in bytes | ||
| * @param bodyType the type of the response (e.g. JSON, UTF-8 or binary.) | ||
| */ | ||
| public RPCResponse(Bytes body, BodyType bodyType) { | ||
|
|
||
| this.body = body; | ||
| this.bodyType = bodyType; | ||
| } | ||
|
|
||
| public Bytes getBody() { | ||
| return body; | ||
| } | ||
|
|
||
| public BodyType getBodyType() { | ||
| return bodyType; | ||
| } | ||
|
|
||
| /** | ||
| * Provides the body of the message as a UTF-8 string. | ||
| * | ||
| * @return the body of the message as a UTF-8 string | ||
| */ | ||
| public String asString() { | ||
| return new String(getBody().toArrayUnsafe(), UTF_8); | ||
| } | ||
|
|
||
| /** | ||
| * Provides the body of the message, marshalled as a JSON object. | ||
| * | ||
| * @param objectMapper the object mapper to deserialize with | ||
| * @param clazz the JSON object class | ||
| * @param <T> the matching JSON object class | ||
| * @return a new instance of the JSON object class | ||
| * @throws IOException if an error occurs during marshalling | ||
| */ | ||
| public <T> T asJSON(ObjectMapper objectMapper, Class<T> clazz) throws IOException { | ||
| return objectMapper.readerFor(clazz).readValue(getBody().toArrayUnsafe()); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
20 changes: 20 additions & 0 deletions
20
...ain/java/net/consensys/cava/scuttlebutt/rpc/mux/exceptions/RPCRequestFailedException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| /* | ||
| * Copyright 2019 ConsenSys AG. | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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 net.consensys.cava.scuttlebutt.rpc.mux.exceptions; | ||
|
|
||
| public class RPCRequestFailedException extends Exception { | ||
|
|
||
| public RPCRequestFailedException(String errorMessage) { | ||
| super(errorMessage); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters