xapi.annotation.model

Annotation Type Serializable

@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD,TYPE})
public @interface Serializable

Marking fields or methods as serializable will cause them to be serialized upon HTTP requests. This annotation allows control over whether a value may move from server to client, or vice versa. This is useful to prevent leaking sensitive data to clients, or to prevent sending useless data to server. By default, all non-android JRE environments are considered servers. See xapi.util.X_Properties#isServer for details on determining if a runtime is a server or not. Note that it is redundant to set both clientToServer() and serverToClient() to false; if you do not include this annotation, your field will not be serializable at all.

Author:

James X. Nelson (james@wetheinter.net)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	clientToServer
boolean	obfuscated
boolean	serverToClient

Element Detail

clientToServer

public abstract boolean clientToServer

Returns:

true to allow the data to be sent from client to server. false to prevent the value from leaving the client. Useful for dirty flags, or client-side rendering objects.

Default:

true

obfuscated

public abstract boolean obfuscated

Returns:

true to obfuscate values before serialization. The default obfuscator will use a one-time pad to hash your values.

Default:

false

serverToClient

public abstract boolean serverToClient

Returns:

true to allow the data to be sent from server to client. false to prevent the value from leaving the server. Useful for passwords and other sensitive data.

Default:

true