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     */
020    package org.apache.directory.server.kerberos.shared.store;
021    
022    
023    import javax.security.auth.kerberos.KerberosPrincipal;
024    
025    
026    /**
027     * The store interface used by Kerberos services.
028     * 
029     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
030     * @version $Rev:330489 $, $Date: 2009-04-05 23:46:12 +0300 (Sun, 05 Apr 2009) $
031     */
032    public interface PrincipalStore
033    {
034    
035        /**
036         * Change a principal's password.
037         *
038         * @param principal
039         * @param newPassword
040         * @return The name of the principal whose password is being changed.
041         * @throws Exception
042         */
043        public String changePassword( KerberosPrincipal principal, String newPassword ) throws Exception;
044    
045    
046        /**
047         * Get a {@link PrincipalStoreEntry} given a Kerberos principal.
048         *
049         * @param principal
050         * @return The {@link PrincipalStoreEntry} for the given Kerberos principal.
051         * @throws Exception
052         */
053        public PrincipalStoreEntry getPrincipal( KerberosPrincipal principal ) throws Exception;
054    }