com.vhosting.netconf
Class GetConfig
java.lang.Object
com.vhosting.netconf.Operation
com.vhosting.netconf.GetConfig
public class GetConfig
- extends Operation
The get-config Netconf operation.
Retrieve all or part of a specified configuration.
Supported server capabilities:
urn:ietf:params:netconf:base:1.0
urn:ietf:params:netconf:capability:xpath:1.0
urn:ietf:params:netconf:capability:candidate:1.0
urn:ietf:params:netconf:capability:startup:1.0
- Version:
- 1.00, 02/11/2010
- Author:
- Giuseppe Palmeri
Nested Class Summary |
class |
GetConfig.GetConfigReply
This class provides specific methods to process
the data obtained in response to a RpcReply
after a get-config operation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
GetConfig
public GetConfig(Session session,
Datastore source)
throws CapabilityException
- Create the get-config Netconf operation.
- Parameters:
session
- The active session.source
- The source container.
- Throws:
CapabilityException
- Throw this exception if the server
does not have the :candidate:1.0 capability and the source
container is 'candidate'.
Similarly, throw this exception if the server
does not have the :startup:1.0 capability and the source
container is 'startup'.
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.