com.esri.arcgis.geodatabasedistributed
Class ReplicaMessageHandler

java.lang.Object
  extended by com.esri.arcgis.geodatabasedistributed.ReplicaMessageHandler
All Implemented Interfaces:
IReplicaMessageHandler, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ReplicaMessageHandler
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IReplicaMessageHandler

The ReplicaMessageHandler object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ReplicaMessageHandler()
          Constructs a ReplicaMessageHandler using ArcGIS Engine.
ReplicaMessageHandler(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ReplicaMessageHandler theReplicaMessageHandler = (ReplicaMessageHandler) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IDeltaDataChanges getDeltaDataChanges()
          Delta data changes.
 int getMessageType()
          Replica message type.
 int getMyGenerationNumber()
          Replica generation number.
 String getReplicaGuid()
          Replica guid.
 int getSibGenerationNumber()
          Replica sibling generation number.
 int hashCode()
          the hashcode for this object
 void init(String msgFileName, int msgExportOption)
          Init replica message handler.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ReplicaMessageHandler

public ReplicaMessageHandler()
                      throws IOException,
                             UnknownHostException
Constructs a ReplicaMessageHandler using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ReplicaMessageHandler

public ReplicaMessageHandler(Object obj)
                      throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ReplicaMessageHandler theReplicaMessageHandler = (ReplicaMessageHandler) obj;

Construct a ReplicaMessageHandler using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ReplicaMessageHandler.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

init

public void init(String msgFileName,
                 int msgExportOption)
          throws IOException,
                 AutomationException
Init replica message handler.

Remarks

This method initializes the ReplicMessageHandler coclass.

The init method takes an MsgFileName as a string and the MsgExportOption as the data changes option. The MsgFileName parameter is the replica data changes file. This may be a delta XML file, delta database, or a delta file geodatabase. The MsgExportOption parameter specifies the type of replica data changes file. See esriExportDataChangesOption for more information.

Product Availability

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

Specified by:
init in interface IReplicaMessageHandler
Parameters:
msgFileName - The msgFileName (in)
msgExportOption - A com.esri.arcgis.geodatabasedistributed.esriExportDataChangesOption constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaGuid

public String getReplicaGuid()
                      throws IOException,
                             AutomationException
Replica guid.

Remarks

This property returns the Replica Guid contained in the Message initialized with the ReplicaMessageHandler object.

Product Availability

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

Specified by:
getReplicaGuid in interface IReplicaMessageHandler
Returns:
The gUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessageType

public int getMessageType()
                   throws IOException,
                          AutomationException
Replica message type.

Remarks

This property returns the message type of the message file initialized with the ReplicaMessageHandler object. The message can be either a data change message, a data change message with a switch message, or an acknowledgement message. The message type is returned as a value representing the esriReplicaMessageType. See the esriReplicaMessageType enumeration for more information.

Product Availability

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

Specified by:
getMessageType in interface IReplicaMessageHandler
Returns:
A com.esri.arcgis.geodatabasedistributed.esriReplicaMessageType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMyGenerationNumber

public int getMyGenerationNumber()
                          throws IOException,
                                 AutomationException
Replica generation number.

Remarks

This property returns the generation number of the replica which generated the message file that was initialized with the ReplicaMessageHandler object.

Product Availability

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

Specified by:
getMyGenerationNumber in interface IReplicaMessageHandler
Returns:
The generationNumber
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSibGenerationNumber

public int getSibGenerationNumber()
                           throws IOException,
                                  AutomationException
Replica sibling generation number.

Remarks

This property returns the generation number of the relative replica which generated the message file that was initialized with the ReplicaMessageHandler object.

Product Availability

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

Specified by:
getSibGenerationNumber in interface IReplicaMessageHandler
Returns:
The sibGen
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDeltaDataChanges

public IDeltaDataChanges getDeltaDataChanges()
                                      throws IOException,
                                             AutomationException
Delta data changes.

Remarks

This property returns the DeltaDataChanges as IDeltaDataChanges in the message initialized with the ReplicaMessageHandler. See DeltaDataChanges for more information.

Product Availability

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

Specified by:
getDeltaDataChanges in interface IReplicaMessageHandler
Returns:
A reference to a com.esri.arcgis.geodatabasedistributed.IDeltaDataChanges
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.