flex.messaging.io
Class StatusInfoProxy

java.lang.Object
  flex.messaging.io.AbstractProxy
      flex.messaging.io.StatusInfoProxy

All Implemented Interfaces:

PropertyProxy, Serializable, Cloneable

public class StatusInfoProxy
extends AbstractProxy

Serializes a Throwable as a Status Info object, which is sent back to the client as an ActionScript object with the following keys:

• code: We report this as Server.Processing. To be expanded in a future version.
• description: The error message.
• details: The error stack trace.
• type: The error class name.
• rootcause: If the exception was a ServletException, the rootcause will be included as a nested Status Info object.

See Also:

Serialized Form

Field Summary

static String	CLASS The class name of the Throwable instance, if allowed to be revealed to the client...
static String	CODE Hierarchical dot "." string description of the problem.
static String	DESCRIPTION Brief description of the error.
static String	DETAILS Long description of the error.
static List	propertyNameCache
static String	ROOTCAUSE

Constructor Summary

StatusInfoProxy()

StatusInfoProxy(Throwable defaultInstance)

Method Summary

Object	clone() Returns a copy of the PropertyProxy so that it can be used as a template without modifying/creating global references to instances, descriptors etc.
String	getAlias(Object instance) The class name alias for the given instance.
List	getPropertyNames(Object instance) The List of property names as Strings that make up the traits of the given instance.
Class	getType(Object instance, String propertyName) Looks up the Class type of the property by name on the given instance.
Object	getValue(Object instance, String propertyName) Looks up the value of a property by name for the given instance.
void	setShowStacktraces(boolean value)
void	setValue(Object instance, String propertyName, Object value) Updates the value of a property by name for the given instance.

Methods inherited from class flex.messaging.io.AbstractProxy

createInstance, createInstanceFromClassName, getAlias, getClassFromClassName, getClassFromClassName, getDefaultInstance, getDescriptor, getIncludeReadOnly, getInstanceToSerialize, getPropertyNames, getSerializationContext, getType, getValue, instanceComplete, isDynamic, isExternalizable, isExternalizable, setAlias, setDefaultInstance, setDescriptor, setDynamic, setExternalizable, setIncludeReadOnly, setSerializationContext, setValue, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DESCRIPTION

public static final String DESCRIPTION

Brief description of the error. This is intended to describe the problem in a short manner that may be displayed to a human during run-time of the client's application.

See Also:

Constant Field Values

DETAILS

public static final String DETAILS

Long description of the error. This may contain a verbose description that may be provided to a more intelligent human for diagnosis.

See Also:

Constant Field Values

CLASS

public static final String CLASS

The class name of the Throwable instance, if allowed to be revealed to the client...

See Also:

Constant Field Values

CODE

public static final String CODE

Hierarchical dot "." string description of the problem.

The top error string shall be on of the following....

Client - Indicates the error was caused by something the client did. Possibly the message was not well formed and/or did not contain the proper information.

Server - Indicates the error was caused by something not directly related to the contents of the message. Possibly the server could not gain a needed resource or communicate with the desire WebService.

VersionMismatch - The received AMF packet was of a version that the Server does not recognize.

The server can generate any number of sub errors to be attached to one of the 3 above roots. The idea is that these strings provide an intuitive description of where the problem happened and what it was. Ultimately, finding and fixing the errors fast is the goal.

See Also:

Constant Field Values

ROOTCAUSE

public static final String ROOTCAUSE

See Also:

Constant Field Values

propertyNameCache

public static final List propertyNameCache

Constructor Detail

StatusInfoProxy

public StatusInfoProxy()

StatusInfoProxy

public StatusInfoProxy(Throwable defaultInstance)

Method Detail

setShowStacktraces

public void setShowStacktraces(boolean value)

getAlias

public String getAlias(Object instance)

Description copied from interface: PropertyProxy

The class name alias for the given instance.

Parameters:

instance - the object to get the alias of.

Returns:

The class name alias to be used in serializing the type traits.

getPropertyNames

public List getPropertyNames(Object instance)

Description copied from interface: PropertyProxy

The List of property names as Strings that make up the traits of the given instance. These traits determine which properties are to be serialized.

Parameters:

instance - the object to examine

Returns:

List of property names as Strings to be serialized.

getType

public Class getType(Object instance,
                     String propertyName)

Description copied from interface: PropertyProxy

Looks up the Class type of the property by name on the given instance.

Parameters:

instance - The instance that possesses the property.

propertyName - The name of the property.

Returns:

The property type.

getValue

public Object getValue(Object instance,
                       String propertyName)

Description copied from interface: PropertyProxy

Looks up the value of a property by name for the given instance.

Parameters:

instance - The instance that possesses the requested property.

propertyName - The name of the property.

Returns:

The value of the given property.

setValue

public void setValue(Object instance,
                     String propertyName,
                     Object value)

Description copied from interface: PropertyProxy

Updates the value of a property by name for the given instance.

Parameters:

instance - The instance that possesses the requested property.

propertyName - The name of the property to update.

value - The updated value for the property.

clone

public Object clone()

Description copied from class: AbstractProxy

Returns a copy of the PropertyProxy so that it can be used as a template without modifying/creating global references to instances, descriptors etc.

Specified by:

clone in interface PropertyProxy

Overrides:

clone in class AbstractProxy

Returns:

A copy of the PropertyProxy.