ExtDirectMethod.java

/**
 * Copyright 2010-2016 Ralph Schaer <ralphschaer@gmail.com>
 *
 * 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 ch.ralscha.extdirectspring.annotation;

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

import ch.ralscha.extdirectspring.bean.ModelAndJsonView;

/**
 * Annotation for methods that should be exposed to a Ext Direct client
 */
@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface ExtDirectMethod {

	/**
	 * Specifies the type of the remote method. Defaults to SIMPLE method call.
	 */
	ExtDirectMethodType value() default ExtDirectMethodType.SIMPLE;

	/**
	 * (Optional) The name of an api group this method is part of.
	 */
	String group() default "";

	/**
	 * (Optional) <br>
	 * false: always send requests immediately for this method<br>
	 * true (default): allow requests to this method to be part of a batched request
	 * <p>
	 * Not feasible for POLL and FORM_POST methods.
	 */
	boolean batched() default true;

	/**
	 * (Optional) Only feasible for POLL methods. The name of the event this method is
	 * sending messages to. If this parameter is empty the name of the method will be used
	 * as event name.
	 */
	String event() default "";

	/**
	 * (Optional) Not feasible for FORM_POST methods. If true execution of the method is
	 * synchronized on the session. To serialize parallel invocations from the same
	 * client.
	 */
	boolean synchronizeOnSession() default false;

	/**
	 * (Optional) Not feasible for FORM_POST methods. If true JSON responses will be
	 * streamed into the response, without setting the Content-Length HTTP header. Default
	 * behavior (false) is writing the response into a buffer, setting the Content-Length
	 * header and writing the buffer into the response.
	 */
	boolean streamResponse() default false;

	/**
	 * (Optional) Only feasible for STORE_MODIFY methods. Specifies the type of an object
	 * in a collection. If the generic type of a collection is an interface the library
	 * cannot figure out the type of the implementation class. For this scenario specify
	 * the class with this parameter.
	 */
	Class<?> entryClass() default Object.class;

	/**
	 * (Optional) Documentation that are to be placed on the api method. These are only
	 * used for api-debug-doc.js generation to self documents the client server interface.
	 * <p/>
	 * Defaults to no documentation.
	 */
	ExtDirectMethodDocumentation documentation() default @ExtDirectMethodDocumentation;

	/**
	 * (Optional) Specifies a JSON View (filter) that Jackson uses to serialize the
	 * response. Not supported for FORM_POST methods.
	 */
	Class<?> jsonView() default NoJsonView.class;

	/**
	 * Marker class to override a JsonView at runtime that is specified on the
	 * {@link ExtDirectMethod#jsonView()} property.
	 *
	 * @see ModelAndJsonView
	 */
	public static class NoJsonView {
		// nothing here
	}

}