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.ldap.client.template;
021
022
023import org.apache.directory.ldap.client.template.exception.PasswordException;
024
025
026/**
027 * A class for translating the outcome of a {@link PasswordPolicyOperation}.
028 *
029 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
030 */
031public interface PasswordPolicyResponder
032{
033    /**
034     * Execute the <code>operation</code> and translate the outcome as follows:
035     * 
036     * <ul>
037     * <li>SUCCESS: return null</li>
038     * <li>WARNING: return {@link PasswordWarning}</li>
039     * <li>FAILURE: throw {@link PasswordException}</li>
040     * </ul>
041     * 
042     * @param operation An operation whose outcome implies password policy 
043     * information
044     * @return A <code>PasswordWarning</code> if warnings are present, or null 
045     * if completely successful.
046     * @throws PasswordException If the <code>operation</code> was a failure.
047     */
048    PasswordWarning process( PasswordPolicyOperation operation ) throws PasswordException;
049}