Package com.google.gwt.user.server.rpc

Class SerializationPolicyLoader

java.lang.Object

com.google.gwt.user.server.rpc.SerializationPolicyLoader

public final class SerializationPolicyLoader
extends Object

API for loading a SerializationPolicy.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_FIELDS_KEYWORD	Keyword for listing the serializable fields of an enhanced class that are visible to client code.
static final boolean	ENABLE_ENHANCED_CLASSES	Flag to enable using enhanced classes, for applications that need them and are taking appropriate steps to secure them.
static final String	ENABLE_GWT_ENHANCED_CLASSES_PROPERTY	System property to enable gwt-rpc enhanced classes.
static final String	FINAL_FIELDS_KEYWORD	Keyword for final field serialization strategy.
static final String	SERIALIZATION_POLICY_FILE_ENCODING	Default encoding for serialization policy files.

Method Summary

Modifier and Type	Method	Description
static String	getSerializationPolicyFileName(String serializationPolicyStrongName)	Returns the serialization policy file name from the serialization policy strong name.
static SerializationPolicy	loadFromStream(InputStream inputStream)	Deprecated. see loadFromStream(InputStream, List)
static SerializationPolicy	loadFromStream(InputStream inputStream, List<ClassNotFoundException> classNotFoundExceptions)	Loads a SerializationPolicy from an input stream and optionally record any ClassNotFoundExceptions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CLIENT_FIELDS_KEYWORD

public static final String CLIENT_FIELDS_KEYWORD

Keyword for listing the serializable fields of an enhanced class that are visible to client code.

See Also:

• Constant Field Values

FINAL_FIELDS_KEYWORD

public static final String FINAL_FIELDS_KEYWORD

Keyword for final field serialization strategy.

See Also:

• Constant Field Values

SERIALIZATION_POLICY_FILE_ENCODING

public static final String SERIALIZATION_POLICY_FILE_ENCODING

Default encoding for serialization policy files.

See Also:

• Constant Field Values

ENABLE_GWT_ENHANCED_CLASSES_PROPERTY

public static final String ENABLE_GWT_ENHANCED_CLASSES_PROPERTY

System property to enable gwt-rpc enhanced classes. To use this, set the JVM system property with name "gwt.enhancedClasses.enabled" to true, any other value will leave this feature disabled in the server at runtime.

See Also:

• Constant Field Values

ENABLE_ENHANCED_CLASSES

public static final boolean ENABLE_ENHANCED_CLASSES

Flag to enable using enhanced classes, for applications that need them and are taking appropriate steps to secure them. Defaults to false.

Method Details

getSerializationPolicyFileName

public static String getSerializationPolicyFileName(String serializationPolicyStrongName)

Returns the serialization policy file name from the serialization policy strong name.

Parameters:

serializationPolicyStrongName - the serialization policy strong name

Returns:

the serialization policy file name from the serialization policy strong name

loadFromStream

@Deprecated
public static SerializationPolicy loadFromStream(InputStream inputStream)
                                          throws IOException,
ParseException,
ClassNotFoundException

Deprecated.

see loadFromStream(InputStream, List)

Loads a SerializationPolicy from an input stream.

Parameters:

inputStream - stream to load from

Returns:

a SerializationPolicy loaded from the input stream

Throws:

IOException - if an error occurs while reading the stream

ParseException - if the input stream is not properly formatted

ClassNotFoundException - if a class specified in the serialization policy cannot be loaded

loadFromStream

public static SerializationPolicy loadFromStream(InputStream inputStream,
 List<ClassNotFoundException> classNotFoundExceptions)
                                          throws IOException,
ParseException

Loads a SerializationPolicy from an input stream and optionally record any ClassNotFoundExceptions.

Parameters:

inputStream - stream to load the SerializationPolicy from.

classNotFoundExceptions - if not null, all of the ClassNotFoundExceptions thrown while loading this serialization policy will be added to this list

Returns:

a SerializationPolicy loaded from the input stream.

Throws:

IOException - if an error occurs while reading the stream

ParseException - if the input stream is not properly formatted