ch.ralscha.extdirectspring.annotation

Annotation Type ExtDirectMethod

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface ExtDirectMethod

Annotation for methods that should be exposed to a Ext Direct client

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	batched (Optional) false: always send requests immediately for this method true (default): allow requests to this method to be part of a batched request
ExtDirectMethodDocumentation	documentation (Optional) Documentation that are to be placed on the api method.
Class<?>	entryClass (Optional) Only feasible for STORE_MODIFY methods.
String	event (Optional) Only feasible for POLL methods.
String	group (Optional) The name of an api group this method is part of.
Class<?>	jsonView (Optional) Specifies a JSON View (filter) that Jackson uses to serialize the response.
boolean	streamResponse (Optional) Not feasible for FORM_POST methods.
boolean	synchronizeOnSession (Optional) Not feasible for FORM_POST methods.
ExtDirectMethodType	value Specifies the type of the remote method.

Element Detail

value

public abstract ExtDirectMethodType value

Specifies the type of the remote method. Defaults to SIMPLE method call.

Default:

ch.ralscha.extdirectspring.annotation.ExtDirectMethodType.SIMPLE

group

public abstract String group

(Optional) The name of an api group this method is part of.

Default:

""

batched

public abstract boolean batched

(Optional)
false: always send requests immediately for this method
true (default): allow requests to this method to be part of a batched request

Not feasible for POLL and FORM_POST methods.

Default:

true

event

public abstract String event

(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.

Default:

""

synchronizeOnSession

public abstract boolean synchronizeOnSession

(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.

Default:

false

streamResponse

public abstract boolean streamResponse

(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.

Default:

false

entryClass

public abstract Class<?> entryClass

(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.

Default:

java.lang.Object.class

documentation

public abstract ExtDirectMethodDocumentation documentation

(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.

Defaults to no documentation.

Default:

@ch.ralscha.extdirectspring.annotation.ExtDirectMethodDocumentation

jsonView

public abstract Class<?> jsonView

(Optional) Specifies a JSON View (filter) that Jackson uses to serialize the response. Not supported for FORM_POST methods.

Default:

ch.ralscha.extdirectspring.annotation.ExtDirectMethod.NoJsonView.class