com.agapsys.rcf.WebAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rcf-core Show documentation

REST Controller Framework for java back-end applications

There is a newer version: 0.1.0-20170604

/*
 * Copyright 2015 Agapsys Tecnologia Ltda-ME.
 *
 * 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.
 */
package com.agapsys.rcf;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Web action annotation.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface WebAction {

    /** @return Accepted HTTP methods */
    HttpMethod[] httpMethods()    default {HttpMethod.GET};

    /** @return name of the mapping. Passing {@linkplain Controller#METHOD_NAME_MAPPING} will force the use of method name as path mapping. */
    String       mapping()       default Controller.METHOD_NAME_MAPPING;

    /** @return a boolean indicating if action execution requires a logged user. An action is considered secured if ({@linkplain WebAction#secured()} == true || {@linkplain WebAction#requiredRoles()}.length > 0). */
    boolean      secured() default false;

    /** @return required roles for action execution.  An action is considered secured if ({@linkplain WebAction#secured()} == true || {@linkplain WebAction#requiredRoles()}.length > 0). */
    String[]     requiredRoles() default {};

}