001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.extensions;
028    
029    
030    
031    import javax.net.ssl.KeyManager;
032    
033    import org.opends.server.admin.std.server.KeyManagerProviderCfg;
034    import org.opends.server.api.KeyManagerProvider;
035    import org.opends.server.config.ConfigException;
036    import org.opends.server.types.DirectoryException;
037    import org.opends.server.types.InitializationException;
038    
039    
040    
041    
042    /**
043     * This class provides an implementation of a key manager provider that does not
044     * actually have the ability to provide a key manager.  It will be used when no
045     * other key manager provider has been defined in the server configuration.
046     */
047    public class NullKeyManagerProvider
048           extends KeyManagerProvider<KeyManagerProviderCfg>{
049    
050    
051    
052      /**
053       * Creates a new instance of this null key manager provider.  The
054       * <CODE>initializeKeyManagerProvider</CODE> method must be called on the
055       * resulting object before it may be used.
056       */
057      public NullKeyManagerProvider()
058      {
059        // No implementation is required.
060      }
061    
062    
063    
064      /**
065       * {@inheritDoc}
066       */
067      @Override
068      public void initializeKeyManagerProvider(
069          KeyManagerProviderCfg configuration) throws ConfigException,
070          InitializationException {
071        // No implementation is required.
072      }
073    
074    
075    
076      /**
077       * Performs any finalization that may be necessary for this key manager
078       * provider.
079       */
080      public void finalizeKeyManagerProvider()
081      {
082        // No implementation is required.
083      }
084    
085    
086    
087      /**
088       * Retrieves a <CODE>KeyManager</CODE> object that may be used for
089       * interactions requiring access to a key manager.
090       *
091       * @return  A <CODE>KeyManager</CODE> object that may be used for interactions
092       *          requiring access to a key manager.
093       *
094       * @throws  DirectoryException  If a problem occurs while attempting to obtain
095       *                              the set of key managers.
096       */
097      public KeyManager[] getKeyManagers()
098             throws DirectoryException
099      {
100        return new KeyManager[0];
101      }
102    }
103