Apache
/
olingo-odata4
mirror of https://github.com/apache/olingo-odata4.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[OLINGO-678] Add a simple client to samples/client that can be run against the current samples/server 

Signed-off-by: Michael Bolz <michael.bolz@sap.com>
This commit is contained in:
Aki Yoshida 2015-05-22 19:40:50 +02:00 committed by Michael Bolz
parent 991e642fd8
commit 02479200ef
8 changed files with 369 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
samples/client/pom.xml
View File

@ -19,14 +19,14 @@
under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>odata-client-samples</artifactId>
<artifactId>odata-client-sample</artifactId>
<packaging>jar</packaging>
<name>${project.artifactId}</name>
<description>Olingo client customization samples.</description>
<parent>
<groupId>org.apache.olingo</groupId>
@ -58,9 +58,45 @@
<dependencies>
<dependency>
<groupId>org.apache.olingo</groupId>
<artifactId>odata-client-proxy</artifactId>
<artifactId>odata-client-core</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>${commons.logging.version}</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>${sl4j.version}</version>
<scope>runtime</scope>
</dependency>
</dependencies>
<profiles>
<profile>
<id>client</id>
<build>
<defaultGoal>test</defaultGoal>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<executions>
<execution>
<phase>test</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<mainClass>org.apache.olingo.samples.client.OlingoSampleApp</mainClass>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>

309
samples/client/src/main/java/org/apache/olingo/samples/client/OlingoSampleApp.java Normal file
View File

