org.apache.james.mailet.crypto.KeyHolder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apache-mailet-crypto Show documentation

Apache James Cryptographic Mailets is a collection of mailets which use cryptography. This includes matching signatures, decrypting, encrypting and signing.

There is a newer version: 3.1.0

Show newest version

/****************************************************************
 * 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.james.mailet.crypto;

import javax.mail.internet.MimeBodyPart;
import javax.mail.internet.MimeMessage;
import javax.mail.internet.MimeMultipart;

/**
 * Interface to an object that will do cryptographic activity on a MimeMessage,
 * and contains the needed cryptographic key.
 * The implementing objects have the role of being a simpler intermediate to the crypto libraries.
 * @version CVS $Revision: 721862 $ $Date: 2008-11-30 19:38:25 +0200 (Du, 30 nov 2008) $
 * @since 3.0
 */
public interface KeyHolder {
    
    /**
     * Generates a signed MimeMultipart from a MimeMessage.
     * @param message The message to sign.
     * @return The signed MimeMultipart.
     */    
    public MimeMultipart generate(MimeMessage message) throws Exception;

    /**
     * Generates a signed MimeMultipart from a MimeBodyPart.
     * @param content The content to sign.
     * @return The signed MimeMultipart.
     */    
    public MimeMultipart generate(MimeBodyPart content) throws Exception;

    /**
     * Getter for property signerDistinguishedName.
     * @return Value of property signerDistinguishedName.
     */
    public String getSignerDistinguishedName();
    
    /**
     * Getter for property signerCN.
     * @return Value of property signerCN.
     */
    public String getSignerCN();
    
     /**
     * Getter for property signerAddress.
     * @return Value of property signerMailAddress.
     */
    public String getSignerAddress();
    
}