org.eclipse.microprofile.rest.client.inject.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of microprofile-rest-client-api Show documentation

Typesafe Rest Client APIs for MicroProfile :: API

The newest version!

/*
 *******************************************************************************
 * Copyright (c) 2018-2021 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * 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.
 *******************************************************************************/

/**
 * APIs to aid in CDI-based injection of MP Rest Client implementations. These annotations are used both to mark an
 * interface as registered Rest Client and also to designate that an implementation of that interface should be injected
 * at a specific injection point.
 *
 * Example:
 *
 *  * @RegisterProvider
 * @Dependent
 * public interface MyClientService {
 *     @GET
 *     @Path("/myService/{id}")
 *     Widget getWidget(@PathParam("id") String id);
 * }
 *
 * ...
 * @ApplicationScoped
 * public class MyBean {
 *     @Inject
 *     @RestClient
 *     MyClientService service;
 *     ...
 * }
 * 
 */
@org.osgi.annotation.versioning.Version("2.0")
@org.osgi.annotation.versioning.ProviderType
package org.eclipse.microprofile.rest.client.inject;