com.novell.ldap.extensions
Class LDAPBackupResponse

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

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class LDAPBackupResponse

extends LDAPExtendedResponse

This object represent the data returned from a LDAPBackupRequest.

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

The LDAPBackupResponse extension uses the following OID:
2.16.840.1.113719.1.27.100.97

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

LDAPBackupResponse(com.novell.ldap.rfc2251.RfcLDAPMessage rfcMessage)
Constructs an object from the responseValue which contains the backup data.

Method Summary

int	getBufferLength() Returns the data buffer length
java.lang.String	getChunkSizesString() Returns the data in String as:: no_of_chunks;sizeOf(chunk1);sizeOf(chunk2)…sizeOf(chunkn) where no_of_chunks => Represents the number of chunks of data returned from server sizeOf(chunkn) => Represents the size of data in chunkn
byte[]	getReturnedBuffer() Returns the data buffer as byte[]
java.lang.String	getStatusInfo() Returns the stateInfo of returned eDirectory Object.

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

LDAPBackupResponse

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

Constructs an object from the responseValue which contains the backup data.

The constructor parses the responseValue which has the following format:
responseValue ::=

databufferLength ::= INTEGER
mts(modification time stamp) ::= INTEGER
revision ::= INTEGER
returnedBuffer ::= OCTET STRING
dataChunkSizes ::=
SEQUENCE{
noOfChunks INTEGER
SET of [
SEQUENCE of {eachChunksize INTEGER}]
}

Throws:

java.io.IOException - The responseValue could not be decoded.

Method Detail

getBufferLength

public int getBufferLength()

Returns the data buffer length

Returns:

bufferLength as integer.

getStatusInfo

public java.lang.String getStatusInfo()

Returns the stateInfo of returned eDirectory Object. This is combination of MT (Modification Timestamp) and Revision value with char '+' as separator between two.
Client application if want to use both MT and Revision need to break this string to get both these data.

Returns:

stateInfo as String.

getChunkSizesString

public java.lang.String getChunkSizesString()

Returns the data in String as::
no_of_chunks;sizeOf(chunk1);sizeOf(chunk2)…sizeOf(chunkn)
where
no_of_chunks => Represents the number of chunks of data returned from server
sizeOf(chunkn) => Represents the size of data in chunkn

Returns:

chunkSizesString as String.

getReturnedBuffer

public byte[] getReturnedBuffer()

Returns the data buffer as byte[]

Returns:

returnedBuffer as byte[].