1/*
2 *  Licensed to the Apache Software Foundation (ASF) under one or more
3 *  contributor license agreements.  See the NOTICE file distributed with
4 *  this work for additional information regarding copyright ownership.
5 *  The ASF licenses this file to You under the Apache License, Version 2.0
6 *  (the "License"); you may not use this file except in compliance with
7 *  the License.  You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 */
17
18package java.security.spec;
19
20/**
21 * The abstract key specification for a public or a private key in encoded
22 * format.
23 */
24public abstract class EncodedKeySpec implements KeySpec {
25    // Encoded key
26    private final byte[] encodedKey;
27
28    /**
29     * Creates a new {@code EncodedKeySpec} with the specified encoded key bytes.
30     *
31     * @param encodedKey
32     *            the encoded key bytes.
33     */
34    public EncodedKeySpec(byte[] encodedKey) {
35        // Defensively copies parameter
36        // to prevent subsequent modification
37        this.encodedKey = new byte[encodedKey.length];
38        System.arraycopy(encodedKey, 0,
39                this.encodedKey, 0, this.encodedKey.length);
40    }
41
42    /**
43     * Returns the encoded key bytes.
44     *
45     * @return the encoded key bytes.
46     */
47    public byte[] getEncoded() {
48        // Defensively copies private array
49        // to prevent subsequent modification
50        byte[] ret = new byte[encodedKey.length];
51        System.arraycopy(encodedKey, 0, ret, 0, ret.length);
52        return ret;
53    }
54
55    /**
56     * Returns the name of the encoding format of this encoded key
57     * specification.
58     *
59     * @return the name of the encoding format of this encoded key
60     *         specification.
61     */
62    public abstract String getFormat();
63}
64