Module ncache.runtime.WriteThruOptions

Classes

class WriteThruOptions (writemode=WriteMode.NONE, providername=None)

Class that defines write-through options regarding updating the data source.

Initializes a new instance of WriteThruOptions.

:param writemode: write-through options. :type writemode: WriteMode :param providername: A unique identifier for the data source provider. :type providername: str

Expand source code

class WriteThruOptions:
    """
    Class that defines write-through options regarding updating the data source.
    """
    __datamodificationlistener = None

    def __init__(self, writemode=WriteMode.NONE, providername=None):
        """
        Initializes a new instance of WriteThruOptions.

        :param writemode: write-through options.
        :type writemode: WriteMode
        :param providername: A unique identifier for the data source provider.
        :type providername: str
        """
        ValidateType.type_check(writemode, WriteMode, self.__init__)
        if providername is not None:
            ValidateType.is_string(providername, self.__init__)

        javawritemode = EnumUtil.get_write_mode(writemode.value)
        if providername is not None:
            javaprovidername = TypeCaster.to_java_primitive_type(providername)
        else:
            javaprovidername = jp.JObject(None, jp.java.lang.String)
        self.__writethruoptions = JavaInstancesFactory.get_java_instance("WriteThruOptions")(javawritemode, javaprovidername)

    def get_instance(self):
        return self.__writethruoptions

    def set_instance(self, value):
        self.__writethruoptions = value

    def get_data_source_modification_listener(self):
        """
        Gets the data source modified notification listener callback for write-through options.

        :return: The data source modified notification listener callback.
        :rtype: Callable
        """
        return self.__datamodificationlistener

    def get_event_types(self):
        """
        Gets the events list registered for datasource modification listener.

        :return: The events list.
        :rtype: list
        """
        result = self.__writethruoptions.getEventTypes()

        if result is not None:
            result = EventsListenerHelper.get_event_type_list(result)

        return result

    def get_mode(self):
        """
        Gets the WriteMode for write-through options.

        :return: write mode for write-through options.
        :rtype: WriteMode
        """
        result = self.__writethruoptions.getMode()

        if result is not None:
            result = EnumUtil.get_write_mode_value(int(result.getValue()))

        return result

    def get_provider_name(self):
        """
        Gets the unique identifier for the data source provider.

        :return: The name of datasource provider.
        :rtype: str
        """
        result = self.__writethruoptions.getProviderName()

        if result is not None:
            result = str(result)

        return result

    def set_data_source_modification_listener(self, callablefunction, eventtypes):
        """
        Sets the data source modified notification listener for write-through options.

        :param callablefunction: A listener function that is invoked whenever datasource is modified. This function
            should have this signature: callablefunction(key: str, writebehindopresult: WriteBehindOpResult)
        :type callablefunction: Callable
        :param eventtypes: The list of event types to be registered against the datasource listener.
        :type eventtypes: list
        """
        ValidateType.params_check(callablefunction, 2, self.set_data_source_modification_listener)
        for item in eventtypes:
            ValidateType.type_check(item, EventType, self.set_data_source_modification_listener)

        listener = DataSourceModifiedListener(callablefunction)
        javaeventtypes = EventsListenerHelper.get_event_type_enum_set(eventtypes)

        self.__writethruoptions.setDataSourceModificationListener(listener, javaeventtypes)
        self.__datamodificationlistener = callablefunction

    def set_mode(self, writemode):
        """
        Sets the WriteMode for write-through options.

        :param writemode: write mode for write-through options.
        :type writemode: WriteMode
        """
        ValidateType.type_check(writemode, WriteMode, self.set_mode)

        javawritemode = EnumUtil.get_write_mode(writemode)
        self.__writethruoptions.setMode(javawritemode)

    def set_provider_name(self, providername):
        """
        Sets the unique identifier for the data source provider.

        :param providername:
        :return: The name of the datasource provider.
        :rtype: str
        """
        ValidateType.is_string(providername, self.set_provider_name)

        javaprovidername = TypeCaster.to_java_primitive_type(providername)
        self.__writethruoptions.setProviderName(javaprovidername)

Methods

