Johannes/gson-comments
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

An initial sketch to support queries for REST resources

Browse Source
This commit is contained in:
Inderjeet Singh 2010-11-10 14:53:46 +00:00
parent 32afd1a4e4
commit f2e091127f
5 changed files with 155 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
wsclient/src/main/java/com/google/gson/rest/client/ResourceDepotClient.java
View File

@ -33,7 +33,8 @@ import com.google.gson.webservice.definition.HttpMethod;
*
* @author Inderjeet Singh
*/
public class ResourceDepotClient<I extends ID, R extends RestResource<I, R>> implements ResourceDepot<I, R> {
public class ResourceDepotClient<I extends ID, R extends RestResource<I, R>>
implements ResourceDepot<I, R> {
private final RestClientStub stub;
private final RestCallSpec callSpec;
private final Type resourceType;

83
wsclient/src/main/java/com/google/gson/rest/query/client/ResourceQueryClient.java Normal file
View File

@ -0,0 +1,83 @@
/*
* Copyright (C) 2010 Google Inc.
*
* 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 com.google.gson.rest.query.client;
import java.util.List;
import com.google.gson.Gson;
import com.google.gson.rest.definition.ID;
import com.google.gson.rest.definition.RestResource;
import com.google.gson.rest.query.ResourceQuery;
import com.google.gson.rest.query.TypedKeysQuery;
import com.google.gson.webservice.client.WebServiceClient;
import com.google.gson.webservice.definition.CallPath;
import com.google.gson.webservice.definition.HeaderMap;
import com.google.gson.webservice.definition.HttpMethod;
import com.google.gson.webservice.definition.procedural.RequestBody;
import com.google.gson.webservice.definition.procedural.ResponseBody;
import com.google.gson.webservice.definition.procedural.WebServiceCallSpec;
import com.google.gson.webservice.definition.procedural.WebServiceRequest;
import com.google.gson.webservice.definition.procedural.WebServiceResponse;
/**
* A client to invoke {@link ResourceQuery}s associated with a REST resource
*
* @author Inderjeet Singh
*
* @param <I> ID type of the REST resource
* @param <R> type of the REST resource
* @param <Q> Query parameters
*/
public class ResourceQueryClient<I extends ID, R extends RestResource<I, R>, Q>
implements ResourceQuery<I, R, Q> {
private final WebServiceClient stub;
private final WebServiceCallSpec callSpec;
private final Gson gson;
/**
* @param stub stub containing server info to access the rest client
* @param callPath relative path to the resource
*/
public ResourceQueryClient(WebServiceClient stub, CallPath callPath, Gson gson) {
this(stub, generateCallSpec(callPath), gson);
}
protected ResourceQueryClient(WebServiceClient stub, WebServiceCallSpec callSpec, Gson gson) {
this.stub = stub;
this.callSpec = callSpec;
this.gson = gson;
}
private static <T> WebServiceCallSpec generateCallSpec(CallPath callPath) {
return new WebServiceCallSpec.Builder(callPath).supportsHttpMethod(HttpMethod.GET).build();
}
@SuppressWarnings({"unchecked", "rawtypes"})
@Override
public List<R> query(Q query) {
HeaderMap requestHeaders =
new HeaderMap.Builder(callSpec.getRequestSpec().getHeadersSpec()).build();
RequestBody requestBody =
new RequestBody.Builder(callSpec.getRequestSpec().getBodySpec())
.build();
WebServiceRequest request = new WebServiceRequest(HttpMethod.GET, requestHeaders, requestBody);
WebServiceResponse response = stub.getResponse(callSpec, request, gson);
ResponseBody body = response.getBody();
List list = body.get(TypedKeysQuery.RESOURCE_LIST);
return list;
}
}

13
wsdef/src/main/java/com/google/gson/rest/definition/Queryable.java
View File

@ -1,13 +0,0 @@
// Copyright 2010 Google Inc. All Rights Reserved.
package com.google.gson.rest.definition;
/**
* Implement this interface in a service to indicate that it allows querying
* by this type
*
* @author Inderjeet Singh
*/
public interface Queryable<QUERY, RESULTS> {
public RESULTS query(QUERY query);
}

33
wsdef/src/main/java/com/google/gson/rest/query/ResourceQuery.java Normal file
View File

@ -0,0 +1,33 @@
/*
* Copyright (C) 2010 Google Inc.
*
* 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 com.google.gson.rest.query;
import java.util.List;
import com.google.gson.rest.definition.ID;
import com.google.gson.rest.definition.RestResource;
/**
* A query for a list of rest resources.
*
* @author Inderjeet Singh
*/
public interface ResourceQuery<I extends ID, R extends RestResource<I, R>, QUERY> {
/**
* Returns a list of resources matching the query
*/
public List<R> query(QUERY query);
}

37
wsdef/src/main/java/com/google/gson/rest/query/TypedKeysQuery.java Normal file
View File

@ -0,0 +1,37 @@
/*
* Copyright (C) 2010 Google Inc.
*
* 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 com.google.gson.rest.query;
import java.util.List;
import com.google.gson.rest.definition.ID;
import com.google.gson.rest.definition.RestResource;
import com.google.gson.webservice.definition.TypedKey;
/**
* List of {@link TypedKey}s associated with REST queries
*
* @author Inderjeet Singh
*
* @param <I> ID type of the REST resource
* @param <R> The type of the REST resource
*/
@SuppressWarnings("rawtypes")
public class TypedKeysQuery<I extends ID, R extends RestResource<I, R>> {
// TODO(inder): This should really be TypedKey<List<R>>
public static TypedKey<List> RESOURCE_LIST = new TypedKey<List>("resourceList", List.class);
}