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.server.kerberos.shared.store;
021
022
023import javax.security.auth.kerberos.KerberosPrincipal;
024
025import org.apache.directory.server.kerberos.changepwd.exceptions.ChangePasswordException;
026
027
028/**
029 * The store interface used by Kerberos services.
030 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public interface PrincipalStore
034{
035
036    /**
037     * Change a principal's password.
038     * 
039     * @param byPrincipal the principal which is changing the password for the forPrincipal
040     * @param forPrincipal the principal whose password is being set or changed
041     * @param newPassword the new password
042     * @param isInitialTicket tells if the ticket is a freshly obtained ticket
043     * @throws ChangePasswordException If the password change failed
044     */
045    void changePassword( KerberosPrincipal byPrincipal, KerberosPrincipal forPrincipal, String newPassword,
046        boolean isInitialTicket ) throws ChangePasswordException;
047
048
049    /**
050     * Get a {@link PrincipalStoreEntry} given a Kerberos principal.
051     *
052     * @param principal
053     * @return The {@link PrincipalStoreEntry} for the given Kerberos principal.
054     * @throws Exception
055     */
056    PrincipalStoreEntry getPrincipal( KerberosPrincipal principal ) throws Exception;
057}