001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.web.bind;
017
018import org.springframework.web.bind.annotation.RequestMethod;
019
020import java.lang.annotation.Documented;
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Annotation for binding to indicate a property is accessible (allows updates).
028 *
029 * @author Kuali Rice Team (rice.collab@kuali.org)
030 */
031@Target(ElementType.FIELD)
032@Retention(RetentionPolicy.RUNTIME)
033@Documented
034public @interface RequestAccessible {
035
036    /**
037     * HTTP methods that annotation should apply to.
038     *
039     * <p>For example you might want to allow updates for GET only. For other
040     * request methods, the default view security level will be used (unless the RequestProtected
041     * annotation is also present)</p>
042     */
043    RequestMethod[] method() default {};
044
045    /**
046     * List of method names on the controller class that the binding should occur for.
047     *
048     * <p>For example you might want to restrict binding for only certain methodToCall(s). For other
049     * methodToCalls not in the list, no binding will occur.</p>
050     */
051    String[] methodToCalls() default {};
052}