com.novell.admin.ns.nds
Interface NDSPartitionService

All Superinterfaces:
PartitionService

public interface NDSPartitionService
extends PartitionService

NDSPartitionService provides partition and replica operations.


Method Summary
 void abortPartitionOperation(com.novell.application.console.snapin.ObjectEntry partObjEntry)
          Aborts a partition operation on the input partObjEntry
 OperationStatus changeReplicaType(com.novell.application.console.snapin.ObjectEntry partObjEntry, java.lang.String servFDN, int type)
          Changes the replica type of a partition replica on a server
 NDSReplicaInfo[] getDirectedPartitionReplicaList(com.novell.application.console.snapin.ObjectEntry partitionOE, com.novell.application.console.snapin.ObjectEntry serverOE)
          Returns a list of NDSReplicaInfo of a partition objectEntry from directed server.
 int getNumberOfReplicasOnServer(com.novell.application.console.snapin.ObjectEntry servObjEntry)
          Returns the number of replicas stored on the input server object entry.
 NDSPartitionInfo getPartitionInfo(com.novell.application.console.snapin.ObjectEntry partObjEntry)
          Returns partition information of a partition.
 NDSReplicaInfo getReplicaInfo(NDSReplica replica, java.lang.String serverToRead)
          Returns replica information of a replica.
 NDSReplicaInfo getReplicaInfo(com.novell.application.console.snapin.ObjectEntry pFDN, com.novell.application.console.snapin.ObjectEntry servFDN)
          Returns a replica's information.
 java.util.Date getUTCTime(com.novell.application.console.snapin.ObjectEntry partObjEntry)
          Returns the Universal Time Coordinated (UTC) setting of the server.
 void receiveUpdates(com.novell.application.console.snapin.ObjectEntry partObjEntry, java.lang.String servFDN)
          This replica receives updates from the master replica.
 void sendUpdates(com.novell.application.console.snapin.ObjectEntry partObjEntry, java.lang.String servFDN)
          This replica sends updates to all other replicas.
 void syncReplica(com.novell.application.console.snapin.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

public void abortPartitionOperation(com.novell.application.console.snapin.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

public NDSPartitionInfo getPartitionInfo(com.novell.application.console.snapin.ObjectEntry partObjEntry)
                                  throws SPIException
Returns partition information of a partition. See NDSPartitionInfo to get more detail of the information returned.
Parameters:
partObjEntry - The partition ObjectEntry whose information will be returned.
Returns:
NDSPartitionInfo See NDSPartitionInfo for more information.
Throws:
SPIException - Thrown when the service provider returns an error.

getNumberOfReplicasOnServer

public int getNumberOfReplicasOnServer(com.novell.application.console.snapin.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

public OperationStatus changeReplicaType(com.novell.application.console.snapin.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

public NDSReplicaInfo getReplicaInfo(NDSReplica replica,
                                     java.lang.String serverToRead)
                              throws SPIException
Returns replica information of a replica.

See NDSReplicaInfo to get more details of the information returned.

Parameters:
replica - The NDSReplica whose information will be returned.
Throws:
SPIException - Thrown when the service provider returns an error.

getReplicaInfo

public NDSReplicaInfo getReplicaInfo(com.novell.application.console.snapin.ObjectEntry pFDN,
                                     com.novell.application.console.snapin.ObjectEntry servFDN)
                              throws SPIException
Returns a replica's information.

See NDSReplicaInfo for information about the information returned.

Parameters:
objEntry - The partition ObjectEntery whose information will be returned.
servFDN - The server FDN which the replica is on.
Throws:
SPIException - Thrown when the service provider returns an error.

getUTCTime

public java.util.Date getUTCTime(com.novell.application.console.snapin.ObjectEntry partObjEntry)
                          throws SPIException
Returns the Universal Time Coordinated (UTC) setting of the server.
Parameters:
objEntry - The partition ObjectEntery whose information will be returned.
Throws:
SPIException - Thrown when the service provider returns an error.

getDirectedPartitionReplicaList

public NDSReplicaInfo[] getDirectedPartitionReplicaList(com.novell.application.console.snapin.ObjectEntry partitionOE,
                                                        com.novell.application.console.snapin.ObjectEntry serverOE)
                                                 throws SPIException
Returns a list of NDSReplicaInfo of a partition objectEntry from directed server.
Parameters:
partitionOE - The server ObjectEntery.
serverOE - The server ObjectEntery.
Returns:
Array of NDSReplicaInfo
Throws:
SPIException - Thrown when the service provider returns an error.

sendUpdates

public void sendUpdates(com.novell.application.console.snapin.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

public void receiveUpdates(com.novell.application.console.snapin.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

public void syncReplica(com.novell.application.console.snapin.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.


API Documentation Copyright © 1998-2003 Novell, Inc. All rights reserved.
NDS is a registered trademark of Novell, Inc. in the United States and other countries.
Generated December 17 2003 1746.