35
35
* @since 1.0.0
36
36
* @see <a href="https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md">GraphQL Over WebSocket Protocol</a>
37
37
*/
38
- public class GraphQlMessage {
38
+ public class GraphQlWebSocketMessage {
39
39
40
40
@ Nullable
41
41
private String id ;
42
42
43
43
@ Nullable
44
- private GraphQlMessageType type ;
44
+ private GraphQlWebSocketMessageType type ;
45
45
46
46
@ Nullable
47
47
private Object payload ;
@@ -50,7 +50,7 @@ public class GraphQlMessage {
50
50
/**
51
51
* Private constructor. See static factory methods.
52
52
*/
53
- private GraphQlMessage (@ Nullable String id , GraphQlMessageType type , @ Nullable Object payload ) {
53
+ private GraphQlWebSocketMessage (@ Nullable String id , GraphQlWebSocketMessageType type , @ Nullable Object payload ) {
54
54
Assert .notNull (type , "GraphQlMessageType is required" );
55
55
Assert .isTrue (payload != null || type .doesNotRequirePayload (), "Payload is required for [" + type + "]" );
56
56
this .id = id ;
@@ -63,8 +63,8 @@ private GraphQlMessage(@Nullable String id, GraphQlMessageType type, @Nullable O
63
63
* Constructor for deserialization.
64
64
*/
65
65
@ SuppressWarnings ("unused" )
66
- GraphQlMessage () {
67
- this .type = GraphQlMessageType .NOT_SPECIFIED ;
66
+ GraphQlWebSocketMessage () {
67
+ this .type = GraphQlWebSocketMessageType .NOT_SPECIFIED ;
68
68
}
69
69
70
70
@@ -88,7 +88,7 @@ public String getType() {
88
88
/**
89
89
* Return the message type as an emum.
90
90
*/
91
- public GraphQlMessageType resolvedType () {
91
+ public GraphQlWebSocketMessageType resolvedType () {
92
92
Assert .state (this .type != null , "GraphQlWebSocketMessage does not have a type" );
93
93
return this .type ;
94
94
}
@@ -111,7 +111,7 @@ public void setId(@Nullable String id) {
111
111
}
112
112
113
113
public void setType (String type ) {
114
- this .type = GraphQlMessageType .fromValue (type );
114
+ this .type = GraphQlWebSocketMessageType .fromValue (type );
115
115
}
116
116
117
117
public void setPayload (@ Nullable Object payload ) {
@@ -129,10 +129,10 @@ public int hashCode() {
129
129
130
130
@ Override
131
131
public boolean equals (Object o ) {
132
- if (!(o instanceof GraphQlMessage )) {
132
+ if (!(o instanceof GraphQlWebSocketMessage )) {
133
133
return false ;
134
134
}
135
- GraphQlMessage other = (GraphQlMessage ) o ;
135
+ GraphQlWebSocketMessage other = (GraphQlWebSocketMessage ) o ;
136
136
return (ObjectUtils .nullSafeEquals (this .type , other .type ) &&
137
137
(ObjectUtils .nullSafeEquals (this .id , other .id ) || (this .id == null && other .id == null )) &&
138
138
(ObjectUtils .nullSafeEquals (getPayload (), other .getPayload ())));
@@ -151,71 +151,71 @@ public String toString() {
151
151
* Create a {@code "connection_init"} client message.
152
152
* @param payload an optional payload
153
153
*/
154
- public static GraphQlMessage connectionInit (@ Nullable Object payload ) {
155
- return new GraphQlMessage (null , GraphQlMessageType .CONNECTION_INIT , payload );
154
+ public static GraphQlWebSocketMessage connectionInit (@ Nullable Object payload ) {
155
+ return new GraphQlWebSocketMessage (null , GraphQlWebSocketMessageType .CONNECTION_INIT , payload );
156
156
}
157
157
158
158
/**
159
159
* Create a {@code "connection_ack"} server message.
160
160
* @param payload an optional payload
161
161
*/
162
- public static GraphQlMessage connectionAck (@ Nullable Object payload ) {
163
- return new GraphQlMessage (null , GraphQlMessageType .CONNECTION_ACK , payload );
162
+ public static GraphQlWebSocketMessage connectionAck (@ Nullable Object payload ) {
163
+ return new GraphQlWebSocketMessage (null , GraphQlWebSocketMessageType .CONNECTION_ACK , payload );
164
164
}
165
165
166
166
/**
167
167
* Create a {@code "subscribe"} client message.
168
168
* @param id unique request id
169
169
* @param request the request to add as the message payload
170
170
*/
171
- public static GraphQlMessage subscribe (String id , GraphQlRequest request ) {
171
+ public static GraphQlWebSocketMessage subscribe (String id , GraphQlRequest request ) {
172
172
Assert .notNull (request , "GraphQlRequest is required" );
173
- return new GraphQlMessage (id , GraphQlMessageType .SUBSCRIBE , request .toMap ());
173
+ return new GraphQlWebSocketMessage (id , GraphQlWebSocketMessageType .SUBSCRIBE , request .toMap ());
174
174
}
175
175
176
176
/**
177
177
* Create a {@code "next"} server message.
178
178
* @param id unique request id
179
179
* @param responseMap the response map
180
180
*/
181
- public static GraphQlMessage next (String id , Map <String , Object > responseMap ) {
181
+ public static GraphQlWebSocketMessage next (String id , Map <String , Object > responseMap ) {
182
182
Assert .notNull (responseMap , "'responseMap' is required" );
183
- return new GraphQlMessage (id , GraphQlMessageType .NEXT , responseMap );
183
+ return new GraphQlWebSocketMessage (id , GraphQlWebSocketMessageType .NEXT , responseMap );
184
184
}
185
185
186
186
/**
187
187
* Create an {@code "error"} server message.
188
188
* @param id unique request id
189
189
* @param error the error to add as the message payload
190
190
*/
191
- public static GraphQlMessage error (String id , GraphQLError error ) {
191
+ public static GraphQlWebSocketMessage error (String id , GraphQLError error ) {
192
192
Assert .notNull (error , "GraphQlError is required" );
193
193
List <Map <String , Object >> errors = Collections .singletonList (error .toSpecification ());
194
- return new GraphQlMessage (id , GraphQlMessageType .ERROR , errors );
194
+ return new GraphQlWebSocketMessage (id , GraphQlWebSocketMessageType .ERROR , errors );
195
195
}
196
196
197
197
/**
198
198
* Create a {@code "complete"} server message.
199
199
* @param id unique request id
200
200
*/
201
- public static GraphQlMessage complete (String id ) {
202
- return new GraphQlMessage (id , GraphQlMessageType .COMPLETE , null );
201
+ public static GraphQlWebSocketMessage complete (String id ) {
202
+ return new GraphQlWebSocketMessage (id , GraphQlWebSocketMessageType .COMPLETE , null );
203
203
}
204
204
205
205
/**
206
206
* Create a {@code "ping"} client or server message.
207
207
* @param payload an optional payload
208
208
*/
209
- public static GraphQlMessage ping (@ Nullable Object payload ) {
210
- return new GraphQlMessage (null , GraphQlMessageType .PING , payload );
209
+ public static GraphQlWebSocketMessage ping (@ Nullable Object payload ) {
210
+ return new GraphQlWebSocketMessage (null , GraphQlWebSocketMessageType .PING , payload );
211
211
}
212
212
213
213
/**
214
214
* Create a {@code "pong"} client or server message.
215
215
* @param payload an optional payload
216
216
*/
217
- public static GraphQlMessage pong (@ Nullable Object payload ) {
218
- return new GraphQlMessage (null , GraphQlMessageType .PONG , payload );
217
+ public static GraphQlWebSocketMessage pong (@ Nullable Object payload ) {
218
+ return new GraphQlWebSocketMessage (null , GraphQlWebSocketMessageType .PONG , payload );
219
219
}
220
220
221
221
}
0 commit comments