Package org.onosproject.store.group.impl

Class GroupStoreMessage

  • public final class GroupStoreMessage
extends java.lang.Object
    Format of the Group store message that is used to communicate with the peer nodes in the cluster.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  GroupStoreMessage.Type
      Type of group store request.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.onosproject.net.group.GroupKey appCookie()
      Returns the application cookie associated with this group request.
      static GroupStoreMessage createGroupAddRequestMsg​(org.onosproject.net.DeviceId deviceId, org.onosproject.net.group.GroupDescription desc)
      Creates a group store message for group ADD request.
      static GroupStoreMessage createGroupDeleteRequestMsg​(org.onosproject.net.DeviceId deviceId, org.onosproject.net.group.GroupKey appCookie)
      Creates a group store message for group DELETE request.
      static GroupStoreMessage createGroupFailoverMsg​(org.onosproject.net.DeviceId deviceId, org.onosproject.net.group.GroupDescription desc)  
      static GroupStoreMessage createGroupUpdateRequestMsg​(org.onosproject.net.DeviceId deviceId, org.onosproject.net.group.GroupKey appCookie, org.onosproject.net.group.GroupStore.UpdateType updateType, org.onosproject.net.group.GroupBuckets updateBuckets, org.onosproject.net.group.GroupKey newAppCookie)
      Creates a group store message for group UPDATE request.
      org.onosproject.net.DeviceId deviceId()
      Returns the device identifier of this group request.
      org.onosproject.net.group.GroupDescription groupDesc()
      Returns the group create parameters associated with this group request.
      org.onosproject.net.group.GroupKey newAppCookie()
      Returns the new application cookie associated with this group operation.
      GroupStoreMessage.Type type()
      Returns the type of this group operation.
      org.onosproject.net.group.GroupBuckets updateBuckets()
      Returns the group buckets to be updated as part of this group request.
      org.onosproject.net.group.GroupStore.UpdateType updateType()
      Returns the update group operation type.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • createGroupAddRequestMsg

        public static GroupStoreMessage createGroupAddRequestMsg​(org.onosproject.net.DeviceId deviceId,
                                                         org.onosproject.net.group.GroupDescription desc)
        Creates a group store message for group ADD request.
        Parameters:
        deviceId - device identifier in which group to be added
        desc - group creation parameters
        Returns:
        constructed group store message

      • createGroupUpdateRequestMsg

        public static GroupStoreMessage createGroupUpdateRequestMsg​(org.onosproject.net.DeviceId deviceId,
                                                            org.onosproject.net.group.GroupKey appCookie,
                                                            org.onosproject.net.group.GroupStore.UpdateType updateType,
                                                            org.onosproject.net.group.GroupBuckets updateBuckets,
                                                            org.onosproject.net.group.GroupKey newAppCookie)
        Creates a group store message for group UPDATE request.
        Parameters:
        deviceId - the device ID
        appCookie - the current group key
        updateType - update (add or delete) type
        updateBuckets - group buckets for updates
        newAppCookie - optional new group key
        Returns:
        constructed group store message

      • createGroupDeleteRequestMsg

        public static GroupStoreMessage createGroupDeleteRequestMsg​(org.onosproject.net.DeviceId deviceId,
                                                            org.onosproject.net.group.GroupKey appCookie)
        Creates a group store message for group DELETE request.
        Parameters:
        deviceId - the device ID
        appCookie - the group key
        Returns:
        constructed group store message

      • createGroupFailoverMsg

        public static GroupStoreMessage createGroupFailoverMsg​(org.onosproject.net.DeviceId deviceId,
                                                       org.onosproject.net.group.GroupDescription desc)

      • deviceId

        public org.onosproject.net.DeviceId deviceId()
        Returns the device identifier of this group request.
        Returns:
        device identifier

      • appCookie

        public org.onosproject.net.group.GroupKey appCookie()
        Returns the application cookie associated with this group request.
        Returns:
        application cookie

      • groupDesc

        public org.onosproject.net.group.GroupDescription groupDesc()
        Returns the group create parameters associated with this group request.
        Returns:
        group create parameters

      • updateBuckets

        public org.onosproject.net.group.GroupBuckets updateBuckets()
        Returns the group buckets to be updated as part of this group request.
        Returns:
        group buckets to be updated

      • updateType

        public org.onosproject.net.group.GroupStore.UpdateType updateType()
        Returns the update group operation type.
        Returns:
        update operation type

      • newAppCookie

        public org.onosproject.net.group.GroupKey newAppCookie()
        Returns the new application cookie associated with this group operation.
        Returns:
        new application cookie

      • type

        public GroupStoreMessage.Type type()
        Returns the type of this group operation.
        Returns:
        group message type