com.rapidclipse.framework.security.authentication.Authenticator Maven / Gradle / Ivy
Show all versions of rap-security-auth Show documentation
/*
* 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
* Type parameter C (credentials) can for example be
* {@link CredentialsUsernamePassword}. It could also be a specific type of a
* user or subject in order to authenticate already existing user instances.
*
* Type parameter R (result) can be a Boolean for a simple information, if the
* authentication succeeded or failed. It can also be a concrete user instance
* in case a successful authentication has to create the user instance itself.
*
* @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.
*/
@FunctionalInterface
public interface Authenticator
{
/**
* Tries to authenticate the passed credentials and returns an apropriate
* result. The exact meaning of the result is implementation-dependant.
*
* @param credentials
* the credentials to be authenticated
* @return the result of the authentication
* @throws AuthenticationFailedException
*/
public R authenticate(C credentials) throws AuthenticationFailedException;
///////////////////////////////////////////////////////////////////////////
// default methods //
/////////////////////
/**
* Chains the passed {@link Authenticator} instance to this one to be
* evaluated in case the evaluation of this one returns a negative result.
*
* Note that multiple authenticators can be chained in sequence
*
* @param other
* the authenticator instance to be chained.
* @return an authenticator instance that firstly attempts to evaluate this
* authenticator and then the passed one if necessary.
*/
public default Authenticator then(final Authenticator other)
{
return new ChainingAuthenticator<>(this, other);
}
///////////////////////////////////////////////////////////////////////////
// static methods //
////////////////////
/**
* Trivial helper method to compensate for the Java 8 lambda extension
* loophole that a lambda expression cannot be recognized without a target
* (variable declaration or method call).
* Example:
* {@code Authenticator
* chained = ((c,r) -> debugAuth(c)).then((c,r) -> authenticate(c));}
*
* With this trivial helper method, this is possible: {@code Authenticator
*
* chained = lambda((c,r) -> debugAuth(c)).then((c,r) -> authenticate(c));}
*
*
*
* Trivially always returns the passed instance ({@code return lambda;}.
*
* Note that trivial static methods like this get eliminated (inlined) by
* the JIT compiler at runtime, so this convenience method does NOT come
* with a performance penalty.
*
* @param lambda
* the lambda instance to make recognizable to the compiler.
* @return lambda
*/
public static Authenticator lambda(final Authenticator lambda)
{
return lambda;
}
/**
* Returns a new {@link Authenticator} instance that wraps a sequence of
* passed authenticators. For further details, see
* {@link SequenceAuthenticator}.
*
* @param authenticators
* the {@link Authenticator} instances sequence to be wrapped.
* @return a wrapping {@link SequenceAuthenticator} instance.
*/
@SafeVarargs
public static Authenticator sequence(
final Authenticator... authenticators)
{
return SequenceAuthenticator.New(authenticators);
}
}