@ -0,0 +1,309 @@
/*******************************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.olingo.samples.client;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.apache.olingo.client.api.ODataClient;
import org.apache.olingo.client.api.communication.request.cud.ODataDeleteRequest;
import org.apache.olingo.client.api.communication.request.cud.ODataEntityCreateRequest;
import org.apache.olingo.client.api.communication.request.cud.ODataEntityUpdateRequest;
import org.apache.olingo.client.api.communication.request.cud.UpdateType;
import org.apache.olingo.client.api.communication.request.retrieve.EdmMetadataRequest;
import org.apache.olingo.client.api.communication.request.retrieve.ODataEntityRequest;
import org.apache.olingo.client.api.communication.request.retrieve.ODataEntitySetIteratorRequest;
import org.apache.olingo.client.api.communication.response.ODataDeleteResponse;
import org.apache.olingo.client.api.communication.response.ODataEntityCreateResponse;
import org.apache.olingo.client.api.communication.response.ODataEntityUpdateResponse;
import org.apache.olingo.client.api.communication.response.ODataRetrieveResponse;
import org.apache.olingo.client.api.domain.ClientCollectionValue;
import org.apache.olingo.client.api.domain.ClientComplexValue;
import org.apache.olingo.client.api.domain.ClientEntity;
import org.apache.olingo.client.api.domain.ClientEntitySet;
import org.apache.olingo.client.api.domain.ClientEntitySetIterator;
import org.apache.olingo.client.api.domain.ClientEnumValue;
import org.apache.olingo.client.api.domain.ClientProperty;
import org.apache.olingo.client.api.domain.ClientValue;
import org.apache.olingo.client.api.serialization.ODataDeserializerException;
import org.apache.olingo.client.core.ODataClientFactory;
import org.apache.olingo.commons.api.edm.Edm;
import org.apache.olingo.commons.api.edm.EdmComplexType;
import org.apache.olingo.commons.api.edm.EdmEntityType;
import org.apache.olingo.commons.api.edm.EdmProperty;
import org.apache.olingo.commons.api.edm.EdmSchema;
import org.apache.olingo.commons.api.edm.FullQualifiedName;
import org.apache.olingo.commons.api.format.ContentType;
/**
*
*/
public class OlingoSampleApp {
private ODataClient client;
public OlingoSampleApp() {
client = ODataClientFactory.getClient();
}
public static void main(String[] params) throws Exception {
OlingoSampleApp app = new OlingoSampleApp();
app.perform("http://localhost:8080/cars.svc");
}
void perform(String serviceUrl) throws Exception {
print("\n----- Read Edm ------------------------------");
Edm edm = readEdm(serviceUrl);
List<FullQualifiedName> ctFqns = new ArrayList<FullQualifiedName>();
List<FullQualifiedName> etFqns = new ArrayList<FullQualifiedName>();
for (EdmSchema schema : edm.getSchemas()) {
for (EdmComplexType complexType : schema.getComplexTypes()) {
ctFqns.add(complexType.getFullQualifiedName());
}
for (EdmEntityType entityType : schema.getEntityTypes()) {
etFqns.add(entityType.getFullQualifiedName());
}
}
print("Found ComplexTypes", ctFqns);
print("Found EntityTypes", etFqns);
print("\n----- Inspect each property and its type of the first entity: " + etFqns.get(0) + "----");
EdmEntityType etype = edm.getEntityType(etFqns.get(0));
for (String propertyName : etype.getPropertyNames()) {
EdmProperty property = etype.getStructuralProperty(propertyName);
FullQualifiedName typeName = property.getType().getFullQualifiedName();
print("property '" + propertyName + "' " + typeName);
}
print("\n----- Read Entities ------------------------------");
ClientEntitySetIterator<ClientEntitySet, ClientEntity> iterator =
readEntities(edm, serviceUrl, "Manufacturers");
while (iterator.hasNext()) {
ClientEntity ce = iterator.next();
print("Entry:\n" + prettyPrint(ce.getProperties(), 0));
}
print("\n----- Read Entry ------------------------------");
ClientEntity entry = readEntityWithKey(edm, serviceUrl, "Manufacturers", 1);
print("Single Entry:\n" + prettyPrint(entry.getProperties(), 0));
//
print("\n----- Read Entity with $expand ------------------------------");
entry = readEntityWithKeyExpand(edm, serviceUrl, "Manufacturers", 1, "Cars");
print("Single Entry with expanded Cars relation:\n" + prettyPrint(entry.getProperties(), 0));
//
print("\n----- Read Entities with $filter ------------------------------");
iterator = readEntitiesWithFilter(edm, serviceUrl, "Manufacturers", "Name eq 'Horse Powered Racing'");
while (iterator.hasNext()) {
ClientEntity ce = iterator.next();
print("Entry:\n" + prettyPrint(ce.getProperties(), 0));
}
// skip everything as odata4 sample/server only supporting retrieval
// print("\n----- Create Entry ------------------------------");
// ClientEntity ce = loadEntity("/mymanufacturer.json");
// entry = createEntity(edm, serviceUrl, "Manufacturers", ce);
// print("\n----- Update Entry ------------------------------");
// ce = loadEntity("/mymanufacturer2.json");
// int sc = updateEntity(edm, serviceUrl, "Manufacturers", 123, ce);
// print("Updated successfully: " + sc);
// entry = readEntityWithKey(edm, serviceUrl, "Manufacturers", 123);
// print("Updated Entry successfully: " + prettyPrint(entry.getProperties(), 0));
//
// //
// print("\n----- Delete Entry ------------------------------");
// sc = deleteEntity(serviceUrl, "Manufacturers", 123);
// print("Deletion of Entry was successfully: " + sc);
//
// try {
// print("\n----- Verify Delete Entry ------------------------------");
// readEntityWithKey(edm, serviceUrl, "Manufacturers", 123);
// } catch(Exception e) {
// print(e.getMessage());
// }
}
private static void print(String content) {
System.out.println(content);
}
private static void print(String content, List<?> list) {
System.out.println(content);
for (Object o : list) {
System.out.println(" " + o);
}
System.out.println();
}
private static String prettyPrint(Map<String, Object> properties, int level) {
StringBuilder b = new StringBuilder();
Set<Entry<String, Object>> entries = properties.entrySet();
for (Entry<String, Object> entry : entries) {
intend(b, level);
b.append(entry.getKey()).append(": ");
Object value = entry.getValue();
if(value instanceof Map) {
value = prettyPrint((Map<String, Object>) value, level+1);
} else if(value instanceof Calendar) {
Calendar cal = (Calendar) value;
value = SimpleDateFormat.getInstance().format(cal.getTime());
}
b.append(value).append("\n");
}
// remove last line break
b.deleteCharAt(b.length()-1);
return b.toString();
}
private static String prettyPrint(Collection<ClientProperty> properties, int level) {
StringBuilder b = new StringBuilder();
for (ClientProperty entry : properties) {
intend(b, level);
ClientValue value = entry.getValue();
if (value.isCollection()) {
ClientCollectionValue cclvalue = value.asCollection();
b.append(prettyPrint(cclvalue.asJavaCollection(), level + 1));
} else if (value.isComplex()) {
ClientComplexValue cpxvalue = value.asComplex();
b.append(prettyPrint(cpxvalue.asJavaMap(), level + 1));
} else if (value.isEnum()) {
ClientEnumValue cnmvalue = value.asEnum();
b.append(entry.getName()).append(": ");
b.append(cnmvalue.getValue()).append("\n");
} else if (value.isPrimitive()) {
b.append(entry.getName()).append(": ");
b.append(entry.getValue()).append("\n");
}
}
return b.toString();
}
private static void intend(StringBuilder builder, int intendLevel) {
for (int i = 0; i < intendLevel; i++) {
builder.append(" ");
}
}
public Edm readEdm(String serviceUrl) throws IOException {
EdmMetadataRequest request = client.getRetrieveRequestFactory().getMetadataRequest(serviceUrl);
ODataRetrieveResponse<Edm> response = request.execute();
return response.getBody();
}
public ClientEntitySetIterator<ClientEntitySet, ClientEntity> readEntities(Edm edm, String serviceUri,
String entitySetName) {
URI absoluteUri = client.newURIBuilder(serviceUri).appendEntitySetSegment(entitySetName).build();
return readEntities(edm, absoluteUri);
}
public ClientEntitySetIterator<ClientEntitySet, ClientEntity> readEntitiesWithFilter(Edm edm, String serviceUri,
String entitySetName, String filterName) {
URI absoluteUri = client.newURIBuilder(serviceUri).appendEntitySetSegment(entitySetName).filter(filterName).build();
return readEntities(edm, absoluteUri);
}
private ClientEntitySetIterator<ClientEntitySet, ClientEntity> readEntities(Edm edm, URI absoluteUri) {
System.out.println("URI = " + absoluteUri);
ODataEntitySetIteratorRequest<ClientEntitySet, ClientEntity> request =
client.getRetrieveRequestFactory().getEntitySetIteratorRequest(absoluteUri);
// odata4 sample/server limitation not handling metadata=full
request.setAccept("application/json;odata.metadata=minimal");
ODataRetrieveResponse<ClientEntitySetIterator<ClientEntitySet, ClientEntity>> response = request.execute();
return response.getBody();
}
public ClientEntity readEntityWithKey(Edm edm, String serviceUri, String entitySetName, Object keyValue) {
URI absoluteUri = client.newURIBuilder(serviceUri).appendEntitySetSegment(entitySetName)
.appendKeySegment(keyValue).build();
return readEntity(edm, absoluteUri);
}
public ClientEntity readEntityWithKeyExpand(Edm edm, String serviceUri, String entitySetName, Object keyValue,
String expandRelationName) {
URI absoluteUri = client.newURIBuilder(serviceUri).appendEntitySetSegment(entitySetName).appendKeySegment(keyValue)
.expand(expandRelationName).build();
return readEntity(edm, absoluteUri);
}
private ClientEntity readEntity(Edm edm, URI absoluteUri) {
ODataEntityRequest<ClientEntity> request = client.getRetrieveRequestFactory().getEntityRequest(absoluteUri);
// odata4 sample/server limitation not handling metadata=full
request.setAccept("application/json;odata.metadata=minimal");
ODataRetrieveResponse<ClientEntity> response = request.execute();
return response.getBody();
}
private ClientEntity loadEntity(String path) throws ODataDeserializerException {
InputStream input = getClass().getResourceAsStream(path);
return client.getBinder().getODataEntity(client.getDeserializer(ContentType.APPLICATION_JSON).toEntity(input));
}
public ClientEntity createEntity(Edm edm, String serviceUri, String entitySetName, ClientEntity ce) {
URI absoluteUri = client.newURIBuilder(serviceUri).appendEntitySetSegment(entitySetName).build();
return createEntity(edm, absoluteUri, ce);
}
private ClientEntity createEntity(Edm edm, URI absoluteUri, ClientEntity ce) {
ODataEntityCreateRequest<ClientEntity> request = client.getCUDRequestFactory()
.getEntityCreateRequest(absoluteUri, ce);
// odata4 sample/server limitation not handling metadata=full
request.setAccept("application/json;odata.metadata=minimal");
ODataEntityCreateResponse<ClientEntity> response = request.execute();
return response.getBody();
}
public int updateEntity(Edm edm, String serviceUri, String entityName, Object keyValue, ClientEntity ce) {
URI absoluteUri = client.newURIBuilder(serviceUri).appendEntitySetSegment(entityName)
.appendKeySegment(keyValue).build();
ODataEntityUpdateRequest<ClientEntity> request =
client.getCUDRequestFactory().getEntityUpdateRequest(absoluteUri, UpdateType.PATCH, ce);
// odata4 sample/server limitation not handling metadata=full
request.setAccept("application/json;odata.metadata=minimal");
ODataEntityUpdateResponse<ClientEntity> response = request.execute();
return response.getStatusCode();
}
public int deleteEntity(String serviceUri, String entityName, Object keyValue) throws IOException {
URI absoluteUri = client.newURIBuilder(serviceUri).appendEntitySetSegment(entityName)
.appendKeySegment(keyValue).build();
ODataDeleteRequest request = client.getCUDRequestFactory().getDeleteRequest(absoluteUri);
// odata4 sample/server limitation not handling metadata=full
request.setAccept("application/json;odata.metadata=minimal");
ODataDeleteResponse response = request.execute();
return response.getStatusCode();
}
}

