/
AuthenticationProvider.java
42 lines (37 loc) · 1.42 KB
/
AuthenticationProvider.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*
* Copyright (c) 2017 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.services.gateway.security.authentication;
import akka.http.javadsl.server.RequestContext;
/**
* Responsible for authenticating requests by a specific mechanism.
*
* @param <R> Type of the authentication result.
*/
public interface AuthenticationProvider<R extends AuthenticationResult> {
/**
* Indicates whether this authentication provider is applicable for the given request context.
*
* @param requestContext the request context to authenticate.
* @return {@code true} if this authentication provider is applicable for the given request context, {@code false}
* if not.
*/
boolean isApplicable(RequestContext requestContext);
/**
* Authenticates the given {@link RequestContext request context}.
*
* @param requestContext the request context to authenticate.
* @param correlationId the correlation ID of the request.
* @return the authentication result.
*/
R authenticate(RequestContext requestContext, CharSequence correlationId);
}