com.rapidclipse.framework.security.authentication.AuthenticatorProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rap-security-auth Show documentation

Rapid Application Platform / Security / Authentication and Authorization

There is a newer version: 14.0.0

/*
 * Copyright (C) 2013-2023 by XDEV Software, All Rights Reserved.
 *
 * This file is part of the RapidClipse Application Platform (RAP).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 *
 * SPDX-License-Identifier: AGPL-3.0-or-later
 *
 * Contributors:
 *     XDEV Software - initial API and implementation
 */
package com.rapidclipse.framework.security.authentication;

/**
 * Type that provides a usable {@link Authenticator} instance.
 *
 * @author XDEV Software (TM)
 * 
 * @param 
 *            the type of the credentials instance to be authenticated.
 * @param 
 *            the type of the result/response instance to be returned upon an
 *            authentication attempt.
 */
public interface AuthenticatorProvider
{
	/**
	 * Provides a usable {@link Authenticator} instance. Whether "providing"
	 * means creating a new instance or returning an existing one, maybe even
	 * always the same, is completely implementation-specific.
	 *
	 * @return a usable {@link Authenticator} instance
	 */
	public  Authenticator provideAuthenticator();
}