org.apache.juneau.remoteable.Remoteable Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * 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.juneau.remoteable;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;
import java.lang.annotation.*;
/**
* Identifies a remote proxy interface against a REST interface.
*
* Additional Information
*
* -
* Remoteable Proxies
*
-
* Interface proxies against 3rd-party REST interfaces
*
-
* org.apache.juneau.remoteable
*
*/
@Documented
@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Inherited
public @interface Remoteable {
/**
* The absolute or relative path of the REST service.
*
*
* When a relative path is specified, it's relative to the root-url defined on the RestClient used
* to instantiate the interface.
*
*
* When no path is specified, the path is assumed to be the class name (e.g.
* "http://localhost/root-url/org.foo.MyInterface" )
*/
String path() default "";
/**
* Identifies which methods on the interface should be exposed through the proxy.
*
*
* The options are:
*
* "DECLARED" (default) - Only methods declared on the immediate interface/class are exposed.
* Methods on parent interfaces/classes are ignored.
* "ANNOTATED" - Only methods annotated with {@link RemoteMethod} are exposed.
* "ALL" - All methods defined on the interface or class are exposed.
*
*/
String expose() default "DECLARED";
/**
* Defines the methodology to use for the path names of the methods when not explicitly defined via
* {@link RemoteMethod#path() @RemoteMethod.path()}.
*
*
* The options are:
*
* "NAME" (default) - Use the method name (e.g. "myMethod").
* "SIGNATURE" - Use the method signature (e.g. "myMethod(int,boolean,java.lang.String,int[][][])").
*
*
* Note that if you use "NAME" , method names must be unique in the interface.
*/
String methodPaths() default "NAME";
}