View Javadoc
1   /*
2    * Copyright (C) 2014 Christian Halstrick <christian.halstrick@sap.com>
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  package org.eclipse.jgit.transport.http.apache;
44  
45  import java.io.IOException;
46  import java.io.InputStream;
47  import java.io.OutputStream;
48  
49  import org.apache.http.entity.AbstractHttpEntity;
50  import org.eclipse.jgit.util.TemporaryBuffer;
51  
52  /**
53   * A {@link org.apache.http.HttpEntity} which takes its content from a
54   * {@link org.eclipse.jgit.util.TemporaryBuffer}
55   *
56   * @since 3.3
57   */
58  public class TemporaryBufferEntity extends AbstractHttpEntity
59  		implements AutoCloseable {
60  	private TemporaryBuffer buffer;
61  
62  	private Integer contentLength;
63  
64  	/**
65  	 * Construct a new {@link org.apache.http.HttpEntity} which will contain the
66  	 * content stored in the specified buffer
67  	 *
68  	 * @param buffer
69  	 */
70  	public TemporaryBufferEntity(TemporaryBuffer buffer) {
71  		this.buffer = buffer;
72  	}
73  
74  	/**
75  	 * Get the <code>buffer</code> containing the content
76  	 *
77  	 * @return buffer containing the content
78  	 */
79  	public TemporaryBuffer getBuffer() {
80  		return buffer;
81  	}
82  
83  	/** {@inheritDoc} */
84  	@Override
85  	public boolean isRepeatable() {
86  		return true;
87  	}
88  
89  	/** {@inheritDoc} */
90  	@Override
91  	public long getContentLength() {
92  		if (contentLength != null)
93  			return contentLength.intValue();
94  		return buffer.length();
95  	}
96  
97  	/** {@inheritDoc} */
98  	@Override
99  	public InputStream getContent() throws IOException, IllegalStateException {
100 		return buffer.openInputStream();
101 	}
102 
103 	/** {@inheritDoc} */
104 	@Override
105 	public void writeTo(OutputStream outstream) throws IOException {
106 		// TODO: dont we need a progressmonitor
107 		buffer.writeTo(outstream, null);
108 	}
109 
110 	/** {@inheritDoc} */
111 	@Override
112 	public boolean isStreaming() {
113 		return false;
114 	}
115 
116 	/**
117 	 * Set the <code>contentLength</code>
118 	 *
119 	 * @param contentLength
120 	 */
121 	public void setContentLength(int contentLength) {
122 		this.contentLength = Integer.valueOf(contentLength);
123 	}
124 
125 	/**
126 	 * {@inheritDoc}
127 	 *
128 	 * Close destroys the associated buffer used to buffer the entity
129 	 * @since 4.5
130 	 */
131 	@Override
132 	public void close() {
133 		if (buffer != null) {
134 			buffer.destroy();
135 		}
136 	}
137 }