3
samples/client/src/main/java/org/apache/olingo/samples/client/core/http/CookieHttpClientFactory.java
View File

@ -19,12 +19,13 @@
package org.apache.olingo.samples.client.core.http;
import java.net.URI;
import org.apache.http.client.CookieStore;
import org.apache.http.impl.client.BasicCookieStore;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.cookie.BasicClientCookie;
import org.apache.olingo.commons.api.http.HttpMethod;
import org.apache.olingo.client.core.http.DefaultHttpClientFactory;
import org.apache.olingo.commons.api.http.HttpMethod;
/**
* Shows how to work with HTTP cookies.

3
samples/client/src/main/java/org/apache/olingo/samples/client/core/http/CustomConnectionsHttpClientFactory.java
View File

@ -19,6 +19,7 @@
package org.apache.olingo.samples.client.core.http;
import java.net.URI;
import org.apache.http.Header;
import org.apache.http.HttpResponse;
import org.apache.http.HttpResponseFactory;
@ -39,8 +40,8 @@ import org.apache.http.message.BasicLineParser;
import org.apache.http.params.CoreProtocolPNames;
import org.apache.http.params.HttpParams;
import org.apache.http.util.CharArrayBuffer;
import org.apache.olingo.commons.api.http.HttpMethod;
import org.apache.olingo.client.core.http.AbstractHttpClientFactory;
import org.apache.olingo.commons.api.http.HttpMethod;
/**
* Shows how to use custom client connections.

3
samples/client/src/main/java/org/apache/olingo/samples/client/core/http/ParametersHttpClientFactory.java
View File

@ -19,12 +19,13 @@
package org.apache.olingo.samples.client.core.http;
import java.net.URI;
import org.apache.http.HttpVersion;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.params.CoreProtocolPNames;
import org.apache.http.params.HttpConnectionParams;
import org.apache.olingo.commons.api.http.HttpMethod;
import org.apache.olingo.client.core.http.DefaultHttpClientFactory;
import org.apache.olingo.commons.api.http.HttpMethod;
/**
* Shows how to customize the runtime behavior of HTTP client component.

6
samples/client/src/main/resources/mymanufacturer.json Normal file
View File

@ -0,0 +1,6 @@
{
"@odata.context":"$metadata#Manufacturers/$entity",
"Id":123,
"Name":"MyCarManufacturer",
"Address": {"Street": "Main","City": "Fairy City", "ZipCode": "42421", "Country":"FarFarAway"}
}

6
samples/client/src/main/resources/mymanufacturer2.json Normal file
View File

@ -0,0 +1,6 @@
{
"@odata.context":"$metadata#Manufacturers/$entity",
"Id":123,
"Name":"MyCarManufacturer Renamed",
"Address": {"Street": "Main Street","City": "Fairy City", "ZipCode": "42421", "Country":"FarFarAway"}
}

2
samples/pom.xml
View File

@ -33,9 +33,9 @@
<version>4.0.0-SNAPSHOT</version>
<relativePath>..</relativePath>
</parent>
<modules>
<module>server</module>
<module>client</module>
</modules>
<profiles>