|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface INetconfModule
This interface provides methods for managing a configuration datastore.
Method Summary | |
---|---|
void |
copyConfig(IConfigElement topElement)
Replaces an entire configuration with the supplied configuration. |
void |
deleteConfig()
Deletes an entire configuration datastore. |
NetconfError[] |
editConfig(IConfigElement topElement,
boolean stopOnError)
Supplies an IConfigElement representing the top element in the tree of elements that will be used to edit the configuration. |
java.lang.String |
getDataStoreName()
Returns the name of this modules configuration datastore. |
IDataStoreElement |
getTopElement()
Returns the top data element in this module's data structure. |
boolean |
holdsLock(int sessionId)
Returns true if the resource is locked and the lock is held by the specified session. |
boolean |
isLocked()
Returns true if the resource is locked, false otherwise |
void |
lock(int sessionId)
Locks the resources represented by this module from modifications outside of the current NetConf session. |
void |
unlock(int sessionId)
Unlocks the resources represented by this module. |
Method Detail |
---|
java.lang.String getDataStoreName()
IDataStoreElement getTopElement()
void lock(int sessionId) throws NetconfErrorException
sessionId
- The ID of the session requesting this operation.
NetconfErrorException
- If unable to lock the data store.void unlock(int sessionId) throws NetconfErrorException
sessionId
- The ID of the session requesting this operation.
NetconfErrorException
- If data store was not locked or the specified session
ID does not match the ID of the session that locked the module.boolean isLocked()
boolean holdsLock(int sessionId)
sessionId
- A session ID.
NetconfError[] editConfig(IConfigElement topElement, boolean stopOnError) throws NetconfErrorException
topElement
- The top IConfigElement object for this configuration.stopOnError
- a boolean indicating whether to stop when an error is encountered.
NetconfErrorException
- If there was a problem editing the
configuration. The Exception will contain information the will be used to
create the void copyConfig(IConfigElement topElement) throws NetconfErrorException
topElement
- The top IConfigElement object for this configuration.
NetconfErrorException
- If there was a problem copying the configuration. The
Exception will contain information the will be used to create the void deleteConfig() throws NetconfErrorException
NetconfErrorException
- If there was a problem deleting the configuration datastore.
The Exception will contain information the will be used to create the
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |