001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027package org.apache.http.nio.reactor.ssl;
028
029import java.nio.ByteBuffer;
030
031/**
032 * Managed internal SSL buffer.
033 */
034public interface SSLBuffer {
035
036    /**
037     * Allocates the resources required for this buffer, or returns the resources already allocated for this buffer.
038     * Unless {@link #release() } is called, multiple invokations to this method must return the same
039     * {@link java.nio.ByteBuffer}.
040     * @return buffer
041     */
042    ByteBuffer acquire();
043
044    /**
045     * Releases the resources for this buffer. If the buffer has already been released, this method does nothing.
046     */
047    void release();
048
049    /**
050     * Tests to see if this buffer has been acquired.
051     * @return {@code true} if the buffer is acquired, otherwise {@code false}
052     */
053    boolean isAcquired();
054
055    /**
056     * Tests to make sure that the buffer has been acquired and the underlying buffer has a position larger than
057     * {@code 0}. Essentially the same as {@code isAquired() && acquire().position > 0}.
058     * @return {@code true} if the buffer has been acquired and the underlying buffer's position is {@code &gt; 0},
059     * otherwise {@code false}
060     */
061    boolean hasData();
062}