-
Notifications
You must be signed in to change notification settings - Fork 216
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move logic for retrieval of policy enforcer into separate class which
allows to mock the logic for tests in a single place Signed-off-by: Yannic Klem <Yannic.Klem@bosch.io>
- Loading branch information
Showing
19 changed files
with
379 additions
and
342 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
112 changes: 112 additions & 0 deletions
112
...t/src/main/java/org/eclipse/ditto/policies/enforcement/DefaultPolicyEnforcerProvider.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,112 @@ | ||
| /* | ||
| * Copyright (c) 2022 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.policies.enforcement; | ||
|
|
||
| import java.util.Optional; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.CompletionStage; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| import org.eclipse.ditto.internal.utils.cache.entry.Entry; | ||
| import org.eclipse.ditto.internal.utils.cacheloaders.EnforcementCacheKey; | ||
| import org.eclipse.ditto.internal.utils.cacheloaders.config.AskWithRetryConfig; | ||
| import org.eclipse.ditto.internal.utils.cluster.ShardRegionProxyActorFactory; | ||
| import org.eclipse.ditto.internal.utils.cluster.config.ClusterConfig; | ||
| import org.eclipse.ditto.internal.utils.cluster.config.DefaultClusterConfig; | ||
| import org.eclipse.ditto.internal.utils.config.DefaultScopedConfig; | ||
| import org.eclipse.ditto.policies.api.PoliciesMessagingConstants; | ||
| import org.eclipse.ditto.policies.enforcement.config.DefaultEnforcementConfig; | ||
| import org.eclipse.ditto.policies.model.PolicyId; | ||
|
|
||
| import com.github.benmanes.caffeine.cache.AsyncCacheLoader; | ||
|
|
||
| import akka.actor.ActorRef; | ||
| import akka.actor.ActorSystem; | ||
| import akka.dispatch.MessageDispatcher; | ||
|
|
||
| /** | ||
| * Loads the {@link org.eclipse.ditto.policies.model.Policy} from the policies shard region and wraps it into a {@link PolicyEnforcer}. | ||
| */ | ||
| public final class DefaultPolicyEnforcerProvider implements PolicyEnforcerProvider { | ||
|
|
||
| private final AsyncCacheLoader<EnforcementCacheKey, Entry<PolicyEnforcer>> policyEnforcerCacheLoader; | ||
| private final MessageDispatcher enforcementCacheDispatcher; | ||
|
|
||
| DefaultPolicyEnforcerProvider(final ActorSystem actorSystem) { | ||
| this(askWithRetryConfig(actorSystem), actorSystem, policiesShardRegion(actorSystem)); | ||
| } | ||
|
|
||
| DefaultPolicyEnforcerProvider( | ||
| final AskWithRetryConfig askWithRetryConfig, | ||
| final ActorSystem actorSystem, | ||
| final ActorRef policiesShardRegion) { | ||
|
|
||
| this.policyEnforcerCacheLoader = new PolicyEnforcerCacheLoader(askWithRetryConfig, | ||
| actorSystem.getScheduler(), | ||
| policiesShardRegion | ||
| ); | ||
| enforcementCacheDispatcher = | ||
| actorSystem.dispatchers().lookup(PolicyEnforcerCacheLoader.ENFORCEMENT_CACHE_DISPATCHER); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new instance of this policy enforcer provider based on the configuration in the actor system | ||
| * | ||
| * @param actorSystem used to initialize all dependencies of the policy enforcer provider | ||
| * @return the new instance. | ||
| */ | ||
| public static PolicyEnforcerProvider getInstance(final ActorSystem actorSystem) { | ||
| return new DefaultPolicyEnforcerProvider(actorSystem); | ||
| } | ||
|
|
||
| private static AskWithRetryConfig askWithRetryConfig(final ActorSystem actorSystem) { | ||
| final DefaultScopedConfig dittoScoped = DefaultScopedConfig.dittoScoped(actorSystem.settings().config()); | ||
| return DefaultEnforcementConfig.of(dittoScoped).getAskWithRetryConfig(); | ||
| } | ||
|
|
||
| private static ActorRef policiesShardRegion(final ActorSystem actorSystem) { | ||
| final var dittoScopedConfig = DefaultScopedConfig.dittoScoped(actorSystem.settings().config()); | ||
| final ClusterConfig clusterConfig = DefaultClusterConfig.of(dittoScopedConfig); | ||
| final ShardRegionProxyActorFactory shardRegionProxyActorFactory = | ||
| ShardRegionProxyActorFactory.newInstance(actorSystem, clusterConfig); | ||
|
|
||
| return shardRegionProxyActorFactory.getShardRegionProxyActor( | ||
| PoliciesMessagingConstants.CLUSTER_ROLE, | ||
| PoliciesMessagingConstants.SHARD_REGION | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Loads the {@link org.eclipse.ditto.policies.model.Policy} from the policies shard region and wraps it into a {@link PolicyEnforcer}. | ||
| * | ||
| * @param policyId the ID of the policy that should be loaded. | ||
| * @return A completion stage completing with an Optional holding the PolicyEnforcer in case it could be retrieved or an empty optional if not. | ||
| */ | ||
| @Override | ||
| public CompletionStage<Optional<PolicyEnforcer>> getPolicyEnforcer(@Nullable final PolicyId policyId) { | ||
| if (null == policyId) { | ||
| return CompletableFuture.completedStage(Optional.empty()); | ||
| } else { | ||
| try { | ||
| return policyEnforcerCacheLoader.asyncLoad(EnforcementCacheKey.of(policyId), | ||
| enforcementCacheDispatcher) | ||
| .thenApply(Entry::get) | ||
| .exceptionally(error -> Optional.empty()); | ||
| } catch (final Exception e) { | ||
| throw new IllegalStateException("Could not load policyEnforcer via policyEnforcerCacheLoader", e); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
27 changes: 27 additions & 0 deletions
27
...orcement/src/main/java/org/eclipse/ditto/policies/enforcement/PolicyEnforcerProvider.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,27 @@ | ||
| /* | ||
| * Copyright (c) 2022 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.policies.enforcement; | ||
|
|
||
| import java.util.Optional; | ||
| import java.util.concurrent.CompletionStage; | ||
|
|
||
| import javax.annotation.Nullable; | ||
|
|
||
| import org.eclipse.ditto.policies.model.PolicyId; | ||
|
|
||
| @FunctionalInterface | ||
| public interface PolicyEnforcerProvider { | ||
|
|
||
| CompletionStage<Optional<PolicyEnforcer>> getPolicyEnforcer(@Nullable PolicyId policyId); | ||
|
|
||
| } |
Oops, something went wrong.