slider-core/src/main/java/org/apache/slider/server/services/registry/RegistryViewForProviders.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.slider.server.services.registry;

import org.apache.slider.core.registry.info.ServiceInstanceData;

import java.io.IOException;
import java.net.URL;
import java.util.List;

/**
 * This offers restricted access to the registry for providers
 */
public interface RegistryViewForProviders {
  List<ServiceInstanceData> listInstancesByType(String serviceType) throws
      IOException;

  /**
   * Get the registration of slider itself
   * @return the registration of slider
   */
  ServiceInstanceData getSelfRegistration();

  /**
   * Register the service, raising IOExceptions when anything fails
   * @param serviceType service type
   * @param instanceName ID -must be unique
   * @param url URL to register
   * @param instanceData instance data
   * @throws IOException on registration problems
   */
  void registerServiceInstance(
      String serviceType,
      String instanceName,
      URL url,
      ServiceInstanceData instanceData) throws IOException;
}