com.vhosting.netconf.frame
Class Notification

java.lang.Object
  extended by com.vhosting.netconf.frame.Identity
      extended by com.vhosting.netconf.frame.IdentityCreator
          extended by com.vhosting.netconf.frame.Notification

public class Notification
extends IdentityCreator

This class provides the basic structure for reading an RPC notification. The class was designed having in mind the fact that it can be used in case of automated code generation from a YANG module. Nothing prevents, however, be used freely.

Version:
1.00, 09/10/2010
Author:
Giuseppe Palmeri

Field Summary
 
Fields inherited from class com.vhosting.netconf.frame.Identity
name, namespaceURI, prefix
 
Constructor Summary
Notification(Capability cap, java.lang.String name)
          Create an RPC notification with its name for the specified capability.
 
Method Summary
 void clearValues()
          Clear the Notification container.
 Container getNotification()
          Get the first entry point to the structure of the PRC notification as a container.
 boolean readFromNotificationMessage(org.w3c.dom.Document doc)
          This method loads the RPC notification from the specified XML document.
 
Methods inherited from class com.vhosting.netconf.frame.IdentityCreator
createAnyxml, createAnyxml, createContainer, createContainer, createContainerReference, createContainerReference, createIdentity, createIdentity, createLeaf, createLeaf, createLeafList, createLeafList, createList, createList, createListReference, createListReference
 
Methods inherited from class com.vhosting.netconf.frame.Identity
getName, getNamespaceURI, getPrefix, getUniqueNane
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Notification

public Notification(Capability cap,
                    java.lang.String name)
Create an RPC notification with its name for the specified capability.

Parameters:
cap - The capability.
name - The name of the RPC notification.
Method Detail

clearValues

public void clearValues()
Clear the Notification container. After the invocation of this method all the assigned values through an RPC notification will be deleted.


getNotification

public final Container getNotification()
Get the first entry point to the structure of the PRC notification as a container.

Returns:
The RPC notification output container.

readFromNotificationMessage

public boolean readFromNotificationMessage(org.w3c.dom.Document doc)
This method loads the RPC notification from the specified XML document. The XML document should be a Netconf RPC notification message. The values loaded are available within the Notification container.

Parameters:
doc - The XML document containing the Netconf RPC notification message.
Returns:
true if it has been possible to load values into the structure; false otherwise.
See Also:
getNotification()