storm-client/src/jvm/org/apache/storm/serialization/SerializationRegister.java

/*
 * 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.storm.serialization;

import com.esotericsoftware.kryo.Kryo;

/**
 * Provides a way using a service loader to register Kryo serializers with the SerializationFactory without needing to modify the config.
 * This allows for language bindings libraries or platforms to include their own registration without impacting a clients config.
 */
public interface SerializationRegister {
    /**
     * Register any serializers needed with the kryo instance.
     *
     * @param kryo what to register the serializers with.
     */
    public void register(Kryo kryo) throws Exception;
}