001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.rest.client.remote;
014
015import static java.lang.annotation.ElementType.*;
016import static java.lang.annotation.RetentionPolicy.*;
017
018import java.lang.annotation.*;
019
020/**
021 * Identifies a proxy against a REST interface.
022 *
023 * <div class='warn'>
024 *    <b>Deprecated</b> - Use {@link org.apache.juneau.http.remote.RemoteMethod}
025 * </div>
026 *
027 * <ul class='seealso'>
028 *    <li class='link'>{@doc juneau-rest-client.RestProxies}
029 * </ul>
030 */
031@Documented
032@Target({TYPE})
033@Retention(RUNTIME)
034@Inherited
035@Deprecated
036public @interface RemoteResource {
037
038   /**
039    * REST service path.
040    *
041    * <p>
042    * The possible values are:
043    * <ul class='spaced-list'>
044    *    <li>An absolute URL.
045    *    <li>A relative URL interpreted as relative to the root URL defined on the <c>RestClient</c>
046    *    <li>No path interpreted as the class name (e.g. <js>"http://localhost/root-url/org.foo.MyInterface"</js>)
047    * </ul>
048    */
049   String path() default "";
050}