-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auth Manager API part 3: OAuth2 Manager (#11844)
* Auth Manager API part 3: OAuth2 Manager * review * review: eviction executor * checkstyle * checkstyle * use ThreadPools.newExitingWorkerPool * fix test
- Loading branch information
Showing
10 changed files
with
1,233 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
core/src/main/java/org/apache/iceberg/rest/auth/AuthSessionCache.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you 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 org.apache.iceberg.rest.auth; | ||
|
||
import com.github.benmanes.caffeine.cache.Cache; | ||
import com.github.benmanes.caffeine.cache.Caffeine; | ||
import com.github.benmanes.caffeine.cache.Ticker; | ||
import java.time.Duration; | ||
import java.util.concurrent.Executor; | ||
import java.util.concurrent.ExecutorService; | ||
import java.util.concurrent.TimeUnit; | ||
import java.util.function.Function; | ||
import org.apache.iceberg.relocated.com.google.common.annotations.VisibleForTesting; | ||
import org.apache.iceberg.relocated.com.google.common.util.concurrent.Uninterruptibles; | ||
import org.apache.iceberg.util.ThreadPools; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
/** A cache for {@link AuthSession} instances. */ | ||
public class AuthSessionCache implements AutoCloseable { | ||
|
||
private static final Logger LOG = LoggerFactory.getLogger(AuthSessionCache.class); | ||
|
||
private final Duration sessionTimeout; | ||
private final Executor executor; | ||
private final Ticker ticker; | ||
|
||
private volatile Cache<String, AuthSession> sessionCache; | ||
|
||
/** | ||
* Creates a new cache with the given session timeout, and with default executor and default | ||
* ticker for eviction tasks. | ||
* | ||
* @param name a distinctive name for the cache. | ||
* @param sessionTimeout the session timeout. Sessions will become eligible for eviction after | ||
* this duration of inactivity. | ||
*/ | ||
public AuthSessionCache(String name, Duration sessionTimeout) { | ||
this( | ||
sessionTimeout, | ||
ThreadPools.newExitingWorkerPool(name + "-auth-session-evict", 1), | ||
Ticker.systemTicker()); | ||
} | ||
|
||
/** | ||
* Creates a new cache with the given session timeout, executor, and ticker. This method is useful | ||
* for testing mostly. | ||
* | ||
* @param sessionTimeout the session timeout. Sessions will become eligible for eviction after | ||
* this duration of inactivity. | ||
* @param executor the executor to use for eviction tasks; if null, the cache will create a | ||
* default executor. The executor will be closed when this cache is closed. | ||
* @param ticker the ticker to use for the cache. | ||
*/ | ||
AuthSessionCache(Duration sessionTimeout, Executor executor, Ticker ticker) { | ||
this.sessionTimeout = sessionTimeout; | ||
this.executor = executor; | ||
this.ticker = ticker; | ||
} | ||
|
||
/** | ||
* Returns a cached session for the given key, loading it with the given loader if it is not | ||
* already cached. | ||
* | ||
* @param key the key to use for the session. | ||
* @param loader the loader to use to load the session if it is not already cached. | ||
* @param <T> the type of the session. | ||
* @return the cached session. | ||
*/ | ||
@SuppressWarnings("unchecked") | ||
public <T extends AuthSession> T cachedSession(String key, Function<String, T> loader) { | ||
return (T) sessionCache().get(key, loader); | ||
} | ||
|
||
@Override | ||
public void close() { | ||
try { | ||
Cache<String, AuthSession> cache = sessionCache; | ||
this.sessionCache = null; | ||
if (cache != null) { | ||
cache.invalidateAll(); | ||
cache.cleanUp(); | ||
} | ||
} finally { | ||
if (executor instanceof ExecutorService) { | ||
ExecutorService service = (ExecutorService) executor; | ||
service.shutdown(); | ||
if (!Uninterruptibles.awaitTerminationUninterruptibly(service, 10, TimeUnit.SECONDS)) { | ||
LOG.warn("Timed out waiting for eviction executor to terminate"); | ||
} | ||
service.shutdownNow(); | ||
} | ||
} | ||
} | ||
|
||
@VisibleForTesting | ||
Cache<String, AuthSession> sessionCache() { | ||
if (sessionCache == null) { | ||
synchronized (this) { | ||
if (sessionCache == null) { | ||
this.sessionCache = newSessionCache(); | ||
} | ||
} | ||
} | ||
|
||
return sessionCache; | ||
} | ||
|
||
private Cache<String, AuthSession> newSessionCache() { | ||
Caffeine<String, AuthSession> builder = | ||
Caffeine.newBuilder() | ||
.executor(executor) | ||
.expireAfterAccess(sessionTimeout) | ||
.ticker(ticker) | ||
.removalListener( | ||
(id, auth, cause) -> { | ||
if (auth != null) { | ||
auth.close(); | ||
} | ||
}); | ||
|
||
return builder.build(); | ||
} | ||
} |
Oops, something went wrong.