1adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/* 2adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 3adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 4adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * this work for additional information regarding copyright ownership. 5adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 6adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * (the "License"); you may not use this file except in compliance with 7adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the License. You may obtain a copy of the License at 8adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 9adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 10adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * 11adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Unless required by applicable law or agreed to in writing, software 12adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 13adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * See the License for the specific language governing permissions and 15adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * limitations under the License. 16adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 17adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 18adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpackage java.security; 19adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 20adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.io.IOException; 21adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.security.spec.AlgorithmParameterSpec; 22adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectimport java.security.spec.InvalidParameterSpecException; 23adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 24adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project/** 25adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code AlgorithmParametersSpi} is the Service Provider Interface (SPI) 26adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * definition for {@code AlgorithmParameters}. 27f33eae7e84eb6d3b0f4e86b59605bb3de73009f3Elliott Hughes * 28adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @see AlgorithmParameters 29adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 30adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Projectpublic abstract class AlgorithmParametersSpi { 31adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 32adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 33adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Initializes this {@code AlgorithmParametersSpi} with the specified 34adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code AlgorithmParameterSpec}. 352f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 36adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param paramSpec 37adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the parameter specification. 38adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws InvalidParameterSpecException 39adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code AlgorithmParametersSpi} has already been 40adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * initialized or the given {@code paramSpec} is not appropriate 41adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * for initializing this {@code AlgorithmParametersSpi}. 42adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 43adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected abstract void engineInit(AlgorithmParameterSpec paramSpec) 44adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws InvalidParameterSpecException; 45adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 46adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 47adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Initializes this {@code AlgorithmParametersSpi} with the specified 48adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code byte[]} using the default decoding format for parameters. The 49adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * default encoding format is ASN.1. 502f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 51adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param params 52adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the encoded parameters. 53adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 54adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code AlgorithmParametersSpi} has already been 55adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * initialized, or the parameter could not be encoded. 56adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 57adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected abstract void engineInit(byte[] params) throws IOException; 58adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 59adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 60adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Initializes this {@code AlgorithmParametersSpi} with the specified 61adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code byte[]} using the specified decoding format. 622f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 63adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param params 64adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the encoded parameters. 65adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param format 66adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the name of the decoding format. 67adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 68adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code AlgorithmParametersSpi} has already been 69adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * initialized, or the parameter could not be encoded. 70adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 71adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected abstract void engineInit(byte[] params, String format) 72adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws IOException; 73adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 74adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 75adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the {@code AlgorithmParameterSpec} for this {@code 76adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * AlgorithmParametersSpi}. 772f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 78adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param paramSpec 79adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the type of the parameter specification in which this 80adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * parameters should be converted. 81adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the {@code AlgorithmParameterSpec} for this {@code 82adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * AlgorithmParametersSpi}. 83adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws InvalidParameterSpecException 84adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code AlgorithmParametersSpi} has already been 85adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * initialized, or if this parameters could not be converted to 86adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the specified class. 87adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 88adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected abstract <T extends AlgorithmParameterSpec> T engineGetParameterSpec( 89adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project Class<T> paramSpec) throws InvalidParameterSpecException; 90adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 91adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 92adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the parameters in their default encoding format. The default 93adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * encoding format is ASN.1. 942f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 95adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the encoded parameters. 96adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 97adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code AlgorithmParametersSpi} has already been 98adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * initialized, or if this parameters could not be encoded. 99adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 100adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected abstract byte[] engineGetEncoded() throws IOException; 101adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 102adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 103adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns the parameters in the specified encoding format. 1042f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 105adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @param format 106adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * the name of the encoding format. 107adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return the encoded parameters. 108adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @throws IOException 109adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * if this {@code AlgorithmParametersSpi} has already been 110adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * initialized, or if this parameters could not be encoded. 111adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 112adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected abstract byte[] engineGetEncoded(String format) 113adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project throws IOException; 114adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 115adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project /** 116adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * Returns a string containing a concise, human-readable description of this 117adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * {@code AlgorithmParametersSpi}. 1182f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes * 119adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * @return a printable representation for this {@code 120adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project * AlgorithmParametersSpi}. 121adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project */ 122adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project protected abstract String engineToString(); 123adc854b798c1cfe3bfd4c27d68d5cee38ca617daThe Android Open Source Project 1242f9e468ed4985edfd5e351faf2089d91e561e41dElliott Hughes} 125