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

[OLINGO-708] Merge branch 'master' into OLINGO-708_AsyncSupportTec

This commit is contained in:
Michael Bolz 2015-07-10 10:53:47 +02:00
parent bf3905a550 b484f7f648
commit 6b6902f284
27 changed files with 1255 additions and 1008 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
fit/src/test/java/org/apache/olingo/fit/v4/BatchTestITCase.java
View File

@ -26,10 +26,8 @@ import static org.junit.Assert.fail;
import java.io.IOException;
import java.math.BigDecimal;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Calendar;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;

9
lib/server-api/src/main/java/org/apache/olingo/server/api/OData.java
View File

@ -26,6 +26,7 @@ import org.apache.olingo.commons.api.edm.EdmPrimitiveType;
import org.apache.olingo.commons.api.edm.EdmPrimitiveTypeKind;
import org.apache.olingo.commons.api.edm.provider.CsdlEdmProvider;
import org.apache.olingo.commons.api.format.ContentType;
import org.apache.olingo.server.api.debug.DebugResponseHelper;
import org.apache.olingo.server.api.deserializer.DeserializerException;
import org.apache.olingo.server.api.deserializer.FixedFormatDeserializer;
import org.apache.olingo.server.api.deserializer.ODataDeserializer;
@ -143,4 +144,12 @@ public abstract class OData {
* It can be used in Processor implementations.
*/
public abstract Preferences createPreferences(Collection<String> preferHeaders);
/**
* This method creates a DebugResponseHelper for the given debugFormat. If the format is not supported no
* exception is thrown. Instead we give back the implementation for the json format.
* @param debugFormat to be used.
* @return a debug response serializer
*/
public abstract DebugResponseHelper createDebugResponseHelper(String debugFormat);
}

7
lib/server-api/src/main/java/org/apache/olingo/server/api/ODataHttpHandler.java
View File

@ -21,6 +21,7 @@ package org.apache.olingo.server.api;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.olingo.server.api.debug.DebugSupport;
import org.apache.olingo.server.api.etag.CustomETagSupport;
import org.apache.olingo.server.api.processor.Processor;
import org.apache.olingo.server.api.serializer.CustomContentTypeSupport;
@ -66,4 +67,10 @@ public interface ODataHttpHandler {
*/
void register(CustomETagSupport customConcurrencyControlSupport);
/**
* Register the debug support handler
* @param debugSupport
*/
void register(DebugSupport debugSupport);
}

38
lib/server-api/src/main/java/org/apache/olingo/server/api/debug/DebugResponseHelper.java Normal file
View File

@ -0,0 +1,38 @@
/*
* 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.server.api.debug;
import org.apache.olingo.server.api.ODataRequest;
import org.apache.olingo.server.api.ODataResponse;
/**
* This class supports applications in creating debug responses.
*/
public interface DebugResponseHelper {
/**
* Creates a debug response based on the given parameters. Will never throw an exception.
* @param request
* @param applicationResponse
* @param exception
* @return the debug response or the raw application response in case an exception occurred.
*/
ODataResponse createDebugResponse(ODataRequest request, ODataResponse applicationResponse, Exception exception);
}

49
lib/server-api/src/main/java/org/apache/olingo/server/api/debug/DebugSupport.java Normal file
View File

@ -0,0 +1,49 @@
/*
* 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.server.api.debug;
import org.apache.olingo.server.api.OData;
import org.apache.olingo.server.api.ODataRequest;
import org.apache.olingo.server.api.ODataResponse;
/**
* Register this interface to add debug support to your service.
*/
public interface DebugSupport {
public static final String ODATA_DEBUG_QUERY_PARAMETER = "odata-debug";
public static final String ODATA_DEBUG_JSON = "json";
public static final String ODATA_DEBUG_HTML = "html";
public static final String ODATA_DEBUG_DOWNLOAD = "download";
void init(OData odata);
/**
* This method should create a debug response and deliver it back to the Olingo library. This method MUST NEVER throw
* an exception.
* @param debugFormat which is requested via the odata-debug query parameter
* @param request object which was send to the server
* @param response object which was filled by the application
* @param exception which has been thrown. Might be null in case there was no exception
* @return a new debug response which will be send to the client
*/
ODataResponse createDebugResponse(String debugFormat, ODataRequest request, ODataResponse response,
Exception exception);
}

52
lib/server-api/src/main/java/org/apache/olingo/server/api/debug/DefaultDebugSupport.java Normal file
View File

@ -0,0 +1,52 @@
/*
* 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.server.api.debug;
import org.apache.olingo.server.api.OData;
import org.apache.olingo.server.api.ODataRequest;
import org.apache.olingo.server.api.ODataResponse;
/**
* Supports the default debug case. Will always deliver a debug response if requested from the server.
*/
public class DefaultDebugSupport implements DebugSupport {
private OData odata;
@Override
public void init(OData odata) {
this.odata = odata;
}
@Override
public ODataResponse createDebugResponse(String debugFormat, ODataRequest request, ODataResponse applicationResponse,
Exception exception) {
// Check if debugFormat is supported by the library
if (DebugSupport.ODATA_DEBUG_JSON.equalsIgnoreCase(debugFormat)
|| DebugSupport.ODATA_DEBUG_HTML.equalsIgnoreCase(debugFormat)
|| DebugSupport.ODATA_DEBUG_DOWNLOAD.equalsIgnoreCase(debugFormat)) {
return odata.createDebugResponseHelper(debugFormat).createDebugResponse(request, applicationResponse, exception);
} else {
// Debug format is not supported by the library by default so in order to avoid an exception we will just give
// back the original response from the application.
return applicationResponse;
}
}
}

33
lib/server-core/src/main/java/org/apache/olingo/server/core/ODataHttpHandlerImpl.java
View File

