org.apache.flink.runtime.state.ttl.TtlStateSnapshotTransformer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime Show documentation
There is a newer version: 1.19.0
/*
 * 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.typeutils.base.LongSerializer;
import org.apache.flink.core.memory.DataInputDeserializer;
import org.apache.flink.runtime.state.StateSnapshotTransformer;
import org.apache.flink.runtime.state.StateSnapshotTransformer.CollectionStateSnapshotTransformer;
import org.apache.flink.util.FlinkRuntimeException;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import java.io.IOException;
import java.util.Optional;

/** State snapshot filter of expired values with TTL. */
abstract class TtlStateSnapshotTransformer implements CollectionStateSnapshotTransformer {
    private final TtlTimeProvider ttlTimeProvider;
    final long ttl;
    private final DataInputDeserializer div;

    TtlStateSnapshotTransformer(@Nonnull TtlTimeProvider ttlTimeProvider, long ttl) {
        this.ttlTimeProvider = ttlTimeProvider;
        this.ttl = ttl;
        this.div = new DataInputDeserializer();
    }

     TtlValue filterTtlValue(TtlValue value) {
        return expired(value) ? null : value;
    }

    private boolean expired(TtlValue ttlValue) {
        return expired(ttlValue.getLastAccessTimestamp());
    }

    boolean expired(long ts) {
        return TtlUtils.expired(ts, ttl, ttlTimeProvider);
    }

    long deserializeTs(byte[] value) throws IOException {
        div.setBuffer(value, 0, Long.BYTES);
        return LongSerializer.INSTANCE.deserialize(div);
    }

    @Override
    public TransformStrategy getFilterStrategy() {
        return TransformStrategy.STOP_ON_FIRST_INCLUDED;
    }

    static class TtlDeserializedValueStateSnapshotTransformer
            extends TtlStateSnapshotTransformer> {
        TtlDeserializedValueStateSnapshotTransformer(TtlTimeProvider ttlTimeProvider, long ttl) {
            super(ttlTimeProvider, ttl);
        }

        @Override
        @Nullable
        public TtlValue filterOrTransform(@Nullable TtlValue value) {
            return filterTtlValue(value);
        }
    }

    static class TtlSerializedValueStateSnapshotTransformer
            extends TtlStateSnapshotTransformer {
        TtlSerializedValueStateSnapshotTransformer(TtlTimeProvider ttlTimeProvider, long ttl) {
            super(ttlTimeProvider, ttl);
        }

        @Override
        @Nullable
        public byte[] filterOrTransform(@Nullable byte[] value) {
            if (value == null) {
                return null;
            }
            long ts;
            try {
                ts = deserializeTs(value);
            } catch (IOException e) {
                throw new FlinkRuntimeException("Unexpected timestamp deserialization failure", e);
            }
            return expired(ts) ? null : value;
        }
    }

    static class Factory implements StateSnapshotTransformFactory> {
        private final TtlTimeProvider ttlTimeProvider;
        private final long ttl;

        Factory(@Nonnull TtlTimeProvider ttlTimeProvider, long ttl) {
            this.ttlTimeProvider = ttlTimeProvider;
            this.ttl = ttl;
        }

        @Override
        public Optional>> createForDeserializedState() {
            return Optional.of(
                    new TtlDeserializedValueStateSnapshotTransformer<>(ttlTimeProvider, ttl));
        }

        @Override
        public Optional> createForSerializedState() {
            return Optional.of(
                    new TtlSerializedValueStateSnapshotTransformer(ttlTimeProvider, ttl));
        }
    }
}