def get_data_source_modification_listener(self)

Gets the data source modified notification listener callback for write-through options.

:return: The data source modified notification listener callback. :rtype: Callable

Expand source code

def get_data_source_modification_listener(self):
    """
    Gets the data source modified notification listener callback for write-through options.

    :return: The data source modified notification listener callback.
    :rtype: Callable
    """
    return self.__datamodificationlistener

def get_event_types(self)

Gets the events list registered for datasource modification listener.

:return: The events list. :rtype: list

Expand source code

def get_event_types(self):
    """
    Gets the events list registered for datasource modification listener.

    :return: The events list.
    :rtype: list
    """
    result = self.__writethruoptions.getEventTypes()

    if result is not None:
        result = EventsListenerHelper.get_event_type_list(result)

    return result

def get_instance(self)

Expand source code

def get_instance(self):
    return self.__writethruoptions

def get_mode(self)

Gets the WriteMode for write-through options.

:return: write mode for write-through options. :rtype: WriteMode

Expand source code

def get_mode(self):
    """
    Gets the WriteMode for write-through options.

    :return: write mode for write-through options.
    :rtype: WriteMode
    """
    result = self.__writethruoptions.getMode()

    if result is not None:
        result = EnumUtil.get_write_mode_value(int(result.getValue()))

    return result

def get_provider_name(self)

Gets the unique identifier for the data source provider.

:return: The name of datasource provider. :rtype: str

Expand source code

def get_provider_name(self):
    """
    Gets the unique identifier for the data source provider.

    :return: The name of datasource provider.
    :rtype: str
    """
    result = self.__writethruoptions.getProviderName()

    if result is not None:
        result = str(result)

    return result

def set_data_source_modification_listener(self, callablefunction, eventtypes)

Sets the data source modified notification listener for write-through options.

:param callablefunction: A listener function that is invoked whenever datasource is modified. This function should have this signature: callablefunction(key: str, writebehindopresult: WriteBehindOpResult) :type callablefunction: Callable :param eventtypes: The list of event types to be registered against the datasource listener. :type eventtypes: list

Expand source code

def set_data_source_modification_listener(self, callablefunction, eventtypes):
    """
    Sets the data source modified notification listener for write-through options.

    :param callablefunction: A listener function that is invoked whenever datasource is modified. This function
        should have this signature: callablefunction(key: str, writebehindopresult: WriteBehindOpResult)
    :type callablefunction: Callable
    :param eventtypes: The list of event types to be registered against the datasource listener.
    :type eventtypes: list
    """
    ValidateType.params_check(callablefunction, 2, self.set_data_source_modification_listener)
    for item in eventtypes:
        ValidateType.type_check(item, EventType, self.set_data_source_modification_listener)

    listener = DataSourceModifiedListener(callablefunction)
    javaeventtypes = EventsListenerHelper.get_event_type_enum_set(eventtypes)

    self.__writethruoptions.setDataSourceModificationListener(listener, javaeventtypes)
    self.__datamodificationlistener = callablefunction

def set_instance(self, value)

Expand source code

def set_instance(self, value):
    self.__writethruoptions = value

def set_mode(self, writemode)

Sets the WriteMode for write-through options.

:param writemode: write mode for write-through options. :type writemode: WriteMode

Expand source code

def set_mode(self, writemode):
    """
    Sets the WriteMode for write-through options.

    :param writemode: write mode for write-through options.
    :type writemode: WriteMode
    """
    ValidateType.type_check(writemode, WriteMode, self.set_mode)

    javawritemode = EnumUtil.get_write_mode(writemode)
    self.__writethruoptions.setMode(javawritemode)

def set_provider_name(self, providername)

Sets the unique identifier for the data source provider.

:param providername: :return: The name of the datasource provider. :rtype: str

Expand source code

def set_provider_name(self, providername):
    """
    Sets the unique identifier for the data source provider.

    :param providername:
    :return: The name of the datasource provider.
    :rtype: str
    """
    ValidateType.is_string(providername, self.set_provider_name)

    javaprovidername = TypeCaster.to_java_primitive_type(providername)
    self.__writethruoptions.setProviderName(javaprovidername)