@ -6,9 +6,9 @@
* 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
@ -40,6 +40,7 @@ import org.apache.olingo.server.api.ODataRequest;
import org.apache.olingo.server.api.ODataResponse;
import org.apache.olingo.server.api.ODataLibraryException;
import org.apache.olingo.server.api.ServiceMetadata;
import org.apache.olingo.server.api.debug.DebugSupport;
import org.apache.olingo.server.api.etag.CustomETagSupport;
import org.apache.olingo.server.api.processor.Processor;
import org.apache.olingo.server.api.serializer.CustomContentTypeSupport;
@ -51,7 +52,8 @@ public class ODataHttpHandlerImpl implements ODataHttpHandler {
private static final Logger LOG = LoggerFactory.getLogger(ODataHttpHandlerImpl.class);
private ODataHandler handler;
private final ODataHandler handler;
private DebugSupport debugSupport;
private int split = 0;
public ODataHttpHandlerImpl(final OData odata, final ServiceMetadata serviceMetadata) {
@ -60,6 +62,7 @@ public class ODataHttpHandlerImpl implements ODataHttpHandler {
@Override
public void process(final HttpServletRequest request, final HttpServletResponse response) {
Exception exception = null;
ODataRequest odRequest = null;
ODataResponse odResponse;
try {
@ -68,12 +71,27 @@ public class ODataHttpHandlerImpl implements ODataHttpHandler {
odResponse = handler.process(odRequest);
// ALL future methods after process must not throw exceptions!
} catch (Exception e) {
exception = e;
odResponse = handleException(odRequest, e);
}
if (debugSupport != null) {
String debugFormat = getDebugQueryParameter(request);
if (debugFormat != null) {
// TODO: Should we be more careful here with response assignement in order to not loose the original response?
// TODO: How should we react to exceptions here?
odResponse = debugSupport.createDebugResponse(debugFormat, odRequest, odResponse, exception);
}
}
convertToHttp(response, odResponse);
}
private String getDebugQueryParameter(HttpServletRequest request) {
// TODO Auto-generated method stub
return "";
}
@Override
public void setSplit(final int split) {
this.split = split;
@ -132,7 +150,7 @@ public class ODataHttpHandlerImpl implements ODataHttpHandler {
private ODataRequest fillODataRequest(final ODataRequest odRequest, final HttpServletRequest httpRequest,
final int split)
throws ODataLibraryException {
throws ODataLibraryException {
try {
odRequest.setBody(httpRequest.getInputStream());
extractHeaders(odRequest, httpRequest);
@ -243,9 +261,14 @@ public class ODataHttpHandlerImpl implements ODataHttpHandler {
public void register(final CustomContentTypeSupport customContentTypeSupport) {
handler.register(customContentTypeSupport);
}
@Override
public void register(final CustomETagSupport customConcurrencyControlSupport) {
handler.register(customConcurrencyControlSupport);
}
@Override
public void register(final DebugSupport debugSupport) {
this.debugSupport = debugSupport;
}
}

9
lib/server-core/src/main/java/org/apache/olingo/server/core/ODataImpl.java
View File

@ -29,6 +29,7 @@ import org.apache.olingo.commons.core.edm.primitivetype.EdmPrimitiveTypeFactory;
import org.apache.olingo.server.api.OData;
import org.apache.olingo.server.api.ODataHttpHandler;
import org.apache.olingo.server.api.ServiceMetadata;
import org.apache.olingo.server.api.debug.DebugResponseHelper;
import org.apache.olingo.server.api.deserializer.DeserializerException;
import org.apache.olingo.server.api.deserializer.FixedFormatDeserializer;
import org.apache.olingo.server.api.deserializer.ODataDeserializer;
@ -40,6 +41,7 @@ import org.apache.olingo.server.api.serializer.FixedFormatSerializer;
import org.apache.olingo.server.api.serializer.ODataSerializer;
import org.apache.olingo.server.api.serializer.SerializerException;
import org.apache.olingo.server.api.uri.UriHelper;
import org.apache.olingo.server.core.debug.DebugResponseHelperImpl;
import org.apache.olingo.server.core.deserializer.FixedFormatDeserializerImpl;
import org.apache.olingo.server.core.deserializer.json.ODataJsonDeserializer;
import org.apache.olingo.server.core.etag.ETagHelperImpl;
@ -139,4 +141,11 @@ public class ODataImpl extends OData {
return new PreferencesImpl(preferHeaders);
}
@Override
public DebugResponseHelper createDebugResponseHelper(String debugFormat) {
//TODO: What should we do with invalid formats?
//TODO: Support more debug formats
return new DebugResponseHelperImpl();
}
}

33
lib/server-core/src/main/java/org/apache/olingo/server/core/debug/DebugResponseHelperImpl.java Normal file
View File

@ -0,0 +1,33 @@
/*
* 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.server.core.debug;
import org.apache.olingo.server.api.ODataRequest;
import org.apache.olingo.server.api.ODataResponse;
import org.apache.olingo.server.api.debug.DebugResponseHelper;
public class DebugResponseHelperImpl implements DebugResponseHelper {
@Override
public ODataResponse
createDebugResponse(ODataRequest request, ODataResponse applicationResponse, Exception exception) {
return applicationResponse;
}
}

223
lib/server-core/src/main/java/org/apache/olingo/server/core/deserializer/batch/BatchLineReader.java Normal file
View File

@ -0,0 +1,223 @@
/*
* 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.server.core.deserializer.batch;
import org.apache.olingo.commons.api.format.ContentType;
import org.apache.olingo.commons.api.http.HttpHeader;
import java.io.IOException;
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
public class BatchLineReader {
private static final byte CR = '\r';
private static final byte LF = '\n';
private static final int EOF = -1;
private static final int BUFFER_SIZE = 8192;
private static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
private static final Charset CS_ISO_8859_1 = Charset.forName("iso-8859-1");
public static final String BOUNDARY = "boundary";
public static final String DOUBLE_DASH = "--";
public static final String CRLF = "\r\n";
private Charset currentCharset = DEFAULT_CHARSET;
private String currentBoundary = null;
private ReadState readState = new ReadState();
private InputStream reader;
private byte[] buffer;
private int offset = 0;
private int limit = 0;
public BatchLineReader(final InputStream reader) {
this(reader, BUFFER_SIZE);
}
public BatchLineReader(final InputStream reader, final int bufferSize) {
if (bufferSize <= 0) {
throw new IllegalArgumentException("Buffer size must be greater than zero.");
}
this.reader = reader;
buffer = new byte[bufferSize];
}
public void close() throws IOException {
reader.close();
}
public List<String> toList() throws IOException {
final List<String> result = new ArrayList<String>();
String currentLine = readLine();
if(currentLine != null) {
currentBoundary = currentLine.trim();
result.add(currentLine);
while ((currentLine = readLine()) != null) {
result.add(currentLine);
}
}
return result;
}
public List<Line> toLineList() throws IOException {
final List<Line> result = new ArrayList<Line>();
String currentLine = readLine();
if(currentLine != null) {
currentBoundary = currentLine.trim();
int counter = 1;
result.add(new Line(currentLine, counter++));
while ((currentLine = readLine()) != null) {
result.add(new Line(currentLine, counter++));
}
}
return result;
}
private void updateCurrentCharset(String currentLine) {
if(currentLine != null) {
if(currentLine.startsWith(HttpHeader.CONTENT_TYPE)) {
currentLine = currentLine.substring(13, currentLine.length() - 2).trim();
ContentType ct = ContentType.parse(currentLine);
if (ct != null) {
String charsetString = ct.getParameter(ContentType.PARAMETER_CHARSET);
if (charsetString != null) {
currentCharset = Charset.forName(charsetString);
} else {
currentCharset = DEFAULT_CHARSET;
}
// boundary
String boundary = ct.getParameter(BOUNDARY);
if (boundary != null) {
currentBoundary = DOUBLE_DASH + boundary;
}
}
} else if(CRLF.equals(currentLine)) {
readState.foundLinebreak();
} else if(isBoundary(currentLine)) {
readState.foundBoundary();
}
}
}
private boolean isBoundary(String currentLine) {
if((currentBoundary + CRLF).equals(currentLine)) {
return true;
} else if((currentBoundary + DOUBLE_DASH + CRLF).equals(currentLine)) {
return true;
}
return false;
}
String readLine() throws IOException {
if (limit == EOF) {
return null;
}
ByteBuffer buffer = ByteBuffer.allocate(BUFFER_SIZE);
boolean foundLineEnd = false; // EOF will be considered as line ending
while (!foundLineEnd) {
// Is buffer refill required?
if (limit == offset) {
if (fillBuffer() == EOF) {
foundLineEnd = true;
}
}
if (!foundLineEnd) {
byte currentChar = this.buffer[offset++];
if(!buffer.hasRemaining()) {
buffer.flip();
ByteBuffer tmp = ByteBuffer.allocate(buffer.limit() *2);
tmp.put(buffer);
buffer = tmp;
}
buffer.put(currentChar);
if (currentChar == LF) {
foundLineEnd = true;
} else if (currentChar == CR) {
foundLineEnd = true;
// Check next byte. Consume \n if available
// Is buffer refill required?
if (limit == offset) {
fillBuffer();
}
// Check if there is at least one character
if (limit != EOF && this.buffer[offset] == LF) {
buffer.put(LF);
offset++;
}
}
}
}
if(buffer.position() == 0) {
return null;
} else {
String currentLine;
if(readState.isReadBody()) {
currentLine = new String(buffer.array(), 0, buffer.position(), getCurrentCharset());
} else {
currentLine = new String(buffer.array(), 0, buffer.position(), CS_ISO_8859_1);
}
updateCurrentCharset(currentLine);
return currentLine;
}
}
private int fillBuffer() throws IOException {
limit = reader.read(buffer, 0, buffer.length);
offset = 0;
return limit;
}
private Charset getCurrentCharset() {
return currentCharset;
}
/**
* Read state indicator (whether currently the <code>body</code> or <code>header</code> part is read).
*/
private class ReadState {
private int state = 0;
public void foundLinebreak() {
state++;
}
public void foundBoundary() {
state = 0;
}
public boolean isReadBody() {
return state >= 2;
}
@Override
public String toString() {
return String.valueOf(state);
}
}
}

3
lib/server-core/src/main/java/org/apache/olingo/server/core/deserializer/batch/BatchParser.java
View File

@ -20,7 +20,6 @@ package org.apache.olingo.server.core.deserializer.batch;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.LinkedList;
import java.util.List;
@ -74,7 +73,7 @@ public class BatchParser {
private List<List<Line>> splitBodyParts(final InputStream in, final String boundary) throws IOException,
BatchDeserializerException {
final BufferedReaderIncludingLineEndings reader = new BufferedReaderIncludingLineEndings(new InputStreamReader(in));
final BatchLineReader reader = new BatchLineReader(in);
final List<Line> message = reader.toLineList();
reader.close();

233
lib/server-core/src/main/java/org/apache/olingo/server/core/deserializer/batch/BufferedReaderIncludingLineEndings.java
View File

@ -1,233 +0,0 @@
/*
* 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.server.core.deserializer.batch;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;
public class BufferedReaderIncludingLineEndings extends Reader {
private static final char CR = '\r';
private static final char LF = '\n';
private static final int EOF = -1;
private static final int BUFFER_SIZE = 8192;
private Reader reader;
private char[] buffer;
private int offset = 0;
private int limit = 0;
public BufferedReaderIncludingLineEndings(final Reader reader) {
this(reader, BUFFER_SIZE);
}
public BufferedReaderIncludingLineEndings(final Reader reader, final int bufferSize) {
if (bufferSize <= 0) {
throw new IllegalArgumentException("Buffer size must be greater than zero.");
}
this.reader = reader;
buffer = new char[bufferSize];
}
@Override
public int read(final char[] charBuffer, final int bufferOffset, final int length) throws IOException {
if ((bufferOffset + length) > charBuffer.length) {
throw new IndexOutOfBoundsException("Buffer is too small");
}
if (length < 0 || bufferOffset < 0) {
throw new IndexOutOfBoundsException("Offset and length must be grater than zero");
}
// Check if buffer is filled. Return if EOF is reached
// Is buffer refill required
if (limit == offset || isEOF()) {
fillBuffer();
if (isEOF()) {
return EOF;
}
}
int bytesRead = 0;
int bytesToRead = length;
int currentOutputOffset = bufferOffset;
while (bytesToRead != 0) {
// Is buffer refill required?
if (limit == offset) {
fillBuffer();
if (isEOF()) {
bytesToRead = 0;
}
}
if (bytesToRead > 0) {
int readByte = Math.min(limit - offset, bytesToRead);
bytesRead += readByte;
bytesToRead -= readByte;
for (int i = 0; i < readByte; i++) {
charBuffer[currentOutputOffset++] = buffer[offset++];
}
}
}
return bytesRead;
}
public List<String> toList() throws IOException {
final List<String> result = new ArrayList<String>();
String currentLine;
while ((currentLine = readLine()) != null) {
result.add(currentLine);
}
return result;
}
public List<Line> toLineList() throws IOException {
final List<Line> result = new ArrayList<Line>();
String currentLine;
int counter = 1;
while ((currentLine = readLine()) != null) {
result.add(new Line(currentLine, counter++));
}
return result;
}
public String readLine() throws IOException {
if (limit == EOF) {
return null;
}
final StringBuilder stringBuffer = new StringBuilder();
boolean foundLineEnd = false; // EOF will be considered as line ending
while (!foundLineEnd) {
// Is buffer refill required?
if (limit == offset) {
if (fillBuffer() == EOF) {
foundLineEnd = true;
}
}
if (!foundLineEnd) {
char currentChar = buffer[offset++];
stringBuffer.append(currentChar);
if (currentChar == LF) {
foundLineEnd = true;
} else if (currentChar == CR) {
foundLineEnd = true;
// Check next char. Consume \n if available
// Is buffer refill required?
if (limit == offset) {
fillBuffer();
}
// Check if there is at least one character
if (limit != EOF && buffer[offset] == LF) {
stringBuffer.append(LF);
offset++;
}
}
}
}
return (stringBuffer.length() == 0) ? null : stringBuffer.toString();
}
@Override
public void close() throws IOException {
reader.close();
}
@Override
public boolean ready() throws IOException {
// Not EOF and buffer refill is not required
return !isEOF() && !(limit == offset);
}
@Override
public void reset() throws IOException {
throw new IOException("Reset is not supported");
}
@Override
public void mark(final int readAheadLimit) throws IOException {
throw new IOException("Mark is not supported");
}
@Override
public boolean markSupported() {
return false;
}
@Override
public long skip(final long n) throws IOException {
if (n == 0) {
return 0;
} else if (n < 0) {
throw new IllegalArgumentException("skip value is negative");
} else {
long charactersToSkip = n;
long charactersSkiped = 0;
while (charactersToSkip != 0) {
// Is buffer refill required?
if (limit == offset) {
fillBuffer();
if (isEOF()) {
charactersToSkip = 0;
}
}
// Check if more characters are available
if (!isEOF()) {
int skipChars = (int) Math.min(limit - offset, charactersToSkip);
charactersSkiped += skipChars;
charactersToSkip -= skipChars;
offset += skipChars;
}
}
return charactersSkiped;
}
}
private boolean isEOF() {
return limit == EOF;
}
private int fillBuffer() throws IOException {
limit = reader.read(buffer, 0, buffer.length);
offset = 0;
return limit;
}
}

148
lib/server-core/src/main/java/org/apache/olingo/server/core/serializer/BatchResponseSerializer.java
View File

@ -22,6 +22,12 @@ import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.nio.channels.Channels;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.WritableByteChannel;
import java.nio.charset.Charset;
import java.util.List;
import java.util.Map;
import java.util.UUID;
@ -45,14 +51,14 @@ public class BatchResponseSerializer {
public InputStream serialize(final List<ODataResponsePart> responses, final String boundary)
throws BatchSerializerException {
StringBuilder builder = createBody(responses, boundary);
BodyBuilder builder = createBody(responses, boundary);
return new ByteArrayInputStream(builder.toString().getBytes());
return new ByteArrayInputStream(builder.getContent());
}
private StringBuilder createBody(final List<ODataResponsePart> batchResponses, final String boundary)
private BodyBuilder createBody(final List<ODataResponsePart> batchResponses, final String boundary)
throws BatchSerializerException {
final StringBuilder builder = new StringBuilder();
final BodyBuilder builder = new BodyBuilder();
for (final ODataResponsePart part : batchResponses) {
builder.append(getDashBoundary(boundary));
@ -68,7 +74,7 @@ public class BatchResponseSerializer {
return builder;
}
private void appendChangeSet(final ODataResponsePart part, final StringBuilder builder)
private void appendChangeSet(final ODataResponsePart part, final BodyBuilder builder)
throws BatchSerializerException {
final String changeSetBoundary = generateBoundary("changeset");
@ -83,50 +89,27 @@ public class BatchResponseSerializer {
builder.append(getCloseDelimiter(changeSetBoundary));
}
private void appendBodyPart(final ODataResponse response, final StringBuilder builder, final boolean isChangeSet)
private void appendBodyPart(final ODataResponse response, final BodyBuilder builder, final boolean isChangeSet)
throws BatchSerializerException {
byte[] body = getBody(response);
appendBodyPartHeader(response, builder, isChangeSet);
builder.append(CRLF);
appendStatusLine(response, builder);
appendResponseHeader(response, body.length, builder);
Body body = new Body(response);
appendResponseHeader(response, body.getLength(), builder);
builder.append(CRLF);
builder.append(new String(body));
builder.append(body);
builder.append(CRLF);
}
private byte[] getBody(final ODataResponse response) {
final InputStream content = response.getContent();
final ByteArrayOutputStream out = new ByteArrayOutputStream();
if (content != null) {
byte[] buffer = new byte[BUFFER_SIZE];
int n;
try {
while ((n = content.read(buffer, 0, buffer.length)) != -1) {
out.write(buffer, 0, n);
}
out.flush();
} catch (IOException e) {
throw new ODataRuntimeException(e);
}
return out.toByteArray();
} else {
return new byte[0];
}
}
private void appendChangeSetHeader(final StringBuilder builder, final String changeSetBoundary) {
private void appendChangeSetHeader(final BodyBuilder builder, final String changeSetBoundary) {
appendHeader(HttpHeader.CONTENT_TYPE, HttpContentType.MULTIPART_MIXED + "; boundary="
+ changeSetBoundary, builder);
}
private void appendHeader(final String name, final String value, final StringBuilder builder) {
private void appendHeader(final String name, final String value, final BodyBuilder builder) {
builder.append(name)
.append(COLON)
.append(SP)
@ -134,7 +117,7 @@ public class BatchResponseSerializer {
.append(CRLF);
}
private void appendStatusLine(final ODataResponse response, final StringBuilder builder) {
private void appendStatusLine(final ODataResponse response, final BodyBuilder builder) {
builder.append("HTTP/1.1")
.append(SP)
.append(response.getStatusCode())
@ -144,7 +127,7 @@ public class BatchResponseSerializer {
}
private void appendResponseHeader(final ODataResponse response, final int contentLength,
final StringBuilder builder) {
final BodyBuilder builder) {
final Map<String, String> header = response.getHeaders();
for (final String key : header.keySet()) {
@ -157,7 +140,7 @@ public class BatchResponseSerializer {
appendHeader(HttpHeader.CONTENT_LENGTH, "" + contentLength, builder);
}
private void appendBodyPartHeader(final ODataResponse response, final StringBuilder builder,
private void appendBodyPartHeader(final ODataResponse response, final BodyBuilder builder,
final boolean isChangeSet) throws BatchSerializerException {
appendHeader(HttpHeader.CONTENT_TYPE, HttpContentType.APPLICATION_HTTP, builder);
appendHeader(BatchParserCommon.CONTENT_TRANSFER_ENCODING, BatchParserCommon.BINARY_ENCODING, builder);
@ -182,4 +165,93 @@ public class BatchResponseSerializer {
private String generateBoundary(final String value) {
return value + "_" + UUID.randomUUID().toString();
}
}
/**
* Builder class to create the body and the header.
*/
private class BodyBuilder {
private final Charset CHARSET_ISO_8859_1 = Charset.forName("iso-8859-1");
private ByteBuffer buffer = ByteBuffer.allocate(8192);
private boolean isClosed = false;
public byte[] getContent() {
isClosed = true;
byte[] tmp = new byte[buffer.position()];
buffer.flip();
buffer.get(tmp, 0, buffer.limit());
return tmp;
}
public BodyBuilder append(String string) {
byte [] b = string.getBytes(CHARSET_ISO_8859_1);
put(b);
return this;
}
private void put(byte[] b) {
if(isClosed) {
throw new RuntimeException("BodyBuilder is closed.");
}
if(buffer.remaining() < b.length) {
buffer.flip();
ByteBuffer tmp = ByteBuffer.allocate(buffer.limit() *2);
tmp.put(buffer);
buffer = tmp;
}
buffer.put(b);
}
public BodyBuilder append(int statusCode) {
return append(String.valueOf(statusCode));
}
public BodyBuilder append(Body body) {
put(body.getContent());
return this;
}
public String toString() {
return new String(buffer.array(), 0, buffer.position());
}
}
/**
* Body part which is read and stored as bytes (no charset conversion).
*/
private class Body {
private final byte[] content;
public Body(ODataResponse response) {
this.content = getBody(response);
}
public int getLength() {
return content.length;
}
public byte[] getContent() {
return content;
}
private byte[] getBody(final ODataResponse response) {
if (response == null || response.getContent() == null) {
return new byte[0];
}
try {
ByteArrayOutputStream output = new ByteArrayOutputStream();
ByteBuffer inBuffer = ByteBuffer.allocate(BUFFER_SIZE);
ReadableByteChannel ic = Channels.newChannel(response.getContent());
WritableByteChannel oc = Channels.newChannel(output);
while (ic.read(inBuffer) > 0) {
inBuffer.flip();
oc.write(inBuffer);
inBuffer.rewind();
}
return output.toByteArray();
} catch (IOException e) {
throw new ODataRuntimeException("Error on reading request content");
}
}
}
}

1
lib/server-core/src/main/java/org/apache/olingo/server/core/serializer/json/ODataJsonSerializer.java
View File

@ -69,7 +69,6 @@ import org.slf4j.LoggerFactory;
import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
public class ODataJsonSerializer implements ODataSerializer {

19
lib/server-core/src/test/java/org/apache/olingo/server/core/batchhandler/MockedBatchHandlerTest.java
View File

@ -26,7 +26,6 @@ import static org.mockito.Mockito.when;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
@ -54,7 +53,7 @@ import org.apache.olingo.server.api.processor.BatchProcessor;
import org.apache.olingo.server.api.serializer.BatchSerializerException;
import org.apache.olingo.server.core.ODataHandler;
import org.apache.olingo.server.core.deserializer.batch.BatchParserCommon;
import org.apache.olingo.server.core.deserializer.batch.BufferedReaderIncludingLineEndings;
import org.apache.olingo.server.core.deserializer.batch.BatchLineReader;
import org.junit.Before;
import org.junit.Test;
import org.mockito.invocation.InvocationOnMock;
@ -149,8 +148,8 @@ public class MockedBatchHandlerTest {
batchHandler.process(request, response, true);
BufferedReaderIncludingLineEndings reader =
new BufferedReaderIncludingLineEndings(new InputStreamReader(response.getContent()));
BatchLineReader reader =
new BatchLineReader(response.getContent());
final List<String> responseContent = reader.toList();
reader.close();
@ -220,8 +219,8 @@ public class MockedBatchHandlerTest {
batchHandler.process(request, response, true);
BufferedReaderIncludingLineEndings reader =
new BufferedReaderIncludingLineEndings(new InputStreamReader(response.getContent()));
BatchLineReader reader =
new BatchLineReader(response.getContent());
final List<String> responseContent = reader.toList();
int line = 0;
@ -299,8 +298,8 @@ public class MockedBatchHandlerTest {
batchHandler.process(request, response, true);
BufferedReaderIncludingLineEndings reader =
new BufferedReaderIncludingLineEndings(new InputStreamReader(response.getContent()));
BatchLineReader reader =
new BatchLineReader(response.getContent());
final List<String> responseContent = reader.toList();
reader.close();
@ -417,8 +416,8 @@ public class MockedBatchHandlerTest {
batchHandler.process(request, response, true);
BufferedReaderIncludingLineEndings reader =
new BufferedReaderIncludingLineEndings(new InputStreamReader(response.getContent()));
BatchLineReader reader =
new BatchLineReader(response.getContent());
final List<String> responseContent = reader.toList();
reader.close();

257
lib/server-core/src/test/java/org/apache/olingo/server/core/deserializer/batch/BatchLineReaderTest.java Normal file
View File

@ -0,0 +1,257 @@
/*
* 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.server.core.deserializer.batch;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import java.io.ByteArrayInputStream;
import java.util.List;
import org.junit.Test;
public class BatchLineReaderTest {
private static final String TEXT_COMBINED = "Test\r" +
"Test2\r\n" +
"Test3\n" +
"Test4\r" +
"\r" +
"\r\n" +
"\r\n" +
"Test5\n" +
"Test6\r\n" +
"Test7\n" +
"\n";
private static final String TEXT_EMPTY = "";
@Test
public void testSimpleText() throws Exception {
final String TEXT = "Test";
BatchLineReader reader = create(TEXT);
assertEquals(TEXT, reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testNoText() throws Exception {
final String TEXT = "";
BatchLineReader reader = create(TEXT);
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testNoBytes() throws Exception {
BatchLineReader reader =
new BatchLineReader(new ByteArrayInputStream(new byte[0]));
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCRLF() throws Exception {
final String TEXT = "Test\r\n" +
"Test2";
BatchLineReader reader = create(TEXT);
assertEquals("Test\r\n", reader.readLine());
assertEquals("Test2", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testLF() throws Exception {
final String TEXT = "Test\n" +
"Test2";
BatchLineReader reader = create(TEXT);
assertEquals("Test\n", reader.readLine());
assertEquals("Test2", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCR() throws Exception {
final String TEXT = "Test\r" +
"Test2";
BatchLineReader reader = create(TEXT);
assertEquals("Test\r", reader.readLine());
assertEquals("Test2", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCombined() throws Exception {
BatchLineReader reader = create(TEXT_COMBINED);
assertEquals("Test\r", reader.readLine());
assertEquals("Test2\r\n", reader.readLine());
assertEquals("Test3\n", reader.readLine());
assertEquals("Test4\r", reader.readLine());
assertEquals("\r", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("Test5\n", reader.readLine());
assertEquals("Test6\r\n", reader.readLine());
assertEquals("Test7\n", reader.readLine());
assertEquals("\n", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCombinedBufferSizeTwo() throws Exception {
BatchLineReader reader = create(TEXT_COMBINED, 2);
assertEquals("Test\r", reader.readLine());
assertEquals("Test2\r\n", reader.readLine());
assertEquals("Test3\n", reader.readLine());
assertEquals("Test4\r", reader.readLine());
assertEquals("\r", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("Test5\n", reader.readLine());
assertEquals("Test6\r\n", reader.readLine());
assertEquals("Test7\n", reader.readLine());
assertEquals("\n", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCombinedBufferSizeOne() throws Exception {
final String TEXT = "Test\r" +
"Test2\r\n" +
"Test3\n" +
"Test4\r" +
"\r" +
"\r\n" +
"\r\n" +
"Test5\n" +
"Test6\r\n" +
"Test7\n" +
"\r\n";
BatchLineReader reader = create(TEXT, 1);
assertEquals("Test\r", reader.readLine());
assertEquals("Test2\r\n", reader.readLine());
assertEquals("Test3\n", reader.readLine());
assertEquals("Test4\r", reader.readLine());
assertEquals("\r", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("Test5\n", reader.readLine());
assertEquals("Test6\r\n", reader.readLine());
assertEquals("Test7\n", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testDoubleLF() throws Exception {
final String TEXT = "Test\r" +
"\r";
BatchLineReader reader = create(TEXT, 1);
assertEquals("Test\r", reader.readLine());
assertEquals("\r", reader.readLine());
reader.close();
}
@Test
public void testLineEqualsAndHashCode() {
Line l1 = new Line("The first line", 1);
Line l2 = new Line("The first line", 1);
Line l3 = new Line("The second line", 2);
assertEquals(l1, l2);
assertFalse(l1.equals(l3));
assertTrue(l1.hashCode() != l3.hashCode());
}
@Test(expected = IllegalArgumentException.class)
public void testFailBufferSizeZero() throws Exception {
BatchLineReader reader = create(TEXT_EMPTY, 0);
reader.close();
}
@Test(expected = IllegalArgumentException.class)
public void testFailBufferSizeNegative() throws Exception {
BatchLineReader reader = create(TEXT_EMPTY, -1);
reader.close();
}
@Test
public void testToList() throws Exception {
BatchLineReader reader = create(TEXT_COMBINED);
List<Line> stringList = reader.toLineList();
assertEquals(11, stringList.size());
assertEquals("Test\r", stringList.get(0).toString());
assertEquals("Test2\r\n", stringList.get(1).toString());
assertEquals("Test3\n", stringList.get(2).toString());
assertEquals("Test4\r", stringList.get(3).toString());
assertEquals("\r", stringList.get(4).toString());
assertEquals("\r\n", stringList.get(5).toString());
assertEquals("\r\n", stringList.get(6).toString());
assertEquals("Test5\n", stringList.get(7).toString());
assertEquals("Test6\r\n", stringList.get(8).toString());
assertEquals("Test7\n", stringList.get(9).toString());
assertEquals("\n", stringList.get(10).toString());
reader.close();
}
private BatchLineReader create(final String inputString) throws Exception {
return new BatchLineReader(new ByteArrayInputStream(inputString
.getBytes("UTF-8")));
}
private BatchLineReader create(final String inputString, final int bufferSize) throws Exception {
return new BatchLineReader(new ByteArrayInputStream(inputString
.getBytes("UTF-8")), bufferSize);
}
}

481
lib/server-core/src/test/java/org/apache/olingo/server/core/deserializer/batch/BufferedReaderIncludingLineEndingsTest.java
View File

@ -1,481 +0,0 @@
/*
* 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.server.core.deserializer.batch;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import java.io.ByteArrayInputStream;
import java.io.InputStreamReader;
import java.util.List;
import org.junit.Test;
public class BufferedReaderIncludingLineEndingsTest {
private static final String TEXT_COMBINED = "Test\r" +
"Test2\r\n" +
"Test3\n" +
"Test4\r" +
"\r" +
"\r\n" +
"\r\n" +
"Test5\n" +
"Test6\r\n" +
"Test7\n" +
"\n";
private static final String TEXT_SMALL = "Test\r" +
"123";
private static final String TEXT_EMPTY = "";
@Test
public void testSimpleText() throws Exception {
final String TEXT = "Test";
BufferedReaderIncludingLineEndings reader = create(TEXT);
assertEquals(TEXT, reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testNoText() throws Exception {
final String TEXT = "";
BufferedReaderIncludingLineEndings reader = create(TEXT);
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testNoBytes() throws Exception {
BufferedReaderIncludingLineEndings reader =
new BufferedReaderIncludingLineEndings(new InputStreamReader(new ByteArrayInputStream(new byte[0])));
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCRLF() throws Exception {
final String TEXT = "Test\r\n" +
"Test2";
BufferedReaderIncludingLineEndings reader = create(TEXT);
assertEquals("Test\r\n", reader.readLine());
assertEquals("Test2", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testLF() throws Exception {
final String TEXT = "Test\n" +
"Test2";
BufferedReaderIncludingLineEndings reader = create(TEXT);
assertEquals("Test\n", reader.readLine());
assertEquals("Test2", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCR() throws Exception {
final String TEXT = "Test\r" +
"Test2";
BufferedReaderIncludingLineEndings reader = create(TEXT);
assertEquals("Test\r", reader.readLine());
assertEquals("Test2", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCombined() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_COMBINED);
assertEquals("Test\r", reader.readLine());
assertEquals("Test2\r\n", reader.readLine());
assertEquals("Test3\n", reader.readLine());
assertEquals("Test4\r", reader.readLine());
assertEquals("\r", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("Test5\n", reader.readLine());
assertEquals("Test6\r\n", reader.readLine());
assertEquals("Test7\n", reader.readLine());
assertEquals("\n", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCombinedBufferSizeTwo() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_COMBINED, 2);
assertEquals("Test\r", reader.readLine());
assertEquals("Test2\r\n", reader.readLine());
assertEquals("Test3\n", reader.readLine());
assertEquals("Test4\r", reader.readLine());
assertEquals("\r", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("Test5\n", reader.readLine());
assertEquals("Test6\r\n", reader.readLine());
assertEquals("Test7\n", reader.readLine());
assertEquals("\n", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testCombinedBufferSizeOne() throws Exception {
final String TEXT = "Test\r" +
"Test2\r\n" +
"Test3\n" +
"Test4\r" +
"\r" +
"\r\n" +
"\r\n" +
"Test5\n" +
"Test6\r\n" +
"Test7\n" +
"\r\n";
BufferedReaderIncludingLineEndings reader = create(TEXT, 1);
assertEquals("Test\r", reader.readLine());
assertEquals("Test2\r\n", reader.readLine());
assertEquals("Test3\n", reader.readLine());
assertEquals("Test4\r", reader.readLine());
assertEquals("\r", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertEquals("Test5\n", reader.readLine());
assertEquals("Test6\r\n", reader.readLine());
assertEquals("Test7\n", reader.readLine());
assertEquals("\r\n", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testDoubleLF() throws Exception {
final String TEXT = "Test\r" +
"\r";
BufferedReaderIncludingLineEndings reader = create(TEXT, 1);
assertEquals("Test\r", reader.readLine());
assertEquals("\r", reader.readLine());
reader.close();
}
@Test
public void testSkipSimple() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_SMALL);
assertEquals(5, reader.skip(5)); // Test\r
assertEquals("123", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testSkipBufferOne() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_SMALL, 1);
assertEquals(5, reader.skip(5)); // Test\r
assertEquals("123", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testReadThanSkip() throws Exception {
final String TEXT = "Test\r" +
"\r" +
"123";
BufferedReaderIncludingLineEndings reader = create(TEXT);
assertEquals("Test\r", reader.readLine());
assertEquals(1, reader.skip(1)); // Test\r
assertEquals("123", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testReadMoreBufferCapacityThanCharacterAvailable() throws Exception {
final String TEXT = "Foo";
char[] buffer = new char[20];
BufferedReaderIncludingLineEndings reader = create(TEXT);
assertEquals(3, reader.read(buffer, 0, 20));
assertEquals(-1, reader.read(buffer, 0, 20));
reader.close();
BufferedReaderIncludingLineEndings readerBufferOne = create(TEXT, 1);
assertEquals(3, readerBufferOne.read(buffer, 0, 20));
assertEquals(-1, readerBufferOne.read(buffer, 0, 20));
readerBufferOne.close();
}
@Test
public void testSkipZero() throws Exception {
final String TEXT = "Test\r" +
"123\r\n";
BufferedReaderIncludingLineEndings reader = create(TEXT);
assertEquals(0, reader.skip(0)); // Test\r
assertEquals("Test\r", reader.readLine());
assertEquals("123\r\n", reader.readLine());
assertNull(reader.readLine());
assertNull(reader.readLine());
reader.close();
}
@Test
public void testSkipToMuch() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_SMALL);
assertEquals(8, reader.skip(10)); // Test\r
assertEquals(null, reader.readLine());
reader.close();
}
@Test
public void testReadBufferOne() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_SMALL, 1);
assertEquals('T', reader.read());
assertEquals('e', reader.read());
assertEquals('s', reader.read());
assertEquals('t', reader.read());
assertEquals('\r', reader.read());
assertEquals('1', reader.read());
assertEquals('2', reader.read());
assertEquals('3', reader.read());
assertEquals(-1, reader.read());
assertEquals(-1, reader.read());
}
@Test
public void testReadZeroBytes() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_SMALL, 1);
char[] buffer = new char[3];
assertEquals(0, reader.read(buffer, 0, 0));
assertEquals('T', reader.read());
assertEquals(0, reader.read(buffer, 0, 0));
assertEquals("est\r", reader.readLine());
assertEquals("123", reader.readLine());
reader.close();
}
@Test
public void testRead() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_SMALL);
assertEquals('T', reader.read());
assertEquals('e', reader.read());
assertEquals('s', reader.read());
assertEquals('t', reader.read());
assertEquals('\r', reader.read());
assertEquals('1', reader.read());
assertEquals('2', reader.read());
assertEquals('3', reader.read());
assertEquals(-1, reader.read());
assertEquals(-1, reader.read());
}
@Test(expected = IndexOutOfBoundsException.class)
public void testFailReadBufferAndOffsetBiggerThanBuffer() throws Exception {
BufferedReaderIncludingLineEndings reader = create("");
final char[] buffer = new char[3];
reader.read(buffer, 1, 3);
}
@Test(expected = IndexOutOfBoundsException.class)
public void testFailLengthNegative() throws Exception {
final char[] buffer = new char[3];
BufferedReaderIncludingLineEndings reader = create("123");
reader.read(buffer, 1, -2);
reader.close();
}
@Test(expected = IndexOutOfBoundsException.class)
public void testFailOffsetNegative() throws Exception {
final char[] buffer = new char[3];
BufferedReaderIncludingLineEndings reader = create("123");
reader.read(buffer, -1, 2);
reader.close();
}
@Test
public void testReadAndReadLine() throws Exception {
final String TEXT = "Test\r" +
"bar\n" +
"123\r\n" +
"foo";
BufferedReaderIncludingLineEndings reader = create(TEXT);
assertEquals('T', reader.read());
assertEquals('e', reader.read());
assertEquals('s', reader.read());
assertEquals('t', reader.read());
assertEquals("\r", reader.readLine());
assertEquals("bar\n", reader.readLine());
assertEquals('1', reader.read());
assertEquals('2', reader.read());
assertEquals("3\r\n", reader.readLine());
assertEquals("foo", reader.readLine());
assertEquals(null, reader.readLine());
assertEquals(-1, reader.read());
}
@Test
public void testLineEqualsAndHashCode() {
Line l1 = new Line("The first line", 1);
Line l2 = new Line("The first line", 1);
Line l3 = new Line("The second line", 2);
assertEquals(l1, l2);
assertFalse(l1.equals(l3));
assertTrue(l1.hashCode() != l3.hashCode());
}
@Test(expected = IllegalArgumentException.class)
public void testSkipNegative() throws Exception {
BufferedReaderIncludingLineEndings reader = create("123");
reader.skip(-1);
}
@Test(expected = IllegalArgumentException.class)
public void testFailBufferSizeZero() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_EMPTY, 0);
reader.close();
}
@Test(expected = NullPointerException.class)
public void testInputStreamIsNull() throws Exception {
// Same behaviour like BufferedReader
BufferedReaderIncludingLineEndings reader = new BufferedReaderIncludingLineEndings(null);
reader.close();
}
@Test(expected = IllegalArgumentException.class)
public void testFailBufferSizeNegative() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_EMPTY, -1);
reader.close();
}
@Test
public void testMarkSupoorted() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_EMPTY);
assertEquals(false, reader.markSupported());
reader.close();
}
@Test(expected = Exception.class)
public void testFailMark() throws Exception {
BufferedReaderIncludingLineEndings reader = create("123");
reader.mark(1);
}
@Test(expected = Exception.class)
public void testFailReset() throws Exception {
BufferedReaderIncludingLineEndings reader = create("123");
reader.reset();
}
@Test
public void testReady() throws Exception {
BufferedReaderIncludingLineEndings reader = create("123\r123");
assertEquals(false, reader.ready());
assertEquals("123\r", reader.readLine());
assertEquals(true, reader.ready());
assertEquals("123", reader.readLine());
assertEquals(false, reader.ready());
reader.close();
}
@Test
public void testToList() throws Exception {
BufferedReaderIncludingLineEndings reader = create(TEXT_COMBINED);
List<Line> stringList = reader.toLineList();
assertEquals(11, stringList.size());
assertEquals("Test\r", stringList.get(0).toString());
assertEquals("Test2\r\n", stringList.get(1).toString());
assertEquals("Test3\n", stringList.get(2).toString());
assertEquals("Test4\r", stringList.get(3).toString());
assertEquals("\r", stringList.get(4).toString());
assertEquals("\r\n", stringList.get(5).toString());
assertEquals("\r\n", stringList.get(6).toString());
assertEquals("Test5\n", stringList.get(7).toString());
assertEquals("Test6\r\n", stringList.get(8).toString());
assertEquals("Test7\n", stringList.get(9).toString());
assertEquals("\n", stringList.get(10).toString());
reader.close();
}
private BufferedReaderIncludingLineEndings create(final String inputString) throws Exception {
return new BufferedReaderIncludingLineEndings(new InputStreamReader(new ByteArrayInputStream(inputString
.getBytes("UTF-8"))));
}
private BufferedReaderIncludingLineEndings create(final String inputString, final int bufferSize) throws Exception {
return new BufferedReaderIncludingLineEndings(new InputStreamReader(new ByteArrayInputStream(inputString
.getBytes("UTF-8"))), bufferSize);
}
}

235
lib/server-core/src/test/java/org/apache/olingo/server/core/serializer/BatchResponseSerializerTest.java
View File

@ -22,8 +22,9 @@ import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
@ -34,13 +35,15 @@ import org.apache.olingo.commons.api.http.HttpHeader;
import org.apache.olingo.commons.api.http.HttpStatusCode;
import org.apache.olingo.server.api.ODataResponse;
import org.apache.olingo.server.api.deserializer.batch.ODataResponsePart;
import org.apache.olingo.server.core.deserializer.batch.BufferedReaderIncludingLineEndings;
import org.apache.olingo.server.core.deserializer.batch.BatchLineReader;
import org.junit.Test;
public class BatchResponseSerializerTest {
private static final String CRLF = "\r\n";
private static final String BOUNDARY = "batch_" + UUID.randomUUID().toString();
private static final Charset CS_ISO_8859_1 = Charset.forName("iso-8859-1");
@Test
public void testBatchResponse() throws Exception {
final List<ODataResponsePart> parts = new ArrayList<ODataResponsePart>();
@ -63,8 +66,8 @@ public class BatchResponseSerializerTest {
BatchResponseSerializer serializer = new BatchResponseSerializer();
final InputStream content = serializer.serialize(parts, BOUNDARY);
assertNotNull(content);
final BufferedReaderIncludingLineEndings reader =
new BufferedReaderIncludingLineEndings(new InputStreamReader(content));
final BatchLineReader reader =
new BatchLineReader(content);
final List<String> body = reader.toList();
reader.close();
@ -96,6 +99,218 @@ public class BatchResponseSerializerTest {
assertTrue(body.get(line++).contains("--batch_"));
}
@Test
public void testBatchResponseUmlautsUtf8() throws Exception {
final List<ODataResponsePart> parts = new ArrayList<ODataResponsePart>();
ODataResponse response = new ODataResponse();
response.setStatusCode(HttpStatusCode.OK.getStatusCode());
response.setHeader(HttpHeader.CONTENT_TYPE,
ContentType.APPLICATION_JSON.toContentTypeString() + "; charset=UTF-8");
response.setContent(IOUtils.toInputStream("Wälter Winter" + CRLF));
List<ODataResponse> responses = new ArrayList<ODataResponse>(1);
responses.add(response);
parts.add(new ODataResponsePart(responses, false));
ODataResponse changeSetResponse = new ODataResponse();
changeSetResponse.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
changeSetResponse.setHeader(HttpHeader.CONTENT_ID, "1");
responses = new ArrayList<ODataResponse>(1);
responses.add(changeSetResponse);
parts.add(new ODataResponsePart(responses, true));
BatchResponseSerializer serializer = new BatchResponseSerializer();
final InputStream content = serializer.serialize(parts, BOUNDARY);
assertNotNull(content);
final BatchLineReader reader =
new BatchLineReader(content);
final List<String> body = reader.toList();
reader.close();
int line = 0;
assertEquals(24, body.size());
assertTrue(body.get(line++).contains("--batch_"));
assertEquals("Content-Type: application/http" + CRLF, body.get(line++));
assertEquals("Content-Transfer-Encoding: binary" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals("HTTP/1.1 200 OK" + CRLF, body.get(line++));
assertEquals("Content-Type: application/json; charset=UTF-8" + CRLF, body.get(line++));
assertEquals("Content-Length: 16" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals("Wälter Winter" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertTrue(body.get(line++).contains("--batch_"));
assertTrue(body.get(line++).contains("Content-Type: multipart/mixed; boundary=changeset_"));
assertEquals(CRLF, body.get(line++));
assertTrue(body.get(line++).contains("--changeset_"));
assertEquals("Content-Type: application/http" + CRLF, body.get(line++));
assertEquals("Content-Transfer-Encoding: binary" + CRLF, body.get(line++));
assertEquals("Content-ID: 1" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals("HTTP/1.1 204 No Content" + CRLF, body.get(line++));
assertEquals("Content-Length: 0" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertTrue(body.get(line++).contains("--changeset_"));
assertTrue(body.get(line++).contains("--batch_"));
}
@Test
public void testBatchResponseUmlautsUtf8BodyIsoHeader() throws Exception {
final List<ODataResponsePart> parts = new ArrayList<ODataResponsePart>();
ODataResponse response = new ODataResponse();
response.setStatusCode(HttpStatusCode.OK.getStatusCode());
response.setHeader(HttpHeader.CONTENT_TYPE,
ContentType.APPLICATION_JSON.toContentTypeString() + "; charset=UTF-8");
response.setContent(IOUtils.toInputStream("Wälter Winter" + CRLF));
List<ODataResponse> responses = new ArrayList<ODataResponse>(1);
responses.add(response);
parts.add(new ODataResponsePart(responses, false));
ODataResponse changeSetResponse = new ODataResponse();
changeSetResponse.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
changeSetResponse.setHeader(HttpHeader.CONTENT_ID, "1");
byte[] umlauts = "äüö".getBytes(CS_ISO_8859_1);
changeSetResponse.setHeader("Custom-Header", new String(umlauts, CS_ISO_8859_1));
responses = new ArrayList<ODataResponse>(1);
responses.add(changeSetResponse);
parts.add(new ODataResponsePart(responses, true));
BatchResponseSerializer serializer = new BatchResponseSerializer();
final InputStream content = serializer.serialize(parts, BOUNDARY);
assertNotNull(content);
final BatchLineReader reader =
new BatchLineReader(content);
final List<String> body = reader.toList();
reader.close();
int line = 0;
assertEquals(25, body.size());
assertTrue(body.get(line++).contains("--batch_"));
assertEquals("Content-Type: application/http" + CRLF, body.get(line++));
assertEquals("Content-Transfer-Encoding: binary" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals("HTTP/1.1 200 OK" + CRLF, body.get(line++));
assertEquals("Content-Type: application/json; charset=UTF-8" + CRLF, body.get(line++));
assertEquals("Content-Length: 16" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals("Wälter Winter" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertTrue(body.get(line++).contains("--batch_"));
assertTrue(body.get(line++).contains("Content-Type: multipart/mixed; boundary=changeset_"));
assertEquals(CRLF, body.get(line++));
assertTrue(body.get(line++).contains("--changeset_"));
assertEquals("Content-Type: application/http" + CRLF, body.get(line++));
assertEquals("Content-Transfer-Encoding: binary" + CRLF, body.get(line++));
assertEquals("Content-ID: 1" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals("HTTP/1.1 204 No Content" + CRLF, body.get(line++));
assertEquals("Custom-Header: äüö" + CRLF, body.get(line++));
assertEquals("Content-Length: 0" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertTrue(body.get(line++).contains("--changeset_"));
assertTrue(body.get(line++).contains("--batch_"));
}
@Test
public void testBatchResponseUmlautsUtf8BodyAndHeader() throws Exception {
final List<ODataResponsePart> parts = new ArrayList<ODataResponsePart>();
ODataResponse response = new ODataResponse();
response.setStatusCode(HttpStatusCode.OK.getStatusCode());
response.setHeader(HttpHeader.CONTENT_TYPE,
ContentType.APPLICATION_JSON.toContentTypeString() + "; charset=UTF-8");
response.setContent(IOUtils.toInputStream("Wälter Winter" + CRLF));
List<ODataResponse> responses = new ArrayList<ODataResponse>(1);
responses.add(response);
parts.add(new ODataResponsePart(responses, false));
ODataResponse changeSetResponse = new ODataResponse();
changeSetResponse.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
changeSetResponse.setHeader(HttpHeader.CONTENT_ID, "1");
// byte[] umlauts = "äüö".getBytes(CS_UTF_8);
// changeSetResponse.setHeader("Custom-Header", new String(umlauts, CS_UTF_8));
changeSetResponse.setHeader("Custom-Header", "äüö");
responses = new ArrayList<ODataResponse>(1);
responses.add(changeSetResponse);
parts.add(new ODataResponsePart(responses, true));
BatchResponseSerializer serializer = new BatchResponseSerializer();
final InputStream content = serializer.serialize(parts, BOUNDARY);
assertNotNull(content);
final BatchLineReader reader =
new BatchLineReader(content);
final List<String> body = reader.toList();
reader.close();
assertEquals(25, body.size());
// TODO: check: with latest change in BatchResponseSerializer is not possible
// to set header values with UTF-8 (only iso-8859-1)
// assertEquals("Custom-Header: äüö" + CRLF, body.get(19));
assertEquals("Custom-Header: äüö" + CRLF, body.get(19));
}
@Test
public void testBatchResponseUmlautsIso() throws Exception {
final List<ODataResponsePart> parts = new ArrayList<ODataResponsePart>();
ODataResponse response = new ODataResponse();
response.setStatusCode(HttpStatusCode.OK.getStatusCode());
response.setHeader(HttpHeader.CONTENT_TYPE,
ContentType.APPLICATION_JSON.toContentTypeString() + "; charset=iso-8859-1");
byte[] payload = ("Wälter Winter" + CRLF).getBytes("iso-8859-1");
response.setContent(new ByteArrayInputStream(payload));
List<ODataResponse> responses = new ArrayList<ODataResponse>(1);
responses.add(response);
parts.add(new ODataResponsePart(responses, false));
ODataResponse changeSetResponse = new ODataResponse();
changeSetResponse.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
changeSetResponse.setHeader(HttpHeader.CONTENT_ID, "1");
responses = new ArrayList<ODataResponse>(1);
responses.add(changeSetResponse);
parts.add(new ODataResponsePart(responses, true));
BatchResponseSerializer serializer = new BatchResponseSerializer();
final InputStream content = serializer.serialize(parts, BOUNDARY);
assertNotNull(content);
final BatchLineReader reader =
new BatchLineReader(content);
final List<String> body = reader.toList();
reader.close();
int line = 0;
assertEquals(24, body.size());
assertTrue(body.get(line++).contains("--batch_"));
assertEquals("Content-Type: application/http" + CRLF, body.get(line++));
assertEquals("Content-Transfer-Encoding: binary" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals("HTTP/1.1 200 OK" + CRLF, body.get(line++));
assertEquals("Content-Type: application/json; charset=iso-8859-1" + CRLF, body.get(line++));
assertEquals("Content-Length: 15" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals("Wälter Winter" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertTrue(body.get(line++).contains("--batch_"));
assertTrue(body.get(line++).contains("Content-Type: multipart/mixed; boundary=changeset_"));
assertEquals(CRLF, body.get(line++));
assertTrue(body.get(line++).contains("--changeset_"));
assertEquals("Content-Type: application/http" + CRLF, body.get(line++));
assertEquals("Content-Transfer-Encoding: binary" + CRLF, body.get(line++));
assertEquals("Content-ID: 1" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals("HTTP/1.1 204 No Content" + CRLF, body.get(line++));
assertEquals("Content-Length: 0" + CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertEquals(CRLF, body.get(line++));
assertTrue(body.get(line++).contains("--changeset_"));
assertTrue(body.get(line++).contains("--batch_"));
}
@Test
public void testBatchResponseWithEndingCRLF() throws Exception {
final List<ODataResponsePart> parts = new ArrayList<ODataResponsePart>();
@ -118,8 +333,8 @@ public class BatchResponseSerializerTest {
BatchResponseSerializer serializer = new BatchResponseSerializer();
final InputStream content = serializer.serialize(parts, BOUNDARY);
assertNotNull(content);
final BufferedReaderIncludingLineEndings reader =
new BufferedReaderIncludingLineEndings(new InputStreamReader(content));
final BatchLineReader reader =
new BatchLineReader(content);
final List<String> body = reader.toList();
reader.close();
@ -166,8 +381,8 @@ public class BatchResponseSerializerTest {
final InputStream content = serializer.serialize(parts, BOUNDARY);
assertNotNull(content);
final BufferedReaderIncludingLineEndings reader =
new BufferedReaderIncludingLineEndings(new InputStreamReader(content));
final BatchLineReader reader =
new BatchLineReader(content);
final List<String> body = reader.toList();
reader.close();
@ -201,8 +416,8 @@ public class BatchResponseSerializerTest {
assertNotNull(content);
final BufferedReaderIncludingLineEndings reader =
new BufferedReaderIncludingLineEndings(new InputStreamReader(content));
final BatchLineReader reader =
new BatchLineReader(content);
final List<String> body = reader.toList();
reader.close();

5
lib/server-tecsvc/src/main/java/org/apache/olingo/server/tecsvc/TechnicalServlet.java
View File

@ -33,6 +33,7 @@ import javax.servlet.http.HttpSession;
import org.apache.olingo.server.api.OData;
import org.apache.olingo.server.api.ODataHttpHandler;
import org.apache.olingo.server.api.ServiceMetadata;
import org.apache.olingo.server.api.debug.DefaultDebugSupport;
import org.apache.olingo.server.api.edmx.EdmxReference;
import org.apache.olingo.server.api.edmx.EdmxReferenceInclude;
import org.apache.olingo.server.tecsvc.async.TechnicalAsyncService;
@ -80,11 +81,15 @@ public class TechnicalServlet extends HttpServlet {
}
ODataHttpHandler handler = odata.createHandler(serviceMetadata);
// Register processors
handler.register(new TechnicalEntityProcessor(dataProvider, serviceMetadata));
handler.register(new TechnicalPrimitiveComplexProcessor(dataProvider, serviceMetadata));
handler.register(new TechnicalActionProcessor(dataProvider, serviceMetadata));
handler.register(new TechnicalBatchProcessor(dataProvider));
// Register Helper
handler.register(new ETagSupport());
handler.register(new DefaultDebugSupport());
// Process the request
handler.process(request, response);
} catch (final RuntimeException e) {
LOG.error("Server Error", e);

1
pom.xml
View File

@ -496,6 +496,7 @@
<artifactId>maven-eclipse-plugin</artifactId>
<version>2.9</version>
<configuration>
<useProjectReferences>false</useProjectReferences>
<addGroupIdToProjectName>true</addGroupIdToProjectName>
<addVersionToProjectName>true</addVersionToProjectName>
<wtpversion>2.0</wtpversion>

92
samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/data/Storage.java
View File

@ -6,9 +6,9 @@
* 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
@ -39,7 +39,6 @@ public class Storage {
private List<Entity> productList;
private List<Entity> categoryList;
public Storage() {
productList = new ArrayList<Entity>();
@ -55,142 +54,135 @@ public class Storage {
public EntityCollection readEntitySetData(EdmEntitySet edmEntitySet) {
EntityCollection entitySet = null;
if(edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)){
if (edmEntitySet.getName().equals(DemoEdmProvider.ES_PRODUCTS_NAME)) {
entitySet = getProducts();
}else if(edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)){
} else if (edmEntitySet.getName().equals(DemoEdmProvider.ES_CATEGORIES_NAME)) {
entitySet = getCategories();
}
return entitySet;
}
public Entity readEntityData(EdmEntitySet edmEntitySet, List<UriParameter> keyParams) {
Entity entity = null;
EdmEntityType edmEntityType = edmEntitySet.getEntityType();
if(edmEntityType.getName().equals(DemoEdmProvider.ET_PRODUCT_NAME)){
if (edmEntityType.getName().equals(DemoEdmProvider.ET_PRODUCT_NAME)) {
entity = getProduct(edmEntityType, keyParams);
}else if(edmEntityType.getName().equals(DemoEdmProvider.ET_CATEGORY_NAME)){
} else if (edmEntityType.getName().equals(DemoEdmProvider.ET_CATEGORY_NAME)) {
entity = getCategory(edmEntityType, keyParams);
}
return entity;
}
// Navigation
// Navigation
public Entity getRelatedEntity(Entity entity, EdmEntityType relatedEntityType) {
EntityCollection collection = getRelatedEntityCollection(entity, relatedEntityType);
if(collection.getEntities().isEmpty()) {
if (collection.getEntities().isEmpty()) {
return null;
}
return collection.getEntities().get(0);
}
public Entity getRelatedEntity(Entity entity, EdmEntityType relatedEntityType, List<UriParameter> keyPredicates) {
EntityCollection relatedEntities = getRelatedEntityCollection(entity, relatedEntityType);
return Util.findEntity(relatedEntityType, relatedEntities, keyPredicates);
}
public EntityCollection getRelatedEntityCollection(Entity sourceEntity, EdmEntityType targetEntityType) {
EntityCollection navigationTargetEntityCollection = new EntityCollection();
FullQualifiedName relatedEntityFqn = targetEntityType.getFullQualifiedName();
String sourceEntityFqn = sourceEntity.getType();
if(sourceEntityFqn.equals(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString())
&& relatedEntityFqn.equals(DemoEdmProvider.ET_CATEGORY_FQN)){
if (sourceEntityFqn.equals(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString())
&& relatedEntityFqn.equals(DemoEdmProvider.ET_CATEGORY_FQN)) {
// relation Products->Category (result all categories)
int productID = (Integer) sourceEntity.getProperty("ID").getValue();
if(productID == 1 || productID == 2) {
if (productID == 1 || productID == 2) {
navigationTargetEntityCollection.getEntities().add(categoryList.get(0));
} else if(productID == 3 || productID == 4) {
} else if (productID == 3 || productID == 4) {
navigationTargetEntityCollection.getEntities().add(categoryList.get(1));
} else if(productID == 5 || productID == 6) {
} else if (productID == 5 || productID == 6) {
navigationTargetEntityCollection.getEntities().add(categoryList.get(2));
}
}else if(sourceEntityFqn.equals(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString())
&& relatedEntityFqn.equals(DemoEdmProvider.ET_PRODUCT_FQN)){
} else if (sourceEntityFqn.equals(DemoEdmProvider.ET_CATEGORY_FQN.getFullQualifiedNameAsString())
&& relatedEntityFqn.equals(DemoEdmProvider.ET_PRODUCT_FQN)) {
// relation Category->Products (result all products)
int categoryID = (Integer) sourceEntity.getProperty("ID").getValue();
if(categoryID == 1){
navigationTargetEntityCollection.getEntities().addAll(productList.subList(0, 2));// the first 2 products are notebooks
}else if(categoryID == 2){
navigationTargetEntityCollection.getEntities().addAll(productList.subList(2, 4));// the next 2 products are organizers
}else if(categoryID == 3){
navigationTargetEntityCollection.getEntities().addAll(productList.subList(4, 6));// the first 2 products are monitors
if (categoryID == 1) {
// the first 2 products are notebooks
navigationTargetEntityCollection.getEntities().addAll(productList.subList(0, 2));
} else if (categoryID == 2) {
// the next 2 products are organizers
navigationTargetEntityCollection.getEntities().addAll(productList.subList(2, 4));
} else if (categoryID == 3) {
// the first 2 products are monitors
navigationTargetEntityCollection.getEntities().addAll(productList.subList(4, 6));
}
}
if(navigationTargetEntityCollection.getEntities().isEmpty()){
if (navigationTargetEntityCollection.getEntities().isEmpty()) {
return null;
}
return navigationTargetEntityCollection;
}
/* INTERNAL */
/* INTERNAL */
private EntityCollection getProducts(){
private EntityCollection getProducts() {
EntityCollection retEntitySet = new EntityCollection();
for(Entity productEntity : this.productList){
retEntitySet.getEntities().add(productEntity);
for (Entity productEntity : this.productList) {
retEntitySet.getEntities().add(productEntity);
}
return retEntitySet;
}
private Entity getProduct(EdmEntityType edmEntityType, List<UriParameter> keyParams) {
// the list of entities at runtime
EntityCollection entityCollection = getProducts();
/* generic approach to find the requested entity */
/* generic approach to find the requested entity */
return Util.findEntity(edmEntityType, entityCollection, keyParams);
}
private EntityCollection getCategories(){
private EntityCollection getCategories() {
EntityCollection entitySet = new EntityCollection();
for(Entity categoryEntity : this.categoryList){
entitySet.getEntities().add(categoryEntity);
for (Entity categoryEntity : this.categoryList) {
entitySet.getEntities().add(categoryEntity);
}
return entitySet;
}
private Entity getCategory(EdmEntityType edmEntityType, List<UriParameter> keyParams) {
// the list of entities at runtime
EntityCollection entitySet = getCategories();
/* generic approach to find the requested entity */
/* generic approach to find the requested entity */
return Util.findEntity(edmEntityType, entitySet, keyParams);
}
/* HELPER */
private void initProductSampleData(){
private void initProductSampleData() {
Entity entity = new Entity();
entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 1));
entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Notebook Basic 15"));
entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
"Notebook Basic, 1.7GHz - 15 XGA - 1024MB DDR2 SDRAM - 40GB"));
"Notebook Basic, 1.7GHz - 15 XGA - 1024MB DDR2 SDRAM - 40GB"));
entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
productList.add(entity);
@ -198,7 +190,7 @@ public class Storage {
entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 2));
entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Notebook Professional 17"));
entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
"Notebook Professional, 2.8GHz - 15 XGA - 8GB DDR3 RAM - 500GB"));
"Notebook Professional, 2.8GHz - 15 XGA - 8GB DDR3 RAM - 500GB"));
entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
productList.add(entity);
@ -206,7 +198,7 @@ public class Storage {
entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 3));
entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "1UMTS PDA"));
entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
"Ultrafast 3G UMTS/HSDPA Pocket PC, supports GSM network"));
"Ultrafast 3G UMTS/HSDPA Pocket PC, supports GSM network"));
entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
productList.add(entity);
@ -214,7 +206,7 @@ public class Storage {
entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 4));
entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Comfort Easy"));
entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
"32 GB Digital Assitant with high-resolution color screen"));
"32 GB Digital Assitant with high-resolution color screen"));
entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
productList.add(entity);
@ -222,7 +214,7 @@ public class Storage {
entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 5));
entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Ergo Screen"));
entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
"19 Optimum Resolution 1024 x 768 @ 85Hz, resolution 1280 x 960"));
"19 Optimum Resolution 1024 x 768 @ 85Hz, resolution 1280 x 960"));
entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
productList.add(entity);
@ -230,12 +222,12 @@ public class Storage {
entity.addProperty(new Property(null, "ID", ValueType.PRIMITIVE, 6));
entity.addProperty(new Property(null, "Name", ValueType.PRIMITIVE, "Flat Basic"));
entity.addProperty(new Property(null, "Description", ValueType.PRIMITIVE,
"Optimum Hi-Resolution max. 1600 x 1200 @ 85Hz, Dot Pitch: 0.24mm"));
"Optimum Hi-Resolution max. 1600 x 1200 @ 85Hz, Dot Pitch: 0.24mm"));
entity.setType(DemoEdmProvider.ET_PRODUCT_FQN.getFullQualifiedNameAsString());
productList.add(entity);
}
private void initCategorySampleData(){
private void initCategorySampleData() {
Entity entity = new Entity();

43
samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEdmProvider.java
View File

@ -6,9 +6,9 @@
* 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
@ -38,12 +38,9 @@ import org.apache.olingo.commons.api.edm.provider.CsdlSchema;
public class DemoEdmProvider extends CsdlAbstractEdmProvider {
// Service Namespace
public static final String NAMESPACE = "OData.Demo";
// OData.Demo
// EDM Container
public static final String CONTAINER_NAME = "Container";
public static final FullQualifiedName CONTAINER = new FullQualifiedName(NAMESPACE, CONTAINER_NAME);
@ -59,22 +56,20 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
public static final String ES_PRODUCTS_NAME = "Products";
public static final String ES_CATEGORIES_NAME = "Categories";
@Override
public CsdlEntityType getEntityType(FullQualifiedName entityTypeName) throws ODataException {
// this method is called for each EntityType that are configured in the Schema
CsdlEntityType entityType = null;
if(entityTypeName.equals(ET_PRODUCT_FQN)){
//create EntityType properties
if (entityTypeName.equals(ET_PRODUCT_FQN)) {
// create EntityType properties
CsdlProperty id = new CsdlProperty().setName("ID")
.setType(EdmPrimitiveTypeKind.Int32.getFullQualifiedName());
.setType(EdmPrimitiveTypeKind.Int32.getFullQualifiedName());
CsdlProperty name = new CsdlProperty().setName("Name")
.setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
CsdlProperty description = new CsdlProperty().setName("Description")
.setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
.setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
CsdlProperty description = new CsdlProperty().setName("Description")
.setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
// create PropertyRef for Key element
CsdlPropertyRef propertyRef = new CsdlPropertyRef();
@ -82,23 +77,23 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
// navigation property: many-to-one, null not allowed (product must have a category)
CsdlNavigationProperty navProp = new CsdlNavigationProperty().setName("Category")
.setType(ET_CATEGORY_FQN).setNullable(false).setPartner("Products");
.setType(ET_CATEGORY_FQN).setNullable(false).setPartner("Products");
List<CsdlNavigationProperty> navPropList = new ArrayList<CsdlNavigationProperty>();
navPropList.add(navProp);
// configure EntityType
entityType = new CsdlEntityType();
entityType.setName(ET_PRODUCT_NAME);
entityType.setProperties(Arrays.asList(id, name , description));
entityType.setProperties(Arrays.asList(id, name, description));
entityType.setKey(Arrays.asList(propertyRef));
entityType.setNavigationProperties(navPropList);
}else if (entityTypeName.equals(ET_CATEGORY_FQN)){
//create EntityType properties
} else if (entityTypeName.equals(ET_CATEGORY_FQN)) {
// create EntityType properties
CsdlProperty id = new CsdlProperty().setName("ID")
.setType(EdmPrimitiveTypeKind.Int32.getFullQualifiedName());
.setType(EdmPrimitiveTypeKind.Int32.getFullQualifiedName());
CsdlProperty name = new CsdlProperty().setName("Name")
.setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
.setType(EdmPrimitiveTypeKind.String.getFullQualifiedName());
// create PropertyRef for Key element
CsdlPropertyRef propertyRef = new CsdlPropertyRef();
@ -106,7 +101,7 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
// navigation property: one-to-many
CsdlNavigationProperty navProp = new CsdlNavigationProperty().setName("Products")
.setType(ET_PRODUCT_FQN).setCollection(true).setPartner("Category");
.setType(ET_PRODUCT_FQN).setCollection(true).setPartner("Category");
List<CsdlNavigationProperty> navPropList = new ArrayList<CsdlNavigationProperty>();
navPropList.add(navProp);
@ -127,9 +122,9 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
CsdlEntitySet entitySet = null;
if(entityContainer.equals(CONTAINER)){
if (entityContainer.equals(CONTAINER)) {
if(entitySetName.equals(ES_PRODUCTS_NAME)){
if (entitySetName.equals(ES_PRODUCTS_NAME)) {
entitySet = new CsdlEntitySet();
entitySet.setName(ES_PRODUCTS_NAME);
@ -143,7 +138,7 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
navPropBindingList.add(navPropBinding);
entitySet.setNavigationPropertyBindings(navPropBindingList);
}else if(entitySetName.equals(ES_CATEGORIES_NAME)){
} else if (entitySetName.equals(ES_CATEGORIES_NAME)) {
entitySet = new CsdlEntitySet();
entitySet.setName(ES_CATEGORIES_NAME);
@ -167,7 +162,7 @@ public class DemoEdmProvider extends CsdlAbstractEdmProvider {
// This method is invoked when displaying the service document at
// e.g. http://localhost:8080/DemoService/DemoService.svc
if(entityContainerName == null || entityContainerName.equals(CONTAINER)){
if (entityContainerName == null || entityContainerName.equals(CONTAINER)) {
CsdlEntityContainerInfo entityContainerInfo = new CsdlEntityContainerInfo();
entityContainerInfo.setContainerName(CONTAINER);
return entityContainerInfo;

47
samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityCollectionProcessor.java
View File

@ -6,9 +6,9 @@
* 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
@ -52,14 +52,11 @@ import org.apache.olingo.server.api.uri.UriResourceNavigation;
public class DemoEntityCollectionProcessor implements EntityCollectionProcessor {
private OData odata;
private ServiceMetadata srvMetadata;
// our database-mock
private Storage storage;
public DemoEntityCollectionProcessor(Storage storage) {
this.storage = storage;
}
@ -69,21 +66,19 @@ public class DemoEntityCollectionProcessor implements EntityCollectionProcessor
this.srvMetadata = serviceMetadata;
}
/*
* This method is invoked when a collection of entities has to be read.
* In our example, this can be either a "normal" read operation, or a navigation:
*
*
* Example for "normal" read entity set operation:
* http://localhost:8080/DemoService/DemoService.svc/Categories
*
*
* Example for navigation
* http://localhost:8080/DemoService/DemoService.svc/Categories(3)/Products
*
* */
*/
public void readEntityCollection(ODataRequest request, ODataResponse response,
UriInfo uriInfo, ContentType responseFormat)
throws ODataApplicationException, SerializerException {
UriInfo uriInfo, ContentType responseFormat)
throws ODataApplicationException, SerializerException {
EdmEntitySet responseEdmEntitySet = null; // we'll need this to build the ContextURL
EntityCollection responseEntityCollection = null; // we'll need this to set the response body
@ -93,27 +88,27 @@ public class DemoEntityCollectionProcessor implements EntityCollectionProcessor
int segmentCount = resourceParts.size();
UriResource uriResource = resourceParts.get(0); // in our example, the first segment is the EntitySet
if (! (uriResource instanceof UriResourceEntitySet)) {
if (!(uriResource instanceof UriResourceEntitySet)) {
throw new ODataApplicationException("Only EntitySet is supported",
HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(),Locale.ROOT);
HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) uriResource;
EdmEntitySet startEdmEntitySet = uriResourceEntitySet.getEntitySet();
if(segmentCount == 1){ // this is the case for: DemoService/DemoService.svc/Categories
responseEdmEntitySet = startEdmEntitySet; //the response body is built from the first (and only) entitySet
if (segmentCount == 1) { // this is the case for: DemoService/DemoService.svc/Categories
responseEdmEntitySet = startEdmEntitySet; // the response body is built from the first (and only) entitySet
// 2nd: fetch the data from backend for this requested EntitySetName and deliver as EntitySet
responseEntityCollection = storage.readEntitySetData(startEdmEntitySet);
}else if (segmentCount == 2){ // in case of navigation: DemoService.svc/Categories(3)/Products
} else if (segmentCount == 2) { // in case of navigation: DemoService.svc/Categories(3)/Products
UriResource lastSegment = resourceParts.get(1); // in our example we don't support more complex URIs
if(lastSegment instanceof UriResourceNavigation){
UriResourceNavigation uriResourceNavigation = (UriResourceNavigation)lastSegment;
if (lastSegment instanceof UriResourceNavigation) {
UriResourceNavigation uriResourceNavigation = (UriResourceNavigation) lastSegment;
EdmNavigationProperty edmNavigationProperty = uriResourceNavigation.getProperty();
EdmEntityType targetEntityType = edmNavigationProperty.getType();
//from Categories(1) to Products
// from Categories(1) to Products
responseEdmEntitySet = Util.getNavigationTargetEntitySet(startEdmEntitySet, edmNavigationProperty);
// 2nd: fetch the data from backend
@ -121,19 +116,19 @@ public class DemoEntityCollectionProcessor implements EntityCollectionProcessor
List<UriParameter> keyPredicates = uriResourceEntitySet.getKeyPredicates();
// e.g. for Categories(3)/Products we have to find the single entity: Category with ID 3
Entity sourceEntity = storage.readEntityData(startEdmEntitySet, keyPredicates);
// error handling for e.g. DemoService.svc/Categories(99)/Products
if(sourceEntity == null) {
// error handling for e.g. DemoService.svc/Categories(99)/Products
if (sourceEntity == null) {
throw new ODataApplicationException("Entity not found.",
HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ROOT);
HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ROOT);
}
// then fetch the entity collection where the entity navigates to
// note: we don't need to check uriResourceNavigation.isCollection(),
// because we are the EntityCollectionProcessor
responseEntityCollection = storage.getRelatedEntityCollection(sourceEntity, targetEntityType);
}
}else{ // this would be the case for e.g. Products(1)/Category/Products
} else { // this would be the case for e.g. Products(1)/Category/Products
throw new ODataApplicationException("Not supported",
HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(),Locale.ROOT);
HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
// 3rd: create and configure a serializer
@ -143,7 +138,7 @@ public class DemoEntityCollectionProcessor implements EntityCollectionProcessor
ODataSerializer serializer = odata.createSerializer(ODataFormat.fromContentType(responseFormat));
SerializerResult serializerResult = serializer.entityCollection(this.srvMetadata, edmEntityType,
responseEntityCollection, opts);
responseEntityCollection, opts);
// 4th: configure the response object: set the body, headers and status code
response.setContent(serializerResult.getContent());

64
samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoEntityProcessor.java
View File

@ -6,9 +6,9 @@
* 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
@ -53,37 +53,31 @@ import org.apache.olingo.server.api.uri.UriResourceNavigation;
public class DemoEntityProcessor implements EntityProcessor {
private OData odata;
private ServiceMetadata srvMetadata;
private Storage storage;
public DemoEntityProcessor(Storage storage) {
this.storage = storage;
}
public void init(OData odata, ServiceMetadata serviceMetadata) {
this.odata = odata;
this.srvMetadata = serviceMetadata;
}
/*
/**
* This method is invoked when a single entity has to be read.
* In our example, this can be either a "normal" read operation, or a navigation:
*
*
* Example for "normal" read operation:
* http://localhost:8080/DemoService/DemoService.svc/Products(1)
*
*
* Example for navigation
* http://localhost:8080/DemoService/DemoService.svc/Products(1)/Category
*
* */
*/
public void readEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType responseFormat)
throws ODataApplicationException, SerializerException {
throws ODataApplicationException, SerializerException {
EdmEntityType responseEdmEntityType = null; // we'll need this to build the ContextURL
Entity responseEntity = null; // required for serialization of the response body
@ -94,33 +88,33 @@ public class DemoEntityProcessor implements EntityProcessor {
int segmentCount = resourceParts.size();
UriResource uriResource = resourceParts.get(0); // in our example, the first segment is the EntitySet
if (! (uriResource instanceof UriResourceEntitySet)) {
if (!(uriResource instanceof UriResourceEntitySet)) {
throw new ODataApplicationException("Only EntitySet is supported",
HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(),Locale.ENGLISH);
HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ENGLISH);
}
UriResourceEntitySet uriResourceEntitySet = (UriResourceEntitySet) uriResource;
EdmEntitySet startEdmEntitySet = uriResourceEntitySet.getEntitySet();
// Analyze the URI segments
if(segmentCount == 1){ // no navigation
if (segmentCount == 1) { // no navigation
responseEdmEntityType = startEdmEntitySet.getEntityType();
responseEdmEntitySet = startEdmEntitySet; // since we have only one segment
// 2. step: retrieve the data from backend
List<UriParameter> keyPredicates = uriResourceEntitySet.getKeyPredicates();
responseEntity = storage.readEntityData(startEdmEntitySet, keyPredicates);
} else if (segmentCount == 2){ //navigation
} else if (segmentCount == 2) { // navigation
UriResource navSegment = resourceParts.get(1); // in our example we don't support more complex URIs
if(navSegment instanceof UriResourceNavigation){
UriResourceNavigation uriResourceNavigation = (UriResourceNavigation)navSegment;
if (navSegment instanceof UriResourceNavigation) {
UriResourceNavigation uriResourceNavigation = (UriResourceNavigation) navSegment;
EdmNavigationProperty edmNavigationProperty = uriResourceNavigation.getProperty();
responseEdmEntityType = edmNavigationProperty.getType();
// contextURL displays the last segment
responseEdmEntitySet = Util.getNavigationTargetEntitySet(startEdmEntitySet, edmNavigationProperty);
// 2nd: fetch the data from backend.
// e.g. for the URI: Products(1)/Category we have to find the correct Category entity
// e.g. for the URI: Products(1)/Category we have to find the correct Category entity
List<UriParameter> keyPredicates = uriResourceEntitySet.getKeyPredicates();
// e.g. for Products(1)/Category we have to find first the Products(1)
Entity sourceEntity = storage.readEntityData(startEdmEntitySet, keyPredicates);
@ -131,18 +125,18 @@ public class DemoEntityProcessor implements EntityProcessor {
// the key for nav is used in this case: Categories(3)/Products(5)
List<UriParameter> navKeyPredicates = uriResourceNavigation.getKeyPredicates();
if(navKeyPredicates.isEmpty()){ // e.g. DemoService.svc/Products(1)/Category
if (navKeyPredicates.isEmpty()) { // e.g. DemoService.svc/Products(1)/Category
responseEntity = storage.getRelatedEntity(sourceEntity, responseEdmEntityType);
}else{ // e.g. DemoService.svc/Categories(3)/Products(5)
} else { // e.g. DemoService.svc/Categories(3)/Products(5)
responseEntity = storage.getRelatedEntity(sourceEntity, responseEdmEntityType, navKeyPredicates);
}
}
}else{
} else {
// this would be the case for e.g. Products(1)/Category/Products(1)/Category
throw new ODataApplicationException("Not supported", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(),Locale.ROOT);
throw new ODataApplicationException("Not supported", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
if(responseEntity == null) {
if (responseEntity == null) {
// this is the case for e.g. DemoService.svc/Categories(4) or DemoService.svc/Categories(3)/Products(999)
throw new ODataApplicationException("Nothing found.", HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ROOT);
}
@ -154,36 +148,32 @@ public class DemoEntityProcessor implements EntityProcessor {
ODataFormat oDataFormat = ODataFormat.fromContentType(responseFormat);
ODataSerializer serializer = this.odata.createSerializer(oDataFormat);
SerializerResult serializerResult = serializer.entity(this.srvMetadata,
responseEdmEntityType, responseEntity, opts);
responseEdmEntityType, responseEntity, opts);
//4. configure the response object
// 4. configure the response object
response.setContent(serializerResult.getContent());
response.setStatusCode(HttpStatusCode.OK.getStatusCode());
response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString());
}
/*
* These processor methods are not handled in this tutorial
* */
*/
public void createEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo,
ContentType requestFormat, ContentType responseFormat)
throws ODataApplicationException, DeserializerException, SerializerException {
ContentType requestFormat, ContentType responseFormat)
throws ODataApplicationException, DeserializerException, SerializerException {
throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
public void updateEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo,
ContentType requestFormat, ContentType responseFormat)
throws ODataApplicationException, DeserializerException, SerializerException {
ContentType requestFormat, ContentType responseFormat)
throws ODataApplicationException, DeserializerException, SerializerException {
throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
public void deleteEntity(ODataRequest request, ODataResponse response, UriInfo uriInfo)
throws ODataApplicationException {
throws ODataApplicationException {
throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
}

42
samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/service/DemoPrimitiveProcessor.java
View File

@ -6,9 +6,9 @@
* 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
@ -56,30 +56,27 @@ public class DemoPrimitiveProcessor implements PrimitiveProcessor {
private OData odata;
private Storage storage;
public DemoPrimitiveProcessor(Storage storage) {
this.storage = storage;
}
public void init(OData odata, ServiceMetadata serviceMetadata) {
this.odata = odata;
}
/*
* In our example, the URL would be: http://localhost:8080/DemoService/DemoService.svc/Products(1)/Name
* and the response:
* {
* @odata.context: "$metadata#Products/Name",
* value: "Notebook Basic 15"
*
* @odata.context: "$metadata#Products/Name",
* value: "Notebook Basic 15"
* }
* */
*/
public void readPrimitive(ODataRequest request, ODataResponse response,
UriInfo uriInfo, ContentType responseFormat)
throws ODataApplicationException, SerializerException {
UriInfo uriInfo, ContentType responseFormat)
throws ODataApplicationException, SerializerException {
// 1. Retrieve info from URI
// 1.1. retrieve the info about the requested entity set
@ -92,26 +89,25 @@ public class DemoPrimitiveProcessor implements PrimitiveProcessor {
// 1.2. retrieve the requested (Edm) property
// the last segment is the Property
UriResourceProperty uriProperty = (UriResourceProperty)resourceParts.get(resourceParts.size() -1);
UriResourceProperty uriProperty = (UriResourceProperty) resourceParts.get(resourceParts.size() - 1);
EdmProperty edmProperty = uriProperty.getProperty();
String edmPropertyName = edmProperty.getName();
// in our example, we know we have only primitive types in our model
EdmPrimitiveType edmPropertyType = (EdmPrimitiveType) edmProperty.getType();
// 2. retrieve data from backend
// 2.1. retrieve the entity data, for which the property has to be read
Entity entity = storage.readEntityData(edmEntitySet, keyPredicates);
if (entity == null) { // Bad request
throw new ODataApplicationException("Entity not found",
HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ENGLISH);
HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ENGLISH);
}
// 2.2. retrieve the property data from the entity
Property property = entity.getProperty(edmPropertyName);
if (property == null) {
throw new ODataApplicationException("Property not found",
HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ENGLISH);
HttpStatusCode.NOT_FOUND.getStatusCode(), Locale.ENGLISH);
}
// 3. serialize
@ -127,28 +123,28 @@ public class DemoPrimitiveProcessor implements PrimitiveProcessor {
SerializerResult serializerResult = serializer.primitive(edmPropertyType, property, options);
InputStream propertyStream = serializerResult.getContent();
//4. configure the response object
// 4. configure the response object
response.setContent(propertyStream);
response.setStatusCode(HttpStatusCode.OK.getStatusCode());
response.setHeader(HttpHeader.CONTENT_TYPE, responseFormat.toContentTypeString());
}else{
} else {
// in case there's no value for the property, we can skip the serialization
response.setStatusCode(HttpStatusCode.NO_CONTENT.getStatusCode());
}
}
/*
* These processor methods are not handled in this tutorial
* */
*/
public void updatePrimitive(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestFormat, ContentType responseFormat)
throws ODataApplicationException, DeserializerException, SerializerException {
public void updatePrimitive(ODataRequest request, ODataResponse response, UriInfo uriInfo, ContentType requestFormat,
ContentType responseFormat)
throws ODataApplicationException, DeserializerException, SerializerException {
throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
public void deletePrimitive(ODataRequest request, ODataResponse response, UriInfo uriInfo) throws ODataApplicationException {
public void deletePrimitive(ODataRequest request, ODataResponse response, UriInfo uriInfo)
throws ODataApplicationException {
throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
}

120
samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/util/Util.java
View File

@ -6,9 +6,9 @@
* 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
@ -37,15 +37,16 @@ import org.apache.olingo.server.api.uri.UriParameter;
public class Util {
public static Entity findEntity(EdmEntityType edmEntityType, EntityCollection entitySet, List<UriParameter> keyParams) {
public static Entity findEntity(EdmEntityType edmEntityType, EntityCollection entitySet,
List<UriParameter> keyParams) {
List<Entity> entityList = entitySet.getEntities();
// loop over all entities in order to find that one that matches all keys in request e.g. contacts(ContactID=1, CompanyID=1)
for(Entity entity : entityList){
// loop over all entities in order to find that one that matches
// all keys in request e.g. contacts(ContactID=1, CompanyID=1)
for (Entity entity : entityList) {
boolean foundEntity = entityMatchesAllKeys(edmEntityType, entity, keyParams);
if(foundEntity){
if (foundEntity) {
return entity;
}
}
@ -53,93 +54,98 @@ public class Util {
return null;
}
public static boolean entityMatchesAllKeys(EdmEntityType edmEntityType, Entity rt_entity,
List<UriParameter> keyParams) {
public static boolean entityMatchesAllKeys(EdmEntityType edmEntityType, Entity rt_entity, List<UriParameter> keyParams) {
// loop over all keys
for (final UriParameter key : keyParams) {
// key
String keyName = key.getName();
String keyText = key.getText();
// loop over all keys
for (final UriParameter key : keyParams) {
// key
String keyName = key.getName();
String keyText = key.getText();
// note: below line doesn't consider: keyProp can be part of a complexType in V4
// in such case, it would be required to access it via getKeyPropertyRef()
// but since this isn't the case in our model, we ignore it in our implementation
EdmProperty edmKeyProperty = (EdmProperty) edmEntityType.getProperty(keyName);
// Edm: we need this info for the comparison below
Boolean isNullable = edmKeyProperty.isNullable();
Integer maxLength = edmKeyProperty.getMaxLength();
Integer precision = edmKeyProperty.getPrecision();
Boolean isUnicode = edmKeyProperty.isUnicode();
Integer scale = edmKeyProperty.getScale();
// get the EdmType in order to compare
EdmType edmType = edmKeyProperty.getType();
// if(EdmType instanceof EdmPrimitiveType) // do we need this?
EdmPrimitiveType edmPrimitiveType = (EdmPrimitiveType) edmType;
// note: below line doesn't consider: keyProp can be part of a complexType in V4
// in such case, it would be required to access it via getKeyPropertyRef()
// but since this isn't the case in our model, we ignore it in our implementation
EdmProperty edmKeyProperty = (EdmProperty )edmEntityType.getProperty(keyName);
// Edm: we need this info for the comparison below
Boolean isNullable = edmKeyProperty.isNullable();
Integer maxLength = edmKeyProperty.getMaxLength();
Integer precision = edmKeyProperty.getPrecision();
Boolean isUnicode = edmKeyProperty.isUnicode();
Integer scale = edmKeyProperty.getScale();
// get the EdmType in order to compare
EdmType edmType = edmKeyProperty.getType();
//if(EdmType instanceof EdmPrimitiveType) // do we need this?
EdmPrimitiveType edmPrimitiveType = (EdmPrimitiveType)edmType;
// Runtime data: the value of the current entity
Object valueObject = rt_entity.getProperty(keyName).getValue(); // don't need to check for null, this is done in FWK
// TODO if the property is a complex type
// Runtime data: the value of the current entity
// don't need to check for null, this is done in FWK
Object valueObject = rt_entity.getProperty(keyName).getValue();
// TODO if the property is a complex type
// now need to compare the valueObject with the keyText String
// this is done using the type.valueToString
String valueAsString = null;
try {
valueAsString = edmPrimitiveType.valueToString(valueObject, isNullable, maxLength, precision, scale, isUnicode);
valueAsString = edmPrimitiveType.valueToString(valueObject, isNullable,
maxLength, precision, scale, isUnicode);
} catch (EdmPrimitiveTypeException e) {
return false; // TODO proper Exception handling
}
if (valueAsString == null){
if (valueAsString == null) {
return false;
}
boolean matches = valueAsString.equals(keyText);
if(matches){
if (matches) {
// if the given key value is found in the current entity, continue with the next key
continue;
}else{
} else {
// if any of the key properties is not found in the entity, we don't need to search further
return false;
}
}
return true;
}
return true;
}
/*
/**
* Example:
* For the following navigation: DemoService.svc/Categories(1)/Products
* we need the EdmEntitySet for the navigation property "Products"
*
* This is defined as follows in the metadata:
*
* <code>
*
* <EntitySet Name="Categories" EntityType="OData.Demo.Category">
<NavigationPropertyBinding Path="Products" Target="Products"/>
</EntitySet>
* The "Target" attribute specifies the target EntitySet
* Therefore we need the startEntitySet "Categories" in order to retrieve the target EntitySet "Products"
*/
public static EdmEntitySet getNavigationTargetEntitySet(EdmEntitySet startEntitySet, EdmNavigationProperty edmNavigationProperty) throws ODataApplicationException {
* <NavigationPropertyBinding Path="Products" Target="Products"/>
* </EntitySet>
* </code>
* The "Target" attribute specifies the target EntitySet
* Therefore we need the startEntitySet "Categories" in order to retrieve the target EntitySet "Products"
*/
public static EdmEntitySet getNavigationTargetEntitySet(EdmEntitySet startEntitySet,
EdmNavigationProperty edmNavigationProperty)
throws ODataApplicationException {
EdmEntitySet navigationTargetEntitySet = null;
String navPropName = edmNavigationProperty.getName();
EdmBindingTarget edmBindingTarget = startEntitySet.getRelatedBindingTarget(navPropName);
if(edmBindingTarget == null){
throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
if (edmBindingTarget == null) {
throw new ODataApplicationException("Not supported.",
HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
if(edmBindingTarget instanceof EdmEntitySet){
navigationTargetEntitySet = (EdmEntitySet)edmBindingTarget;
}else{
throw new ODataApplicationException("Not supported.", HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
if (edmBindingTarget instanceof EdmEntitySet) {
navigationTargetEntitySet = (EdmEntitySet) edmBindingTarget;
} else {
throw new ODataApplicationException("Not supported.",
HttpStatusCode.NOT_IMPLEMENTED.getStatusCode(), Locale.ROOT);
}
return navigationTargetEntitySet;
}
}
}

17
samples/tutorials/p4_navigation/src/main/java/myservice/mynamespace/web/DemoServlet.java
View File

@ -6,9 +6,9 @@
* 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
@ -45,16 +45,15 @@ public class DemoServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
private static final Logger LOG = LoggerFactory.getLogger(DemoServlet.class);
@Override
protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
try {
HttpSession session = req.getSession(true);
Storage storage = (Storage) session.getAttribute(Storage.class.getName());
if (storage == null) {
storage = new Storage();
session.setAttribute(Storage.class.getName(), storage);
}
HttpSession session = req.getSession(true);
Storage storage = (Storage) session.getAttribute(Storage.class.getName());
if (storage == null) {
storage = new Storage();
session.setAttribute(Storage.class.getName(), storage);
}
// create odata handler and configure it with EdmProvider and Processor
OData odata = OData.newInstance();