com.novell.admin.ns.nds

Interface NDSPartitionService

All Superinterfaces:

PartitionService

public interface NDSPartitionService
extends PartitionService

NDSPartitionService provides partition and replica operations.

Method Summary

Modifier and Type	Method and Description
void	abortPartitionOperation(ObjectEntry partObjEntry) Aborts a partition operation on the input partObjEntry
OperationStatus	changeReplicaType(ObjectEntry partObjEntry, java.lang.String servFDN, int type) Changes the replica type of a partition replica on a server
NDSReplicaInfo[]	getDirectedPartitionReplicaList(ObjectEntry partitionOE, ObjectEntry serverOE) Returns a list of NDSReplicaInfo's for a partition objectEntry.
int	getNumberOfReplicasOnServer(ObjectEntry servObjEntry) Returns the number of replicas stored on the input server object entry.
NDSPartitionInfo	getPartitionInfo(ObjectEntry partOE) Returns partition information of a partition.
NDSReplicaInfo	getReplicaInfo(NDSReplica replica, java.lang.String unusedParam) Return replica information of a replica.
NDSReplicaInfo	getReplicaInfo(ObjectEntry partitionOE, ObjectEntry serverStoredOnOE) Return replica information of a replica.
NDSReplicaInfo	getReplicaInfo(ObjectEntry partitionOE, ObjectEntry serverStoredOnOE, ObjectEntry serverToReadOE) Return replica information of a replica from a specifically directed server See NDSReplicaInfo to get more detail of the information returned.
java.util.Date	getUTCTime(ObjectEntry partObjEntry) Returns the Universal Time Coordinated (UTC) setting of the server.
void	receiveUpdates(ObjectEntry partObjEntry, java.lang.String servFDN) This replica receives updates from the master replica.
void	sendUpdates(ObjectEntry partObjEntry, java.lang.String servFDN) This replica sends updates to all other replicas.
void	syncReplica(ObjectEntry partObjEntry, java.lang.String servFDN) This method updates each replica of a partition after an addition, deletion, or modification to NDS.

Methods inherited from interface com.novell.admin.ns.PartitionService

createPartition, createReplica, deleteReplica, getPartitionReplicaList, getPartitionRoot, getServerPartitionList, isPartition, mergePartition

Method Detail

abortPartitionOperation

void abortPartitionOperation(ObjectEntry partObjEntry)
                      throws SPIException

Aborts a partition operation on the input partObjEntry

Parameters:

partObjEntry - The partition ObjectEntry on which the operation is occuring.

Throws:

SPIException - Thrown when the service provider returns an error.

getPartitionInfo

NDSPartitionInfo getPartitionInfo(ObjectEntry partOE)
                           throws SPIException

Returns partition information of a partition. No specific server is read to obtain the partition information. See NDSPartitionInfo to get more detail of the information returned.

Parameters:

partOE - The partition ObjectEntry whose information will be returned

Returns:

NDSPartitionInfo Return null if NDSPartitionInfo cannot be constructed. See NDSPartitionInfo for more information

Throws:

SPIException - Thrown when the service provider returns an error.

getNumberOfReplicasOnServer

int getNumberOfReplicasOnServer(ObjectEntry servObjEntry)
                         throws SPIException

Returns the number of replicas stored on the input server object entry.

Parameters:

servObjEntry - The server ObjectEntry being checked.

Returns:

Number of replicas on a server.

Throws:

SPIException - Thrown when the service provider returns an error.

changeReplicaType

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

Changes the replica type of a partition replica on a server

Parameters:

partObjEntry - The partition ObjectEntry whose replica will be changed.

servFDN - The FDN of the server holding the replica.

type - The new replica type.

Returns:

OperationStatus See NDSReplicaOperationStatus for more information.

Throws:

SPIException - Thrown when the service provider returns an error.

getReplicaInfo

NDSReplicaInfo getReplicaInfo(NDSReplica replica,
                              java.lang.String unusedParam)
                       throws SPIException

