Package org.opendaylight.lispflowmapping.interfaces.mapcache

Interface IMapCache

  • All Known Subinterfaces:
    ILispMapCache
    public interface IMapCache
    Map-cache interface.
    Author:
    Florin Coras

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addData​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key, String subKey, Object data)
      Add data for key.
      void addMapping​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key, Object value)
      Add mapping.
      Object getData​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key, String subKey)
      Generic retrieval of data.
      Object getMapping​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid srcKey, org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid dstKey)
      Retrieves mapping for the provided srcKey and dstKey.
      Set<org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid> getSubtree​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key)
      Retrieves the subtree of a prefix.
      org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid getWidestNegativeMapping​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key)
      Retrieves widest negative prefix.
      String prettyPrintMappings()
      Print mappings in cache in a human friendly format.
      String printMappings()
      Print mappings in cache.
      void removeData​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key, String subKey)
      Generic removal of data.
      void removeMapping​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key)
      Remove mapping.

    • Method Detail

      • addMapping

        void addMapping​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key,
                Object value)
        Add mapping.
        Parameters:
        key - Key of the mapping
        value - Value to be stored

      • getMapping

        Object getMapping​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid srcKey,
                  org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid dstKey)
        Retrieves mapping for the provided srcKey and dstKey.
        Parameters:
        srcKey - Source Key to be looked up
        dstKey - Destination Key to be looked up
        Returns:
        Returns the object found in the cache or null if nothing is found.

      • getWidestNegativeMapping

        org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid getWidestNegativeMapping​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key)
        Retrieves widest negative prefix.
        Parameters:
        key - Source Key to be looked up
        Returns:
        Returns the widest negative prefix or null if nothing is found.

      • getSubtree

        Set<org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid> getSubtree​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key)
        Retrieves the subtree of a prefix.
        Parameters:
        key - Key to be looked up
        Returns:
        The set of prefixes in the subtree for the prefix

      • removeMapping

        void removeMapping​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key)
        Remove mapping.
        Parameters:
        key - Key to be removed

      • addData

        void addData​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key,
             String subKey,
             Object data)
        Add data for key.
        Parameters:
        key - The key for which data is inserted
        subKey - The subKey where data should be inserted
        data - The data to be stored

      • getData

        Object getData​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key,
               String subKey)
        Generic retrieval of data.
        Parameters:
        key - The key where the data is stored
        subKey - The subKey where data is stored
        Returns:
        The data

      • removeData

        void removeData​(org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid key,
                String subKey)
        Generic removal of data.
        Parameters:
        key - The key of the data to be removed
        subKey - The subKey of the data to be removed

      • printMappings

        String printMappings()
        Print mappings in cache. Used for testing, debugging and the karaf shell.
        Returns:
        a String consisting of all the mappings in the cache

      • prettyPrintMappings

        String prettyPrintMappings()
        Print mappings in cache in a human friendly format.
        Returns:
        a String consisting of all the mappings in the cache