com.esri.arcgis.system
Interface IAMFSerializer

All Superinterfaces:

IExternalSerializer, Serializable

public interface IAMFSerializer
extends IExternalSerializer, Serializable

Provides access to high-level AMF serialization methods.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

IAMFWriter	getWriter() Obtains AMF Writer.
void	initSerializer(IAMFWriter pWriter, IPropertySet pProps) Write serialization options.
void	writeAMF0Header(String name, boolean mustUnderstand, Object value) AMF message packet #2a call.
void	writeAMF0HeaderCount(short headerCount) AMF message packet #2 call.
void	writeAMF0MessageCount(short messageCount) AMF message packet #3 call.
void	writeAMF0MessageHeader(String targetURI, String respURI, int length) AMF message packet #3a call.
void	writeAMF0MessageVersion(short sVersion) AMF message packet #1 call.

Methods inherited from interface com.esri.arcgis.system.IExternalSerializer

writeObject

Method Detail

getWriter

IAMFWriter getWriter()
                     throws IOException,
                            AutomationException

Obtains AMF Writer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to a com.esri.arcgis.system.IAMFWriter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initSerializer

void initSerializer(IAMFWriter pWriter,
                    IPropertySet pProps)
                    throws IOException,
                           AutomationException

Write serialization options.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pWriter - A reference to a com.esri.arcgis.system.IAMFWriter (in)

pProps - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeAMF0MessageVersion

void writeAMF0MessageVersion(short sVersion)
                             throws IOException,
                                    AutomationException

AMF message packet #1 call. Write AMF0 message version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

sVersion - The sVersion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeAMF0HeaderCount

void writeAMF0HeaderCount(short headerCount)
                          throws IOException,
                                 AutomationException

AMF message packet #2 call. Write header count. Use zero to skip headers.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

headerCount - The headerCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeAMF0Header

void writeAMF0Header(String name,
                     boolean mustUnderstand,
                     Object value)
                     throws IOException,
                            AutomationException

AMF message packet #2a call. Write header(s).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

name - The name (in)

mustUnderstand - The mustUnderstand (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeAMF0MessageCount

void writeAMF0MessageCount(short messageCount)
                           throws IOException,
                                  AutomationException

AMF message packet #3 call. Write message count.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

messageCount - The messageCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeAMF0MessageHeader

void writeAMF0MessageHeader(String targetURI,
                            String respURI,
                            int length)
                            throws IOException,
                                   AutomationException

AMF message packet #3a call. Write message(s). Set isAMF3content to true if you are sending AMF3 data in the message.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

targetURI - The targetURI (in)

respURI - The respURI (in)

length - The length (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.