org.apache.flink.streaming.api.operators.InternalTimerServiceSerializationProxy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-streaming-java_2.11 Show documentation
There is a newer version: 1.14.6
Show newest version
/*
 * 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.streaming.api.operators;

import org.apache.flink.annotation.Internal;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.core.io.PostVersionedIOReadableWritable;
import org.apache.flink.core.memory.DataInputView;
import org.apache.flink.core.memory.DataOutputView;

import java.io.IOException;
import java.util.Map;

import static org.apache.flink.util.Preconditions.checkNotNull;

/** Serialization proxy for the timer services for a given key-group. */
@Internal
public class InternalTimerServiceSerializationProxy extends PostVersionedIOReadableWritable {

    public static final int VERSION = 2;

    /** The key-group timer services to write / read. */
    private final InternalTimeServiceManagerImpl timerServicesManager;

    /** The user classloader; only relevant if the proxy is used to restore timer services. */
    private ClassLoader userCodeClassLoader;

    /** Properties of restored timer services. */
    private final int keyGroupIdx;

    /** Constructor to use when restoring timer services. */
    public InternalTimerServiceSerializationProxy(
            InternalTimeServiceManagerImpl timerServicesManager,
            ClassLoader userCodeClassLoader,
            int keyGroupIdx) {
        this.timerServicesManager = checkNotNull(timerServicesManager);
        this.userCodeClassLoader = checkNotNull(userCodeClassLoader);
        this.keyGroupIdx = keyGroupIdx;
    }

    /** Constructor to use when writing timer services. */
    public InternalTimerServiceSerializationProxy(
            InternalTimeServiceManagerImpl timerServicesManager, int keyGroupIdx) {
        this.timerServicesManager = checkNotNull(timerServicesManager);
        this.keyGroupIdx = keyGroupIdx;
    }

    @Override
    public int getVersion() {
        return VERSION;
    }

    @Override
    public int[] getCompatibleVersions() {
        return new int[] {VERSION, 1};
    }

    @Override
    @SuppressWarnings("unchecked")
    public void write(DataOutputView out) throws IOException {
        super.write(out);
        final Map> registeredTimerServices =
                timerServicesManager.getRegisteredTimerServices();

        out.writeInt(registeredTimerServices.size());
        for (Map.Entry> entry :
                registeredTimerServices.entrySet()) {
            String serviceName = entry.getKey();
            InternalTimerServiceImpl timerService = entry.getValue();

            out.writeUTF(serviceName);
            InternalTimersSnapshotReaderWriters.getWriterForVersion(
                            VERSION,
                            timerService.snapshotTimersForKeyGroup(keyGroupIdx),
                            timerService.getKeySerializer(),
                            (TypeSerializer) timerService.getNamespaceSerializer())
                    .writeTimersSnapshot(out);
        }
    }

    @Override
    protected void read(DataInputView in, boolean wasVersioned) throws IOException {
        int noOfTimerServices = in.readInt();

        for (int i = 0; i < noOfTimerServices; i++) {
            String serviceName = in.readUTF();

            int readerVersion =
                    wasVersioned
                            ? getReadVersion()
                            : InternalTimersSnapshotReaderWriters.NO_VERSION;
            InternalTimersSnapshot restoredTimersSnapshot =
                    InternalTimersSnapshotReaderWriters.getReaderForVersion(
                                    readerVersion, userCodeClassLoader)
                            .readTimersSnapshot(in);

            InternalTimerServiceImpl timerService =
                    registerOrGetTimerService(serviceName, restoredTimersSnapshot);

            timerService.restoreTimersForKeyGroup(restoredTimersSnapshot, keyGroupIdx);
        }
    }

    @SuppressWarnings("unchecked")
    private  InternalTimerServiceImpl registerOrGetTimerService(
            String serviceName, InternalTimersSnapshot restoredTimersSnapshot) {
        final TypeSerializer keySerializer =
                (TypeSerializer)
                        restoredTimersSnapshot.getKeySerializerSnapshot().restoreSerializer();
        final TypeSerializer namespaceSerializer =
                (TypeSerializer)
                        restoredTimersSnapshot.getNamespaceSerializerSnapshot().restoreSerializer();
        TimerSerializer timerSerializer =
                new TimerSerializer<>(keySerializer, namespaceSerializer);
        return timerServicesManager.registerOrGetTimerService(serviceName, timerSerializer);
    }
}