View Javadoc

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       * Allocates the resources required for this buffer, or returns the resources already allocated for this buffer.
37       * Unless {@link #release() } is called, multiple invokations to this method must return the same
38       * {@link java.nio.ByteBuffer}.
39       * @return buffer
40       */
41      ByteBuffer acquire();
42      /**
43       * Releases the resources for this buffer. If the buffer has already been released, this method does nothing.
44       */
45      void release();
46      /**
47       * Tests to see if this buffer has been acquired.
48       * @return {@code true} if the buffer is acquired, otherwise {@code false}
49       */
50      boolean isAcquired();
51      /**
52       * Tests to make sure that the buffer has been acquired and the underlying buffer has a position larger than
53       * {@code 0}. Essentially the same as {@code isAquired() && acquire().position > 0}.
54       * @return {@code true} if the buffer has been acquired and the underlying buffer's position is {@code &gt; 0},
55       * otherwise {@code false}
56       */
57      boolean hasData();
58  }