com.vhosting.netconf
Class Get

java.lang.Object
  extended by com.vhosting.netconf.Operation
      extended by com.vhosting.netconf.Get

public class Get
extends Operation

The get Netconf operation. Retrieve running configuration and device state information. Supported server capabilities:

 urn:ietf:params:netconf:base:1.0
 urn:ietf:params:netconf:capability:xpath:1.0
 

Version:
1.00, 02/11/2010
Author:
Giuseppe Palmeri

Nested Class Summary
 class Get.GetReply
          This class provides specific methods to process the data obtained in response to a RpcReply after a get operation.
 
Nested classes/interfaces inherited from class com.vhosting.netconf.Operation
Operation.Reply
 
Field Summary
 
Fields inherited from class com.vhosting.netconf.Operation
operation, session
 
Constructor Summary
Get(Session session)
          Create the get Netconf operation.
 
Method Summary
 SubtreeFilter createSubtreeFilter()
          Create a subtree filter.
 void setSubtreeFilter(SubtreeFilter f)
          Set the subtree filter.
 void setXPathFilter(java.lang.String xpath)
          Set an XPath filter.
 
Methods inherited from class com.vhosting.netconf.Operation
execute, execute, executeSync
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Get

public Get(Session session)
Create the get Netconf operation.

Parameters:
session - The active session.
Method Detail

createSubtreeFilter

public SubtreeFilter createSubtreeFilter()
Create a subtree filter. Simply call this method to create a filter which can be used with the operation. The created filter is an empty filter. Through an empty filter, no data will be available as an answer. You will need to populate the filter created with references to the data you want.

Returns:
The SubtreeFilter created.

setSubtreeFilter

public void setSubtreeFilter(SubtreeFilter f)
Set the subtree filter.

Parameters:
f - The subtree filter.
See Also:
createSubtreeFilter()

setXPathFilter

public void setXPathFilter(java.lang.String xpath)
                    throws CapabilityException
Set an XPath filter. Use this method when the operation includes the possibility of an XPath filter on data received. The XPath to be used as a filter for receiving data. The filter will be interpreted by the server.

Parameters:
xpath - The XPath string.
Throws:
CapabilityException - Throw this exception if the server does not have the :xpath:1.0 capability.