com.novell.admin.ns

Interface PartitionService

All Known Subinterfaces:

NDSPartitionService

public interface PartitionService

This interface describes partition operations.

Method Summary

Modifier and Type	Method and Description
OperationStatus	createPartition(ObjectEntry partObjEntry) Creates a partition at the with the specified ObjectEntry as the partition root.
OperationStatus	createReplica(ObjectEntry partObjEntry, java.lang.String servFDN, int type) Creates a replica of a specified partition.
OperationStatus	deleteReplica(ObjectEntry partObjEntry, java.lang.String servFDN) Deletes a replica of a specified partition.
Replica[]	getPartitionReplicaList(ObjectEntry partOE, java.lang.String serverToRead) Returns a list of replicas of a partition objectEntry.
java.lang.String	getPartitionRoot(ObjectEntry objEntry) Returns the fully distinguished name of the specified partition root objEntry.
Replica[]	getServerPartitionList(ObjectEntry servObjEntry) Returns the list of replicas stored on a server.
boolean	isPartition(ObjectEntry objEntry) Determines if an object is a partition.
OperationStatus	mergePartition(ObjectEntry partObjEntry) Merges a partition with its parent partition.

Method Detail

createPartition

OperationStatus createPartition(ObjectEntry partObjEntry)
                         throws SPIException

Creates a partition at the with the specified ObjectEntry as the partition root. This method will spawn a thread to perform the partition operation because the create partition operation is a block call.

Parameters:

partObjEntry - The ObjectEntry at which the partition will be created.

Throws:

SPIException - Thrown when the service provider returns an error.

mergePartition

OperationStatus mergePartition(ObjectEntry partObjEntry)
                        throws SPIException

Merges a partition with its parent partition. This method will spawn a thread to to the partition operation because the merge partition operation is a block call. A callback should be provided to this method so the caller has control of the thread.

Parameters:

partObjEntry - The partition ObjectEntry to be merged with its parent partition.

Throws:

SPIException - Thrown when the service provider returns an error.

getPartitionReplicaList

Replica[] getPartitionReplicaList(ObjectEntry partOE,
                                  java.lang.String serverToRead)
                           throws SPIException

Returns a list of replicas of a partition objectEntry. An empty array will be returned if no replicas can be found.

Parameters:

partOE - The partition ObjectEntry.

serverToRead - DN of the server to read "Replica" attribute from. if null then any server that contains the partition object could be used

Returns:

Array of NDSReplica See NDSReplica for more information

Throws:

SPIException - Thrown when the service provider returns an error.

getServerPartitionList

Replica[] getServerPartitionList(ObjectEntry servObjEntry)
                          throws SPIException

Returns the list of replicas stored on a server.

Parameters:

servObjEntry - The server ObjectEntry where to get a list of replicas from.

Returns:

Vector of NDSReplica See NDSReplica for more information

Throws:

SPIException - Thrown when the service provider returns an error.

createReplica

OperationStatus createReplica(ObjectEntry partObjEntry,
                              java.lang.String servFDN,
                              int type)
                       throws SPIException

Creates a replica of a specified partition.

Parameters:

partObjEntry - The partition ObjectEntry for which to create a replica.

servFDN - The FDN of the server where we will create a replica on.

type - The type of the replica which we will create.

Throws:

SPIException - Thrown when the service provider returns an error.

deleteReplica

OperationStatus deleteReplica(ObjectEntry partObjEntry,
                              java.lang.String servFDN)
                       throws SPIException

Deletes a replica of a specified partition.

Parameters:

partObjEntry - The partition ObjectEntry whose replica will be deleted.

servFDN - The fully distinguished name of the server holding the replica.

Throws:

SPIException - Thrown when the service provider returns an error.

getPartitionRoot

java.lang.String getPartitionRoot(ObjectEntry objEntry)
                           throws SPIException

Returns the fully distinguished name of the specified partition root objEntry.

Parameters:

objEntry - The object whose partition root is being retrieved.

Returns:

The partition root object's fully distinguished name.

Throws:

SPIException - Thrown when the service provider returns an error.

isPartition

boolean isPartition(ObjectEntry objEntry)
             throws SPIException

Determines if an object is a partition.

Parameters:

objEntry - The object to be checked.

Returns:

True if the object is a partition, false otherwise.

Throws:

SPIException - Thrown when the service provider returns an error.