001/*
002 *   Licensed to the Apache Software Foundation (ASF) under one
003 *   or more contributor license agreements.  See the NOTICE file
004 *   distributed with this work for additional information
005 *   regarding copyright ownership.  The ASF licenses this file
006 *   to you under the Apache License, Version 2.0 (the
007 *   "License"); you may not use this file except in compliance
008 *   with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *   Unless required by applicable law or agreed to in writing,
013 *   software distributed under the License is distributed on an
014 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *   KIND, either express or implied.  See the License for the
016 *   specific language governing permissions and limitations
017 *   under the License.
018 *
019 */
020package org.apache.directory.api.ldap.extras.extended.certGeneration;
021
022
023import org.apache.directory.api.ldap.model.message.ExtendedRequest;
024
025
026/**
027 * The interface for a certificate generation request extended operation. The 
028 * ASN.1 grammar for the value is :
029 * <pre>
030 *  CertGeneration ::= SEQUENCE {
031 *      target          OCTET STRING,
032 *      issuer          OCTET STRING,
033 *      subject         OCTET STRING,
034 *      keyAlgorithm    OCTET STRING
035 *  }
036 * </pre>
037 *
038 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
039 */
040public interface CertGenerationRequest extends ExtendedRequest
041{
042    /** The OID for the Certificate Generation extended operation request. */
043    String EXTENSION_OID = "1.3.6.1.4.1.18060.0.1.8";
044
045
046    /** 
047     * Get the Target DN for the certificate storage
048     * 
049     * @return The target DN 
050     **/
051    String getTargetDN();
052
053
054    /**
055     * Sets the target DN
056     * 
057     * @param targetDN The target DN
058     */
059    void setTargetDN( String targetDN );
060
061
062    /**
063     * @return The issuer's DN
064     */
065    String getIssuerDN();
066
067
068    /**
069     * Sets the issuer's DN
070     *  
071     * @param issuerDN the issuer's DN 
072     */
073    void setIssuerDN( String issuerDN );
074
075
076    /**
077     * @return The subect's DN
078     */
079    String getSubjectDN();
080
081
082    /**
083     * Sets the subect's DN
084     * 
085     * @param subjectDN The subect's DN
086     */
087    void setSubjectDN( String subjectDN );
088
089
090    /**
091     * @return The Key algorithm 
092     */
093    String getKeyAlgorithm();
094
095
096    /**
097     * Sets the Key algorithm
098     * @param keyAlgorithm The Key algorithm
099     */
100    void setKeyAlgorithm( String keyAlgorithm );
101}