Return replica information of a replica. The server the information is read from is not specified. See NDSReplicaInfo to get more detail of the information returned.

Parameters:

replica - The NDSReplica whose information will be returned.

unusedParam - this parameter is not used

Returns:

Throws:

SPIException - Thrown when the service provider returns an error.

getReplicaInfo

NDSReplicaInfo getReplicaInfo(ObjectEntry partitionOE,
                              ObjectEntry serverStoredOnOE)
                       throws SPIException

Return replica information of a replica. The server the information is read from is not specified. See NDSReplicaInfo to get more detail of the information returned.

Parameters:

partitionOE - The partition ObjectEntry whose information will be returned.

serverStoredOnOE - The server ObjectEntry used to identify the server which contains the replica. This is not the server from which the information will be read. The server from which the information about this replica is read from is not specified.

Throws:

SPIException - Thrown when the service provider returns an error.

getReplicaInfo

NDSReplicaInfo getReplicaInfo(ObjectEntry partitionOE,
                              ObjectEntry serverStoredOnOE,
                              ObjectEntry serverToReadOE)
                       throws SPIException

Return replica information of a replica from a specifically directed server See NDSReplicaInfo to get more detail of the information returned.

Parameters:

partitionOE - The partition ObjectEntry whose information will be returned.

serverStoredOnOE - The server ObjectEntry used to identify the server which contains the replica. This is not the server from which the information will be read.

serverToReadOE - The server that will be connected to and used to read the information about the replica specified. The replica specified may actually be stored on a different server. This is the server used to get the desired information from. This may be null, in which case the server connected to and used to read the information about the replica is not specified.

Throws:

SPIException - Thrown when the service provider returns an error.

getUTCTime

java.util.Date getUTCTime(ObjectEntry partObjEntry)
                   throws SPIException

Returns the Universal Time Coordinated (UTC) setting of the server.

Parameters:

partObjEntry - The partition ObjectEntery whose information will be returned.

Throws:

SPIException - Thrown when the service provider returns an error.

getDirectedPartitionReplicaList

NDSReplicaInfo[] getDirectedPartitionReplicaList(ObjectEntry partitionOE,
                                                 ObjectEntry serverOE)
                                          throws SPIException

Returns a list of NDSReplicaInfo's for a partition objectEntry. A list of the replicas is obtained from the specified server. Then the server that contains that replica will be contacted to get that replica's information. All servers in the replica ring must be up in order for this method to return successfully.

Parameters:

partitionOE - The partition ObjectEntry.

serverOE - The directed server ObjectEntry to get the list of replicas from. If null, then any server containing a replica for the partition ObjectEntry may be used.

Returns:

Array of NDSReplicaInfo

Throws:

SPIException - Thrown when the service provider returns an error.

sendUpdates

void sendUpdates(ObjectEntry partObjEntry,
                 java.lang.String servFDN)
          throws SPIException

This replica sends updates to all other replicas.

Parameters:

partObjEntry - The partition ObjectEntry whose replica will be changed.

servFDN - The FDN of the server which the replica is on.

Throws:

SPIException - Thrown when the service provider returns an error.

receiveUpdates

void receiveUpdates(ObjectEntry partObjEntry,
                    java.lang.String servFDN)
             throws SPIException

This replica receives updates from the master replica.

Parameters:

partObjEntry - The partition ObjectEntry whose replica will be changed.

servFDN - The FDN of the server which the replica is on.

Throws:

SPIException - Thrown when the service provider returns an error.

syncReplica

void syncReplica(ObjectEntry partObjEntry,
                 java.lang.String servFDN)
          throws SPIException

This method updates each replica of a partition after an addition, deletion, or modification to NDS.

Parameters:

partObjEntry - The partition ObjectEntry whose replica will be synchronized.

servFDN - The FDN of the server which the replica is on.

Throws:

SPIException - Thrown when the service provider returns an error.