com.alipay.sofa.ark.spi.service.registry.RegistryService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sofa-ark-spi Show documentation
There is a newer version: 3.1.7
/*
 * 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 com.alipay.sofa.ark.spi.service.registry;

import com.alipay.sofa.ark.spi.registry.ServiceFilter;
import com.alipay.sofa.ark.spi.registry.ServiceProvider;
import com.alipay.sofa.ark.spi.registry.ServiceReference;

import java.util.List;

/**
 * Registry Service Interface
 *
 * @author ruoshan
 * @since 0.1.0
 */
public interface RegistryService {

    /**
     * Publish Service
     * @param ifClass service interface
     * @param implObject service implement object
     * @param serviceProvider service provider
     * @param 
     * @return
     */
     ServiceReference publishService(Class ifClass, T implObject,
                                           ServiceProvider serviceProvider);

    /**
     * Publish Service
     * @param ifClass service interface
     * @param implObject service implement object
     * @param uniqueId service implementation unique-id
     * @param serviceProvider service provider
     * @param 
     * @return
     */
     ServiceReference publishService(Class ifClass, T implObject, String uniqueId,
                                           ServiceProvider serviceProvider);

    /**
     * Get Service, when there are multiple services, return the highest priority service
     * {@link com.alipay.sofa.ark.spi.service.PriorityOrdered}
     *
     * @param ifClass service interface
     * @param 
     * @return service reference
     */
     ServiceReference referenceService(Class ifClass);

    /**
     * Get Service, when there are multiple services, return the highest priority service
     * {@link com.alipay.sofa.ark.spi.service.PriorityOrdered}
     *
     * @param ifClass service interface
     * @param uniqueId service implementation unique-id
     * @param 
     * @return service reference
     */
     ServiceReference referenceService(Class ifClass, String uniqueId);

    /**
     * Get Service List, ordered by priority.
     * {@link com.alipay.sofa.ark.spi.service.PriorityOrdered}
     *
     * @param ifClass service interface
     * @param 
     * @return service reference list
     */
     List> referenceServices(Class ifClass);

    /**
     * Get Service List, ordered by priority.
     * {@link com.alipay.sofa.ark.spi.service.PriorityOrdered}
     *
     * @param ifClass service interface
     * @param uniqueId service unique-id
     * @param 
     * @return service reference list
     */
     List> referenceServices(Class ifClass, String uniqueId);

    /**
     * Get Service List, ordered by priority.
     * {@link com.alipay.sofa.ark.spi.service.PriorityOrdered}
     *
     * @param serviceFilter service filter
     * @return service reference
     */
     List> referenceServices(ServiceFilter serviceFilter);

    /**
     * Drive out service which match the given serviceFilter.
     *
     * @param serviceFilter
     * @return return the count of deleted services
     */
    int unPublishServices(ServiceFilter serviceFilter);

}