1 /*
2 * Copyright 2016 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty5.handler.ssl;
17
18 import io.netty5.buffer.api.Buffer;
19
20 /**
21 * A marker interface for PEM encoded values.
22 */
23 interface PemEncoded extends AutoCloseable {
24 /**
25 * Returns the {@link Buffer} with the PEM encoded contents of this value.
26 * <p>
27 * <strong>Note:</strong> The returned buffer should not be closed directly.
28 * Instead, {@link #close()} should be called on this PEM encoded value instead.
29 *
30 * @return The underlying {@link Buffer} with the contents of this PEM encoded value.
31 */
32 Buffer content();
33
34 /**
35 * Return a copy of this PEM encoded value.
36 *
37 * @return A new identical copy of this PEM encoded value.
38 */
39 PemEncoded copy();
40
41 /**
42 * Close this PEM encoded value and free its related resources.
43 */
44 @Override
45 void close();
46 }