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.remoteable;
014
015import org.apache.juneau.remoteable.*;
016import org.apache.juneau.rest.*;
017import org.apache.juneau.rest.annotation.*;
018
019/**
020 * Configurable properties for the {@link RemoteableServlet} class.
021 * 
022 * <p>
023 * Properties can be set on the {@link RestServlet} class using the {@link RestResource#properties} or
024 * {@link RestMethod#properties} annotations.
025 * 
026 * <p>
027 * These properties can also be passed in as servlet init parameters.
028 * 
029 * <p>
030 * These properties are only valid at the class level, not the method level.
031 * <br>Setting them on {@link RestMethod#properties() @RestMethod.properties()} has no effect.
032 * 
033 * <h5 class='section'>See Also:</h5>
034 * <ul>
035 *    <li class='link'><a class="doclink" href="../../../../../overview-summary.html#juneau-rest-server.RemoteableProxies">Overview &gt; juneau-rest-server &gt; Remoteable Proxies</a>
036 * </ul>
037 */
038public final class RemoteableServiceProperties {
039
040   /**
041    * Only expose interfaces and methods annotated with {@link Remoteable @Remoteable} ({@link Boolean},
042    * default=<jk>false</jk>).
043    * 
044    * <p>
045    * When enabled, the {@link RemoteableServlet} class will only work with annotated remoteable interfaces and methods.
046    * Otherwise, all public methods can be executed through the service.
047    */
048   public static final String REMOTEABLE_includeOnlyRemotableMethods = "RemoteableService.includeOnlyRemoteableMethods";
049}