com.vhosting.netconf.yuma
Class YANGCapability

java.lang.Object
  extended by com.vhosting.netconf.transport.Capability
      extended by com.vhosting.netconf.yuma.YANGCapability

public class YANGCapability
extends Capability

This class adds new attributes to a capability belonging to a YANG module.

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

Nested Class Summary
 
Nested classes/interfaces inherited from class com.vhosting.netconf.transport.Capability
Capability.CapabilityParams
 
Field Summary
 
Fields inherited from class com.vhosting.netconf.transport.Capability
prefix
 
Constructor Summary
YANGCapability(java.lang.String capabilityBaseURI, java.lang.String namespaceURI, java.lang.String prefix, java.lang.String moduleName)
          Create a capability associated with a specific YANG module.
YANGCapability(java.lang.String capabilityBaseURI, java.lang.String namespaceURI, java.lang.String prefix, java.lang.String moduleName, java.lang.String revision)
          Create a capability associated with a specific YANG module.
 
Method Summary
 java.lang.String getCapabilityURI()
          Get the capability uri with the parameters module and revision.
 java.lang.String getModuleName()
          Get the YANG module name.
 java.lang.String getRevision()
          Get the YANG module revision if exists.
 
Methods inherited from class com.vhosting.netconf.transport.Capability
getCapabilityBaseURI, getNamespaceURI, getPrefix, getServerCapabilityParams, isPresentOnServer, toString, touch, unsetServerCapabilityPresence
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

YANGCapability

public YANGCapability(java.lang.String capabilityBaseURI,
                      java.lang.String namespaceURI,
                      java.lang.String prefix,
                      java.lang.String moduleName)
Create a capability associated with a specific YANG module.
Note that in almost all cases, the capabilityBaseURI matches the namespaceUri.

Parameters:
capabilityBaseURI - The capability base Uri or the capability Uri without parameters.
namespaceURI - The namespace Uri for this capability.
prefix - The candidate namespace prefix of the namespace Uri.
moduleName - The YANG module name.

YANGCapability

public YANGCapability(java.lang.String capabilityBaseURI,
                      java.lang.String namespaceURI,
                      java.lang.String prefix,
                      java.lang.String moduleName,
                      java.lang.String revision)
Create a capability associated with a specific YANG module.
Note that in almost all cases, the capabilityBaseURI matches the namespaceUri.

Parameters:
capabilityBaseURI - The capability base Uri or the capability Uri without parameters.
namespaceURI - The namespace Uri for this capability.
prefix - The candidate namespace prefix of the namespace Uri.
moduleName - The YANG module name.
revision - The YANG module revision date.
Method Detail

getModuleName

public final java.lang.String getModuleName()
Get the YANG module name.

Returns:
The YANG module name.

getRevision

public final java.lang.String getRevision()
Get the YANG module revision if exists.

Returns:
The YANG module revision; null if the revision is not specified.

getCapabilityURI

public java.lang.String getCapabilityURI()
Get the capability uri with the parameters module and revision.
 For example:
 
    http://www.exaple.com/example?module=myexample
    
    http://www.exaple.com/example?module=myexample&revision=2010-12-09
 
 

Returns:
The capability uri with the parameters module and revision.