lib/server-core/src/main/java/org/apache/olingo/server/core/serializer/BatchResponseSerializer.java - olingo-odata4 - Git at Google

 /*
  * 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.serializer;

 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 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;

 import org.apache.olingo.commons.api.ex.ODataRuntimeException;
 import org.apache.olingo.commons.api.format.ContentType;
 import org.apache.olingo.commons.api.http.HttpHeader;
 import org.apache.olingo.commons.api.http.HttpStatusCode;
 import org.apache.olingo.server.api.ODataContent;
 import org.apache.olingo.server.api.ODataResponse;
 import org.apache.olingo.server.api.deserializer.batch.ODataResponsePart;
 import org.apache.olingo.server.api.serializer.BatchSerializerException;
 import org.apache.olingo.server.api.serializer.BatchSerializerException.MessageKeys;
 import org.apache.olingo.server.core.deserializer.batch.BatchParserCommon;

 public class BatchResponseSerializer {
   private static final int BUFFER_SIZE = 4096;
   private static final String DOUBLE_DASH = "--";
   private static final String COLON = ":";
   private static final String SP = " ";
   private static final String CRLF = "\r\n";

   public InputStream serialize(final List<ODataResponsePart> responses, final String boundary)
       throws BatchSerializerException {
     BodyBuilder builder = createBody(responses, boundary);

     return new ByteArrayInputStream(builder.getContent());
   }

   private BodyBuilder createBody(final List<ODataResponsePart> batchResponses, final String boundary)
       throws BatchSerializerException {
     final BodyBuilder builder = new BodyBuilder();

     for (final ODataResponsePart part : batchResponses) {
       builder.append(getDashBoundary(boundary));

       if (part.isChangeSet()) {
         appendChangeSet(part, builder);
       } else {
         appendBodyPart(part.getResponses().get(0), builder, false);
       }
     }
     builder.append(getCloseDelimiter(boundary));

     return builder;
   }

   private void appendChangeSet(final ODataResponsePart part, final BodyBuilder builder)
       throws BatchSerializerException {
     final String changeSetBoundary = generateBoundary("changeset");

     appendChangeSetHeader(builder, changeSetBoundary);
     builder.append(CRLF);

     for (final ODataResponse response : part.getResponses()) {
       builder.append(getDashBoundary(changeSetBoundary));
       appendBodyPart(response, builder, true);
     }

     builder.append(getCloseDelimiter(changeSetBoundary));
   }

   private void appendBodyPart(final ODataResponse response, final BodyBuilder builder, final boolean isChangeSet)
       throws BatchSerializerException {

     appendBodyPartHeader(response, builder, isChangeSet);
     builder.append(CRLF);

     appendStatusLine(response, builder);
     Body body = new Body(response);
     appendResponseHeader(response, body.getLength(), builder);
     builder.append(CRLF);

     builder.append(body);
     builder.append(CRLF);
   }

   private void appendChangeSetHeader(final BodyBuilder builder, final String changeSetBoundary) {
     appendHeader(HttpHeader.CONTENT_TYPE, ContentType.MULTIPART_MIXED
         + "; boundary=" + changeSetBoundary, builder);
   }

   private void appendHeader(final String name, final String value, final BodyBuilder builder) {
     builder.append(name)
         .append(COLON)
         .append(SP)
         .append(value)
         .append(CRLF);
   }

   private void appendStatusLine(final ODataResponse response, final BodyBuilder builder) {
     builder.append("HTTP/1.1")
         .append(SP)
         .append(response.getStatusCode())
         .append(SP)
         .append(getStatusCodeInfo(response))
         .append(CRLF);
   }

   private String getStatusCodeInfo(final ODataResponse response) {
     HttpStatusCode status = HttpStatusCode.fromStatusCode(response.getStatusCode());
     if (status == null) {
       throw new ODataRuntimeException("Invalid status code in response '" + response.getStatusCode() + "'");
     }
     return status.getInfo();
   }

   private void appendResponseHeader(final ODataResponse response, final int contentLength,
       final BodyBuilder builder) {
     final Map<String, List<String>> header = response.getAllHeaders();

     for (final Map.Entry<String, List<String>> entry : header.entrySet()) {
       // Requests never have a content id header.
       if (!entry.getKey().equalsIgnoreCase(HttpHeader.CONTENT_ID)) {
         appendHeader(entry.getKey(), entry.getValue().get(0), builder);
       }
     }

     appendHeader(HttpHeader.CONTENT_LENGTH, Integer.toString(contentLength), builder);
   }

   private void appendBodyPartHeader(final ODataResponse response, final BodyBuilder builder,
       final boolean isChangeSet) throws BatchSerializerException {
     appendHeader(HttpHeader.CONTENT_TYPE, ContentType.APPLICATION_HTTP.toContentTypeString(), builder);
     appendHeader(BatchParserCommon.CONTENT_TRANSFER_ENCODING, BatchParserCommon.BINARY_ENCODING, builder);

     if (isChangeSet) {
       if (response.getHeader(HttpHeader.CONTENT_ID) != null) {
         appendHeader(HttpHeader.CONTENT_ID, response.getHeader(HttpHeader.CONTENT_ID), builder);
       } else {
         throw new BatchSerializerException("Missing content id", MessageKeys.MISSING_CONTENT_ID);
       }
     }
   }

   private String getDashBoundary(final String boundary) {
     return DOUBLE_DASH + boundary + CRLF;
   }

   private String getCloseDelimiter(final String boundary) {
     return DOUBLE_DASH + boundary + DOUBLE_DASH + CRLF;
   }

   private String generateBoundary(final String value) {
     return value + "_" + UUID.randomUUID().toString();
   }

   /**
    * Builder class to create the body and the header.
    */
   private static class BodyBuilder {
     private static final Charset CHARSET_ISO_8859_1 = Charset.forName("iso-8859-1");
     private ByteBuffer buffer = ByteBuffer.allocate(BUFFER_SIZE);
     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(final String string) {
       byte[] b = string.getBytes(CHARSET_ISO_8859_1);
       put(b);
       return this;
     }

     private void put(final byte[] b) {
       if (isClosed) {
         throw new ODataRuntimeException("BodyBuilder is closed.");
       }
       if (buffer.remaining() < b.length) {
         buffer.flip();
         int newSize = (buffer.limit() * 2) + b.length;
         ByteBuffer tmp = ByteBuffer.allocate(newSize);
         tmp.put(buffer);
         buffer = tmp;
       }
       buffer.put(b);
     }

     public BodyBuilder append(final int statusCode) {
       return append(String.valueOf(statusCode));
     }

     public BodyBuilder append(final Body body) {
       put(body.getContent());
       return this;
     }

     @Override
     public String toString() {
       return new String(buffer.array(), 0, buffer.position(), CHARSET_ISO_8859_1);
     }
   }

   /**
    * Body part which is read and stored as bytes (no charset conversion).
    */
   private static class Body {
     private final byte[] content;

     Body(final ODataResponse response) {
       content = getBody(response);
     }

     private int getLength() {
       return content.length;
     }

     private byte[] getContent() {
       return content; //NOSONAR
     }

     private byte[] getBody(final ODataResponse response) {
       if (response == null || (response.getContent() == null &&
           response.getODataContent() == null)) {
         return new byte[0];
       }

       try {
         ByteArrayOutputStream output = new ByteArrayOutputStream();
         ByteBuffer inBuffer = ByteBuffer.allocate(BUFFER_SIZE);
         if (response.getContent() == null) {
           if (response.getODataContent() != null) {
             ODataContent res = response.getODataContent();
             res.write(Channels.newChannel(output));
             }
         } else {
           try (WritableByteChannel oc = Channels.newChannel(output)) {
             try (ReadableByteChannel ic = Channels.newChannel(response.getContent())) {
               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", e);
       }
     }
   }
 }
	/*
	* 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.serializer;

	import java.io.ByteArrayInputStream;
	import java.io.ByteArrayOutputStream;
	import java.io.IOException;
	import java.io.InputStream;
	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;

	import org.apache.olingo.commons.api.ex.ODataRuntimeException;
	import org.apache.olingo.commons.api.format.ContentType;
	import org.apache.olingo.commons.api.http.HttpHeader;
	import org.apache.olingo.commons.api.http.HttpStatusCode;
	import org.apache.olingo.server.api.ODataContent;
	import org.apache.olingo.server.api.ODataResponse;
	import org.apache.olingo.server.api.deserializer.batch.ODataResponsePart;
	import org.apache.olingo.server.api.serializer.BatchSerializerException;
	import org.apache.olingo.server.api.serializer.BatchSerializerException.MessageKeys;
	import org.apache.olingo.server.core.deserializer.batch.BatchParserCommon;

	public class BatchResponseSerializer {
	private static final int BUFFER_SIZE = 4096;
	private static final String DOUBLE_DASH = "--";
	private static final String COLON = ":";
	private static final String SP = " ";
	private static final String CRLF = "\r\n";

	public InputStream serialize(final List<ODataResponsePart> responses, final String boundary)
	throws BatchSerializerException {
	BodyBuilder builder = createBody(responses, boundary);

	return new ByteArrayInputStream(builder.getContent());
	}

	private BodyBuilder createBody(final List<ODataResponsePart> batchResponses, final String boundary)
	throws BatchSerializerException {
	final BodyBuilder builder = new BodyBuilder();

	for (final ODataResponsePart part : batchResponses) {
	builder.append(getDashBoundary(boundary));

	if (part.isChangeSet()) {
	appendChangeSet(part, builder);
	} else {
	appendBodyPart(part.getResponses().get(0), builder, false);
	}
	}
	builder.append(getCloseDelimiter(boundary));

	return builder;
	}

	private void appendChangeSet(final ODataResponsePart part, final BodyBuilder builder)
	throws BatchSerializerException {
	final String changeSetBoundary = generateBoundary("changeset");

	appendChangeSetHeader(builder, changeSetBoundary);
	builder.append(CRLF);

	for (final ODataResponse response : part.getResponses()) {
	builder.append(getDashBoundary(changeSetBoundary));
	appendBodyPart(response, builder, true);
	}

	builder.append(getCloseDelimiter(changeSetBoundary));
	}

	private void appendBodyPart(final ODataResponse response, final BodyBuilder builder, final boolean isChangeSet)
	throws BatchSerializerException {

	appendBodyPartHeader(response, builder, isChangeSet);
	builder.append(CRLF);

	appendStatusLine(response, builder);
	Body body = new Body(response);
	appendResponseHeader(response, body.getLength(), builder);
	builder.append(CRLF);

	builder.append(body);
	builder.append(CRLF);
	}

	private void appendChangeSetHeader(final BodyBuilder builder, final String changeSetBoundary) {
	appendHeader(HttpHeader.CONTENT_TYPE, ContentType.MULTIPART_MIXED
	+ "; boundary=" + changeSetBoundary, builder);
	}

	private void appendHeader(final String name, final String value, final BodyBuilder builder) {
	builder.append(name)
	.append(COLON)
	.append(SP)
	.append(value)
	.append(CRLF);
	}

	private void appendStatusLine(final ODataResponse response, final BodyBuilder builder) {
	builder.append("HTTP/1.1")
	.append(SP)
	.append(response.getStatusCode())
	.append(SP)
	.append(getStatusCodeInfo(response))
	.append(CRLF);
	}

	private String getStatusCodeInfo(final ODataResponse response) {
	HttpStatusCode status = HttpStatusCode.fromStatusCode(response.getStatusCode());
	if (status == null) {
	throw new ODataRuntimeException("Invalid status code in response '" + response.getStatusCode() + "'");
	}
	return status.getInfo();
	}

	private void appendResponseHeader(final ODataResponse response, final int contentLength,
	final BodyBuilder builder) {
	final Map<String, List<String>> header = response.getAllHeaders();

	for (final Map.Entry<String, List<String>> entry : header.entrySet()) {
	// Requests never have a content id header.
	if (!entry.getKey().equalsIgnoreCase(HttpHeader.CONTENT_ID)) {
	appendHeader(entry.getKey(), entry.getValue().get(0), builder);
	}
	}

	appendHeader(HttpHeader.CONTENT_LENGTH, Integer.toString(contentLength), builder);
	}

	private void appendBodyPartHeader(final ODataResponse response, final BodyBuilder builder,
	final boolean isChangeSet) throws BatchSerializerException {
	appendHeader(HttpHeader.CONTENT_TYPE, ContentType.APPLICATION_HTTP.toContentTypeString(), builder);
	appendHeader(BatchParserCommon.CONTENT_TRANSFER_ENCODING, BatchParserCommon.BINARY_ENCODING, builder);

	if (isChangeSet) {
	if (response.getHeader(HttpHeader.CONTENT_ID) != null) {
	appendHeader(HttpHeader.CONTENT_ID, response.getHeader(HttpHeader.CONTENT_ID), builder);
	} else {
	throw new BatchSerializerException("Missing content id", MessageKeys.MISSING_CONTENT_ID);
	}
	}
	}

	private String getDashBoundary(final String boundary) {
	return DOUBLE_DASH + boundary + CRLF;
	}

	private String getCloseDelimiter(final String boundary) {
	return DOUBLE_DASH + boundary + DOUBLE_DASH + CRLF;
	}

	private String generateBoundary(final String value) {
	return value + "_" + UUID.randomUUID().toString();
	}

	/**
	* Builder class to create the body and the header.
	*/
	private static class BodyBuilder {
	private static final Charset CHARSET_ISO_8859_1 = Charset.forName("iso-8859-1");
	private ByteBuffer buffer = ByteBuffer.allocate(BUFFER_SIZE);
	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(final String string) {
	byte[] b = string.getBytes(CHARSET_ISO_8859_1);
	put(b);
	return this;
	}

	private void put(final byte[] b) {
	if (isClosed) {
	throw new ODataRuntimeException("BodyBuilder is closed.");
	}
	if (buffer.remaining() < b.length) {
	buffer.flip();
	int newSize = (buffer.limit() * 2) + b.length;
	ByteBuffer tmp = ByteBuffer.allocate(newSize);
	tmp.put(buffer);
	buffer = tmp;
	}
	buffer.put(b);
	}

	public BodyBuilder append(final int statusCode) {
	return append(String.valueOf(statusCode));
	}

	public BodyBuilder append(final Body body) {
	put(body.getContent());
	return this;
	}

	@Override
	public String toString() {
	return new String(buffer.array(), 0, buffer.position(), CHARSET_ISO_8859_1);
	}
	}

	/**
	* Body part which is read and stored as bytes (no charset conversion).
	*/
	private static class Body {
	private final byte[] content;

	Body(final ODataResponse response) {
	content = getBody(response);
	}

	private int getLength() {
	return content.length;
	}

	private byte[] getContent() {
	return content; //NOSONAR
	}

	private byte[] getBody(final ODataResponse response) {
	if (response == null \|\| (response.getContent() == null &&
	response.getODataContent() == null)) {
	return new byte[0];
	}

	try {
	ByteArrayOutputStream output = new ByteArrayOutputStream();
	ByteBuffer inBuffer = ByteBuffer.allocate(BUFFER_SIZE);
	if (response.getContent() == null) {
	if (response.getODataContent() != null) {
	ODataContent res = response.getODataContent();
	res.write(Channels.newChannel(output));
	}
	} else {
	try (WritableByteChannel oc = Channels.newChannel(output)) {
	try (ReadableByteChannel ic = Channels.newChannel(response.getContent())) {
	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", e);
	}
	}
	}
	}