PasswordProtector.java

/*
 * Copyright 2015-2025 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package sockslib.server.manager;

/**
 * The interface <code>PasswordProtector</code> define a password protector.
 *
 * @author Youchao Feng
 * @version 1.0
 * @date Sep 6, 2015
 */
@FunctionalInterface
public interface PasswordProtector {

  /**
   * Return the encrypted password.
   *
   * @param user The instance of {@link User} which need encrypt password.
   * @return Encrypted password.
   */
  String encrypt(final User user);

}