|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.vhosting.netconf.frame.Identity
com.vhosting.netconf.frame.IdentityCreator
com.vhosting.netconf.frame.Rpc
public class Rpc
This class provides the basic structure for the construction of RPC operations and reading the associated RPC reply informations. 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.
Field Summary |
---|
Fields inherited from class com.vhosting.netconf.frame.Identity |
---|
name, namespaceURI, prefix |
Constructor Summary | |
---|---|
Rpc(Capability cap,
java.lang.String name)
Create an RPC request with the operation name for the specified capability. |
Method Summary | |
---|---|
void |
addAttribute(Attribute attr)
Allows you to assign an attribute to the RPC operation. |
void |
clearInputValues()
Clear the Input container. |
void |
clearOutputValues()
Clear the Output container. |
void |
dumpRpcMessage(Session session,
int messageId,
java.io.OutputStream out)
This method writes the RPC operation on the specified output stream as an XML Netconf message. |
Container |
getInput()
Get the first entry point to the structure of the PRC operation as a container. |
Container |
getOutput()
Get the first entry point to the structure of the PRC reply as a container. |
boolean |
readFromRpcReplyMessage(org.w3c.dom.Document doc)
This method loads the RPC reply 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 |
---|
public Rpc(Capability cap, java.lang.String name)
cap
- The capability.name
- The name of the RPC operation.Method Detail |
---|
public void addAttribute(Attribute attr)
attr
- The attribute.public void clearInputValues()
public void clearOutputValues()
public final Container getInput()
public final Container getOutput()
public void dumpRpcMessage(Session session, int messageId, java.io.OutputStream out) throws java.io.IOException
messageId
- The message id.out
- The output stream.
java.io.IOException
- Throw this exception when there are problems when writing the
message.public boolean readFromRpcReplyMessage(org.w3c.dom.Document doc)
doc
- The XML document containing the Netconf RPC reply message.
getOutput()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |