Interface CacheServerConfig

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<CacheServerConfig>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<RpkiConfig>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    @Generated("mdsal-binding-generator")
    public interface CacheServerConfig
    extends org.opendaylight.yangtools.yang.binding.ChildOf<RpkiConfig>, org.opendaylight.yangtools.yang.binding.Augmentable<CacheServerConfig>
    Configure the RPKI cache-server parameters in rpki-server configuration mode.

    This class represents the following YANG schema fragment defined in module bgp

     container cache-server-config {
       choice server {
         case ip-address {
           leaf ip-address {
             type inet:ip-address;
           }
         }
         case host-name {
           leaf ip-host-address {
             type inet:host;
           }
         }
       }
       choice transport {
         case tcp {
           leaf tcp-port {
             type uint32;
           }
         }
         case ssh {
           leaf ssh-port {
             type uint32;
           }
         }
       }
       leaf user-name {
         type string;
       }
       leaf password {
         type string;
       }
       leaf preference-value {
         type uint8 {
           range 1..10;
         }
       }
       leaf purge-time {
         type uint16 {
           range 30..360;
         }
       }
       choice refresh-time {
         case disable {
           leaf refresh-time-disable {
             type boolean;
           }
         }
         case set-time {
           leaf refresh-interval {
             type uint16 {
               range 15..3600;
             }
           }
         }
       }
       choice responce-time {
         case disable {
           leaf responce-time-disable {
             type boolean;
           }
         }
         case set-time {
           leaf responce-interval {
             type uint16 {
               range 15..3600;
             }
           }
         }
       }
     }
     
    The schema path to identify an instance is bgp/bgp-router/rpki-config/cache-server-config

    To create instances of this class use CacheServerConfigBuilder.

    See Also:
    CacheServerConfigBuilder
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default java.lang.Class<CacheServerConfig> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull CacheServerConfig obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull CacheServerConfig thisObj,
                                     java.lang.Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull CacheServerConfig obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null
      • getServer

        Server getServer()
        Return server, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.rpki.config.cache.server.config.Server server, or null if it is not present.
      • getTransport

        Transport getTransport()
        Return transport, or null if it is not present.
             
                 Specifies a transport method for the RPKI cache.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.rpki.config.cache.server.config.Transport transport, or null if it is not present.
      • getUserName

        java.lang.String getUserName()
        Return userName, or null if it is not present.
        Returns:
        java.lang.String userName, or null if it is not present.
      • getPassword

        java.lang.String getPassword()
        Return password, or null if it is not present.
        Returns:
        java.lang.String password, or null if it is not present.
      • getPreferenceValue

        org.opendaylight.yangtools.yang.common.Uint8 getPreferenceValue()
        Return preferenceValue, or null if it is not present.
             
                 Specifies a preference value for the RPKI cache. Setting a lower preference
                 value is better.
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint8 preferenceValue, or null if it is not present.
      • getPurgeTime

        org.opendaylight.yangtools.yang.common.Uint16 getPurgeTime()
        Return purgeTime, or null if it is not present.
             
                 Configures the time BGP waits to keep routes from a cache after the cache
                 session drops. Set purge time in seconds.
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 purgeTime, or null if it is not present.
      • getRefreshTime

        RefreshTime getRefreshTime()
        Return refreshTime, or null if it is not present.
             
                 Configures the time BGP waits in between sending periodic serial queries to the
                 cache. Set refresh-time in seconds.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.rpki.config.cache.server.config.RefreshTime refreshTime, or null if it is not present.
      • getResponceTime

        ResponceTime getResponceTime()
        Return responceTime, or null if it is not present.
             
                 Configures the time BGP waits for a response after sending a serial or reset
                 query. Set response-time in seconds.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.rpki.config.cache.server.config.ResponceTime responceTime, or null if it is not present.