jodd.madvoc.meta.RestAction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jodd-all Show documentation
Show all versions of jodd-all Show documentation
Jodd bundle - all classes in one jar
// Copyright (c) 2003-present, Jodd Team (http://jodd.org)
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
package jodd.madvoc.meta;
import jodd.madvoc.path.ActionNamingStrategy;
import jodd.madvoc.path.RestResourcePath;
import jodd.madvoc.result.ActionResult;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Extension of {@link jodd.madvoc.meta.Action} for REST resources
* that uses {@link jodd.madvoc.path.RestResourcePath different naming}
* convention.
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
public @interface RestAction {
/**
* Action path value. If equals to {@link Action#NONE} action method name
* will not be part of the created action path.
*/
String value() default "";
//String extension() default "";
/**
* Defines alias.
*/
String alias() default "";
/**
* Defines action method (such as HTTP request method: GET, POST....).
* Ignore it or use {@link Action#ANY} to ignore the method.
*/
String method() default "";
/**
* Defines if action has to be called asynchronously
* using Servlets 3.0 API.
*/
boolean async() default false;
/**
* Defines {@link jodd.madvoc.result.ActionResult action result handler}
* that is going to render the result object.
*/
Class result() default ActionResult.class;
/**
* Defines the way how mapping is done: using {@link jodd.madvoc.path.RestResourcePath}.
*/
Class path() default RestResourcePath.class;
}