1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27 package org.apache.http.nio.reactor.ssl;
28
29 import java.nio.ByteBuffer;
30
31 /**
32 * Managed internal SSL buffer.
33 */
34 public interface SSLBuffer {
35
36 /**
37 * Allocates the resources required for this buffer, or returns the resources already allocated for this buffer.
38 * Unless {@link #release() } is called, multiple invokations to this method must return the same
39 * {@link java.nio.ByteBuffer}.
40 * @return buffer
41 */
42 ByteBuffer acquire();
43
44 /**
45 * Releases the resources for this buffer. If the buffer has already been released, this method does nothing.
46 */
47 void release();
48
49 /**
50 * Tests to see if this buffer has been acquired.
51 * @return {@code true} if the buffer is acquired, otherwise {@code false}
52 */
53 boolean isAcquired();
54
55 /**
56 * Tests to make sure that the buffer has been acquired and the underlying buffer has a position larger than
57 * {@code 0}. Essentially the same as {@code isAquired() && acquire().position > 0}.
58 * @return {@code true} if the buffer has been acquired and the underlying buffer's position is {@code > 0},
59 * otherwise {@code false}
60 */
61 boolean hasData();
62 }