org.osgi.service.rest.client.RestClientFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of osgi.cmpn Show documentation

OSGi Compendium Release 7, Interfaces and Classes for use in compiling bundles

There is a newer version: 7.0.0

/*
 * Copyright (c) OSGi Alliance (2013, 2015). All Rights Reserved.
 *
 * Licensed 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.osgi.service.rest.client;

import java.net.URI;
import org.osgi.annotation.versioning.ProviderType;

/**
 * Factory to construct new REST client instances. Each instance is specific to
 * a REST service endpoint.
 * 
 * 
 * Implementations can choose to extend this interface to add additional
 * creation methods, where additional arguments are needed for request signing,
 * etc.
 * 
 * 
 * In OSGi environments, this factory is registered as a service.
 * 
 * @author $Id: 1aa3ae8437aa1ed55bbbd0233edbd085f962c3c5 $
 */
@ProviderType
public interface RestClientFactory {

	/**
	 * Create a new REST client instance.
	 * 
	 * @param uri The URI to the REST service endpoint.
	 * @return A new REST client instance for the specified REST service
	 *         endpoint.
	 */
	RestClient createRestClient(URI uri);
}