modules/core/src/main/java/org/apache/ignite/client/ClientServices.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.ignite.client;

import java.util.Collection;
import org.apache.ignite.lang.IgniteExperimental;
import org.apache.ignite.services.ServiceCallContext;

/**
 * Thin client services facade.
 */
public interface ClientServices {
    /**
     * Gets the cluster group to which this {@code ClientServices} instance belongs.
     *
     * @return Cluster group to which this {@code ClientServices} instance belongs.
     */
    public ClientClusterGroup clusterGroup();

    /**
     * Gets a remote handle on the service.
     * <p>
     * Note: There are no guarantees that each method invocation for the same proxy will always contact the same remote
     * service (on the same remote node).
     *
     * @param name Service name.
     * @param svcItf Interface for the service.
     * @param <T> Service type.
     * @return Proxy over remote service.
     */
    public <T> T serviceProxy(String name, Class<? super T> svcItf);

    /**
     * Gets a remote handle on the service with timeout.
     * <p>
     * Note: There are no guarantees that each method invocation for the same proxy will always contact the same remote
     * service (on the same remote node).
     *
     * @param name Service name.
     * @param svcItf Interface for the service.
     * @param timeout If greater than 0 created proxy will wait for service availability only specified time,
     *  and will limit remote service invocation time.
     * @param <T> Service type.
     * @return Proxy over remote service.
     */
    public <T> T serviceProxy(String name, Class<? super T> svcItf, long timeout);

    /**
     * Gets metadata about all deployed services in the grid.
     *
     * @return Metadata about all deployed services in the grid.
     */
    public Collection<ClientServiceDescriptor> serviceDescriptors();

    /**
     * Gets metadata about deployed services in the grid.
     *
     * @param name Service name.
     * @return Metadata about all deployed services in the grid.
     */
    public ClientServiceDescriptor serviceDescriptor(String name);

    /**
     * Gets a remote handle on the service with the specified caller context.
     * <p>
     * Note: There are no guarantees that each method invocation for the same proxy will always contact the same remote
     * service (on the same remote node).
     *
     * @param name Service name.
     * @param svcItf Interface for the service.
     * @param callCtx Service call context.
     * @param <T> Service type.
     * @return Proxy over remote service.
     * @see ServiceCallContext
     */
    @IgniteExperimental
    public <T> T serviceProxy(String name, Class<? super T> svcItf, ServiceCallContext callCtx);

    /**
     * Gets a remote handle on the service with the specified caller context and timeout.
     * <p>
     * Note: There are no guarantees that each method invocation for the same proxy will always contact the same remote
     * service (on the same remote node).
     *
     * @param name Service name.
     * @param svcItf Interface for the service.
     * @param callCtx Service call context.
     * @param timeout If greater than 0 created proxy will wait for service availability only specified time,
     *  and will limit remote service invocation time.
     * @param <T> Service type.
     * @return Proxy over remote service.
     * @see ServiceCallContext
     */
    @IgniteExperimental
    public <T> T serviceProxy(String name, Class<? super T> svcItf, ServiceCallContext callCtx, long timeout);
}