com.novell.ldap.extensions
Class GetReplicaInfoResponse

java.lang.Object
  com.novell.ldap.LDAPMessage
      com.novell.ldap.LDAPResponse
          com.novell.ldap.LDAPExtendedResponse
              com.novell.ldap.extensions.GetReplicaInfoResponse

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class GetReplicaInfoResponse

extends LDAPExtendedResponse

Retrieves the replica information from a GetReplicaInfoResponse object.

An object in this class is generated from an ExtendedResponse using the ExtendedResponseFactory class.

The getReplicaInfoResponse extension uses the following OID:
2.16.840.1.113719.1.27.100.18

See Also:

Serialized Form

Field Summary

Fields inherited from class com.novell.ldap.LDAPMessage

ABANDON_REQUEST, ADD_REQUEST, ADD_RESPONSE, BIND_REQUEST, BIND_RESPONSE, COMPARE_REQUEST, COMPARE_RESPONSE, DEL_REQUEST, DEL_RESPONSE, EXTENDED_REQUEST, EXTENDED_RESPONSE, INTERMEDIATE_RESPONSE, message, MODIFY_RDN_REQUEST, MODIFY_RDN_RESPONSE, MODIFY_REQUEST, MODIFY_RESPONSE, SEARCH_REQUEST, SEARCH_RESPONSE, SEARCH_RESULT, SEARCH_RESULT_REFERENCE, UNBIND_REQUEST

Constructor Summary

GetReplicaInfoResponse(com.novell.ldap.rfc2251.RfcLDAPMessage rfcMessage)
Constructs an object from the responseValue which contains the replica information.

Method Summary

int	getflags() Returns flags that specify whether the replica is busy or is a boundary.
int	getlocalPartitionID() Returns the local numeric identifier for the replica.
int	getmodificationTime() Returns the time of the most recent modification.
java.lang.String	getpartitionDN() Returns the distinguished name of the partition.
int	getpartitionID() Returns the numeric identifier for the partition.
int	getpurgeTime() Returns the most recent time in which all data has been synchronized.
int	getreplicaState() Returns the current state of the replica.
int	getreplicaType() Returns the replica type.

Methods inherited from class com.novell.ldap.LDAPExtendedResponse

getID, getRegisteredResponses, getValue, register, setDeserializedValues

Methods inherited from class com.novell.ldap.LDAPResponse

chkResultCode, getControls, getErrorMessage, getMatchedDN, getMessageID, getReferrals, getResultCode, getType

Methods inherited from class com.novell.ldap.LDAPMessage

getTag, isRequest, readDSML, readExternal, setTag, toString, writeDSML, writeExternal

Methods inherited from class java.lang.Object

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

Constructor Detail

GetReplicaInfoResponse

public GetReplicaInfoResponse(com.novell.ldap.rfc2251.RfcLDAPMessage rfcMessage)
                       throws java.io.IOException

Constructs an object from the responseValue which contains the replica information.

The constructor parses the responseValue which has the following format:
responseValue ::=
partitionID INTEGER
replicaState INTEGER
modificationTime INTEGER
purgeTime INTEGER
localPartitionID INTEGER
partitionDN OCTET STRING
replicaType INTEGER
flags INTEGER

Throws:

java.io.IOException - The response value could not be decoded.

Method Detail

getpartitionID

public int getpartitionID()

Returns the numeric identifier for the partition.

Returns:

Integer value specifying the partition ID.

getreplicaState

public int getreplicaState()

Returns the current state of the replica.

Returns:

Integer value specifying the current state of the replica. See ReplicationConstants class for possible values for this field.

See Also:

ReplicationConstants.LDAP_RS_BEGIN_ADD, ReplicationConstants.LDAP_RS_DEAD_REPLICA, ReplicationConstants.LDAP_RS_DYING_REPLICA, ReplicationConstants.LDAP_RS_JS_0, ReplicationConstants.LDAP_RS_JS_1, ReplicationConstants.LDAP_RS_JS_2, ReplicationConstants.LDAP_RS_LOCKED, ReplicationConstants.LDAP_RS_MASTER_DONE, ReplicationConstants.LDAP_RS_MASTER_START, ReplicationConstants.LDAP_RS_SS_0, ReplicationConstants.LDAP_RS_TRANSITION_ON

getmodificationTime

public int getmodificationTime()

Returns the time of the most recent modification.

Returns:

Integer value specifying the last modification time.

getpurgeTime

public int getpurgeTime()

Returns the most recent time in which all data has been synchronized.

Returns:

Integer value specifying the last purge time.

getlocalPartitionID

public int getlocalPartitionID()

Returns the local numeric identifier for the replica.

Returns:

Integer value specifying the local ID of the partition.

getpartitionDN

public java.lang.String getpartitionDN()

Returns the distinguished name of the partition.

Returns:

String value specifying the name of the partition read.

getreplicaType

public int getreplicaType()

Returns the replica type.

See the ReplicationConstants class for possible values for this field.

Returns:

Integer identifying the type of the replica.

See Also:

ReplicationConstants.LDAP_RT_MASTER, ReplicationConstants.LDAP_RT_SECONDARY, ReplicationConstants.LDAP_RT_READONLY, ReplicationConstants.LDAP_RT_SUBREF, ReplicationConstants.LDAP_RT_SPARSE_WRITE, ReplicationConstants.LDAP_RT_SPARSE_READ

getflags

public int getflags()

Returns flags that specify whether the replica is busy or is a boundary.

See the ReplicationConstants class for possible values for this field.

Returns:

Integer value specifying the flags for the replica.

See Also:

ReplicationConstants.LDAP_DS_FLAG_BUSY, ReplicationConstants.LDAP_DS_FLAG_BOUNDARY