com.google.gwt.user.server.rpc.core.java.util

Class EnumMap_ServerCustomFieldSerializer

java.lang.Object

com.google.gwt.user.client.rpc.CustomFieldSerializer<T>

com.google.gwt.user.server.rpc.ServerCustomFieldSerializer<EnumMap>

com.google.gwt.user.server.rpc.core.java.util.EnumMap_ServerCustomFieldSerializer

public final class EnumMap_ServerCustomFieldSerializer
extends ServerCustomFieldSerializer<EnumMap>

Custom field serializer for EnumMap for the server.

Constructor Summary

Constructors

Constructor and Description
EnumMap_ServerCustomFieldSerializer()

Method Summary

Methods

Modifier and Type	Method and Description
static void	deserialize(ServerSerializationStreamReader streamReader, EnumMap instance, Type[] expectedParameterTypes, DequeMap<TypeVariable<?>,Type> resolvedTypes)
void	deserializeInstance(SerializationStreamReader streamReader, EnumMap instance) Deserializes the content of the object from the SerializationStreamReader.
void	deserializeInstance(ServerSerializationStreamReader streamReader, EnumMap instance, Type[] expectedParameterTypes, DequeMap<TypeVariable<?>,Type> resolvedTypes) Deserializes the content of the object from the ServerSerializationStreamReader, with type checking.
boolean	hasCustomInstantiateInstance()
EnumMap	instantiateInstance(SerializationStreamReader streamReader) Instantiates an object from the SerializationStreamReader.
EnumMap	instantiateInstance(ServerSerializationStreamReader streamReader, Type[] expectedParameterTypes, DequeMap<TypeVariable<?>,Type> resolvedTypes) Instantiates an object from the ServerSerializationStreamReader, with type checking.
void	serializeInstance(SerializationStreamWriter streamWriter, EnumMap instance) Serializes the content of the object into the SerializationStreamWriter.

Methods inherited from class com.google.gwt.user.server.rpc.ServerCustomFieldSerializer

instantiateInstance

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

EnumMap_ServerCustomFieldSerializer

public EnumMap_ServerCustomFieldSerializer()

Method Detail

deserialize

public static void deserialize(ServerSerializationStreamReader streamReader,
               EnumMap instance,
               Type[] expectedParameterTypes,
               DequeMap<TypeVariable<?>,Type> resolvedTypes)
                        throws SerializationException

Throws:

SerializationException

deserializeInstance

public void deserializeInstance(SerializationStreamReader streamReader,
                       EnumMap instance)
                         throws SerializationException

Description copied from class: CustomFieldSerializer

Deserializes the content of the object from the SerializationStreamReader.

Specified by:

deserializeInstance in class CustomFieldSerializer<EnumMap>

Parameters:

streamReader - the SerializationStreamReader to read the object's content from

instance - the object instance to deserialize

Throws:

SerializationException - if the deserialization operation is not successful

deserializeInstance

public void deserializeInstance(ServerSerializationStreamReader streamReader,
                       EnumMap instance,
                       Type[] expectedParameterTypes,
                       DequeMap<TypeVariable<?>,Type> resolvedTypes)
                         throws SerializationException

Description copied from class: ServerCustomFieldSerializer

Deserializes the content of the object from the ServerSerializationStreamReader, with type checking. The calling code has verified that the instance this method is deserializing is of the correct type for the RPC call. However, is has not verified the objects that this deserializer will read. It is this method's responsibility to verify the types of objects that it reads. Failure to do so leaves the server vulnerable to an attacker who replaces deserialized data in the RPC message with data that takes an exponential time to deserialize or otherwise causes problems. In practice, any call to ServerSerilizationStreamReader.readObject() should use the type checking version, passing in the expected type of the object to be read. For classes that deserialize objects of generic types, the expectedParameterTypes array provides the type bound to each type generic parameter defined by the instance. See the built-in GWT server custom field serializers for examples.

Specified by:

deserializeInstance in class ServerCustomFieldSerializer<EnumMap>

Parameters:

streamReader - the ServerSerializationStreamReader to read the object's content from

instance - the object instance to deserialize

expectedParameterTypes - the types we expect for any generic parameters used by this class, in the order in which they appear in the instance.getTypeParameters()

resolvedTypes - map from generic types to actual types

Throws:

SerializationException - if the deserialization operation is not successful

hasCustomInstantiateInstance

public boolean hasCustomInstantiateInstance()

Overrides:

hasCustomInstantiateInstance in class CustomFieldSerializer<EnumMap>

Returns:

true if a specialist CustomFieldSerializer.instantiateInstance(com.google.gwt.user.client.rpc.SerializationStreamReader) is implemented; false otherwise

instantiateInstance

public EnumMap instantiateInstance(SerializationStreamReader streamReader)
                            throws SerializationException

Description copied from class: CustomFieldSerializer

Instantiates an object from the SerializationStreamReader.

Most of the time, this can be left unimplemented and the framework will instantiate the instance itself. This is typically used when the object being deserialized is immutable, hence it has to be created with its state already set.

If this is overridden, the CustomFieldSerializer.hasCustomInstantiateInstance() method must return true in order for the framework to know to call it.

Overrides:

instantiateInstance in class CustomFieldSerializer<EnumMap>

Parameters:

streamReader - the SerializationStreamReader to read the object's content from

Returns:

an object that has been loaded from the SerializationStreamReader

Throws:

SerializationException - if the instantiation operation is not successful

instantiateInstance

public EnumMap instantiateInstance(ServerSerializationStreamReader streamReader,
                          Type[] expectedParameterTypes,
                          DequeMap<TypeVariable<?>,Type> resolvedTypes)
                            throws SerializationException

Description copied from class: ServerCustomFieldSerializer

Instantiates an object from the ServerSerializationStreamReader, with type checking.

Most of the time, this can be left unimplemented and the framework will instantiate the instance itself. This is typically used when the object being deserialized is immutable, hence it has to be created with its state already set.

If this is overridden, the CustomFieldSerializer.hasCustomInstantiateInstance() method must return true in order for the framework to know to call it. The calling code has verified that the instance this method is instantiating is of the correct type for the RPC call. However, is has not verified the objects that this instantiator will read. It is this method's responsibility to verify the types of objects that it reads. Failure to do so leaves the server vulnerable to an attacker who replaces deserialized data in the RPC message with data that takes an exponential time to instantiate or otherwise causes problems. In practice, any call to ServerSerilizationStreamReader.readObject() should use the type checking version, passing in the expected type of the object to be read. For classes that instantiate objects of generic types, the expectedParameterTypes array provides the type bound to each type generic parameter defined by the instance. See the built-in GWT server custom field serializers for examples.

Overrides:

instantiateInstance in class ServerCustomFieldSerializer<EnumMap>

Parameters:

streamReader - the ServerSerializationStreamReader to read the object's content from

expectedParameterTypes - the types we expect for any generic parameters used by this class, in the order returned by instance.getTypeParameters()

resolvedTypes - map from generic types to actual types

Returns:

an object that has been loaded from the ServerSerializationStreamReader

Throws:

SerializationException - if the instantiation operation is not successful

serializeInstance

public void serializeInstance(SerializationStreamWriter streamWriter,
                     EnumMap instance)
                       throws SerializationException

Description copied from class: CustomFieldSerializer

Serializes the content of the object into the SerializationStreamWriter.

Specified by:

serializeInstance in class CustomFieldSerializer<EnumMap>

Parameters:

streamWriter - the SerializationStreamWriter to write the object's content to

instance - the object instance to serialize

Throws:

SerializationException - if the serialization operation is not successful