org.apache.flink.runtime.state.ttl.AbstractTtlDecorator Maven / Gradle / Ivy
/*
* 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.flink.runtime.state.ttl;
import org.apache.flink.api.common.state.StateTtlConfig;
import org.apache.flink.util.Preconditions;
import org.apache.flink.util.function.SupplierWithException;
import org.apache.flink.util.function.ThrowingConsumer;
import org.apache.flink.util.function.ThrowingRunnable;
/**
* Base class for TTL logic wrappers.
*
* @param Type of originally wrapped object
*/
abstract class AbstractTtlDecorator {
/** Wrapped original state handler. */
final T original;
final StateTtlConfig config;
final TtlTimeProvider timeProvider;
/** Whether to renew expiration timestamp on state read access. */
final boolean updateTsOnRead;
/** Whether to renew expiration timestamp on state read access. */
final boolean returnExpired;
/** State value time to live in milliseconds. */
final long ttl;
AbstractTtlDecorator(T original, StateTtlConfig config, TtlTimeProvider timeProvider) {
Preconditions.checkNotNull(original);
Preconditions.checkNotNull(config);
Preconditions.checkNotNull(timeProvider);
this.original = original;
this.config = config;
this.timeProvider = timeProvider;
this.updateTsOnRead = config.getUpdateType() == StateTtlConfig.UpdateType.OnReadAndWrite;
this.returnExpired =
config.getStateVisibility()
== StateTtlConfig.StateVisibility.ReturnExpiredIfNotCleanedUp;
this.ttl = config.getTtl().toMilliseconds();
}
V getUnexpired(TtlValue ttlValue) {
return ttlValue == null || (!returnExpired && expired(ttlValue))
? null
: ttlValue.getUserValue();
}
boolean expired(TtlValue ttlValue) {
return TtlUtils.expired(ttlValue, ttl, timeProvider);
}
TtlValue wrapWithTs(V value) {
return TtlUtils.wrapWithTs(value, timeProvider.currentTimestamp());
}
TtlValue rewrapWithNewTs(TtlValue ttlValue) {
return wrapWithTs(ttlValue.getUserValue());
}
V getWithTtlCheckAndUpdate(
SupplierWithException, SE> getter,
ThrowingConsumer, CE> updater,
ThrowingRunnable stateClear)
throws SE, CE, CLE {
TtlValue ttlValue = getWrappedWithTtlCheckAndUpdate(getter, updater, stateClear);
return ttlValue == null ? null : ttlValue.getUserValue();
}
TtlValue getWrappedWithTtlCheckAndUpdate(
SupplierWithException, SE> getter,
ThrowingConsumer, CE> updater,
ThrowingRunnable stateClear)
throws SE, CE, CLE {
TtlValue ttlValue = getter.get();
if (ttlValue == null) {
return null;
} else if (expired(ttlValue)) {
stateClear.run();
if (!returnExpired) {
return null;
}
} else if (updateTsOnRead) {
updater.accept(rewrapWithNewTs(ttlValue));
}
return ttlValue;
}
}