Package org.odpi.openmetadata.accessservices.securitymanager.events

Class SecurityManagerOutTopicEvent

  • All Implemented Interfaces:
    Serializable
    public class SecurityManagerOutTopicEvent
extends Object
implements Serializable
    SecurityManagerOutTopicEvent provides the structure of the Security Manager OMAS's OutTopic events. The values for elements and their classifications come from the events. They are not guaranteed to be current. If the latest values are required, the element should be queried from the repository using its GUID. The event values are useful if the third party security manager needs to maintain an exact record of all of the versions.
    See Also:
    Serialized Form

    • Constructor Detail

      • SecurityManagerOutTopicEvent

        public SecurityManagerOutTopicEvent()
        Default Constructor

      • SecurityManagerOutTopicEvent

        public SecurityManagerOutTopicEvent​(SecurityManagerOutTopicEvent template)
        Copy/clone constructor
        Parameters:
        template - object to copy

    • Method Detail

      • getEventVersionId

        public long getEventVersionId()
        Return the event version id.
        Returns:
        long

      • setEventVersionId

        public void setEventVersionId​(long eventVersionId)
        Set up the event version id.
        Parameters:
        eventVersionId - long

      • setEventType

        public void setEventType​(SecurityManagerEventType eventType)
        Set up the event type.
        Parameters:
        eventType - event type enum

      • getEventTime

        public Date getEventTime()
        Return the time that the element was updated.
        Returns:
        date/time

      • setEventTime

        public void setEventTime​(Date eventTime)
        Set up the time that the element was updated.
        Parameters:
        eventTime - date/time

      • getElementHeader

        public ElementHeader getElementHeader()
        Return details of the subject of the event.
        Returns:
        element header

      • setElementHeader

        public void setElementHeader​(ElementHeader elementHeader)
        Set up details of the subject of the event.
        Parameters:
        elementHeader - element header

      • getElementProperties

        public Map<String,​Object> getElementProperties()
        Return the map of properties for the element provided with the event. These values are not guaranteed to be current.
        Returns:
        property map

      • setElementProperties

        public void setElementProperties​(Map<String,​Object> elementProperties)
        Set up the map of properties for the element provided with the event. These values are not guaranteed to be current.
        Parameters:
        elementProperties - property map

      • getPreviousElementHeader

        public ElementHeader getPreviousElementHeader()
        Return the previous version of the element's header (if the event is related to an element update).
        Returns:
        element header

      • setPreviousElementHeader

        public void setPreviousElementHeader​(ElementHeader previousElementHeader)
        Set up the previous version of the element's header (if the event is related to an element update).
        Parameters:
        previousElementHeader - element header

      • getPreviousElementProperties

        public Map<String,​Object> getPreviousElementProperties()
        Return the previous version of the element's properties (if the event is related to an element update).
        Returns:
        property map

      • setPreviousElementProperties

        public void setPreviousElementProperties​(Map<String,​Object> previousElementProperties)
        Set up the previous version of the element's properties (if the event is related to an element update).
        Parameters:
        previousElementProperties - property map

      • getClassificationName

        public String getClassificationName()
        Return the name of the classification if the event relates to classifications.
        Returns:
        string name

      • setClassificationName

        public void setClassificationName​(String classificationName)
        Set up the name of the classification if the event relates to classifications.
        Parameters:
        classificationName - string name

      • getPreviousClassificationProperties

        public Map<String,​Object> getPreviousClassificationProperties()
        Return the property map for the previous version of a classification's properties (used for reclassify events).
        Returns:
        property map

      • setPreviousClassificationProperties

        public void setPreviousClassificationProperties​(Map<String,​Object> previousClassificationProperties)
        Set up the property map for the previous version of a classification's properties (used for reclassify events).
        Parameters:
        previousClassificationProperties - property map

      • toString

        public String toString()
        Standard toString method.
        Overrides:
        toString in class Object
        Returns:
        print out of variables in a JSON-style

      • equals

        public boolean equals​(Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class Object
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison

      • hashCode

        public int hashCode()
        Create a hash code for this element type.
        Overrides:
        hashCode in class Object
        Returns:
        int hash code