PGPPublicKeyAccessor.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.converter.crypto;

import java.util.List;

import org.apache.camel.Exchange;
import org.bouncycastle.openpgp.PGPPublicKey;

public interface PGPPublicKeyAccessor {

    /**
     * Returns the encryption keys for the given user ID parts. This method is
     * used for encryption.
     * 
     * @param exchange
     *            exchange, can be <code>null</code>
     * @param useridParts
     *            parts of User IDs, must not be <code>null</code>
     * @return list of public keys, must not be <code>null</code>
     */
    List<PGPPublicKey> getEncryptionKeys(Exchange exchange, List<String> useridParts) throws Exception;

    /**
     * Returns the public key with a certain key ID. This method is used for
     * verifying the signature. The given User IDs are provided to filter the
     * public key, further. If the User ID parts list is empty, then any public
     * key can be returned which has the specified key ID. If the User ID parts
     * list is not empty then the returned key must have a User ID which
     * contains at least one User ID part.
     * 
     * @param exchange
     *            exchange
     * @param keyId
     *            key ID
     * @param useridParts
     *            parts of User IDs, must not be <code>null</code>, but can be
     *            empty
     * @return public key or <code>null</code> if the key cannot be found
     */
    PGPPublicKey getPublicKey(Exchange exchange, long keyId, List<String> useridParts) throws Exception;

}