/*
 * 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.skywalking.oap.server.receiver.envoy;

import com.google.protobuf.Struct;
import org.apache.skywalking.oap.server.receiver.envoy.als.ServiceMetaInfo;

/**
 * Factory to create {@link ServiceMetaInfo} instances from Kubernetes Pods, Envoy access log metadata, etc.
 */
public interface ServiceMetaInfoFactory {
    /**
     * @return the {@link Class} of the {@link ServiceMetaInfo} implementation.
     */
    Class<? extends ServiceMetaInfo> clazz();

    /**
     * @return an UNKNOWN instance of {@link ServiceMetaInfo}.
     */
    ServiceMetaInfo unknown();

    /**
     * Create an instance of {@link ServiceMetaInfo} from the given {@link Struct protobuf struct}.
     */
    ServiceMetaInfo fromStruct(final Struct struct) throws Exception;
}
