Package com.smartgridready.communicator.common.helper

Class DriverFactoryLoader

  • public class DriverFactoryLoader
extends java.lang.Object
    Implements a driver factory loader. Provides registered factories of communication interface drivers. Uses the ServiceLoader mechanism to load interface driver factories from the classpath.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.List<com.smartgridready.driver.api.contacts.GenDriverAPI4ContactsFactory> getAllContactsDrivers()
      Gets all implementations of contacts driver factories.
      static java.util.List<com.smartgridready.driver.api.messaging.GenMessagingClientFactory> getAllMessagingDrivers()
      Gets all implementations of messaging driver factories.
      static java.util.List<com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory> getAllModbusDrivers()
      Gets all implementations of Modbus driver factories.
      static java.util.List<com.smartgridready.driver.api.http.GenHttpClientFactory> getAllRestApiDrivers()
      Gets all implementations of HTTP / REST driver factories.
      static com.smartgridready.driver.api.contacts.GenDriverAPI4ContactsFactory getContactsDriver()
      Gets the primary contacts driver factory.
      static com.smartgridready.driver.api.messaging.GenMessagingClientFactory getMessagingDriver​(com.smartgridready.driver.api.messaging.model.MessagingPlatformType platform)
      Gets the primary messaging driver factory.
      static com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory getModbusDriver()
      Gets the primary Modbus driver factory.
      static com.smartgridready.driver.api.http.GenHttpClientFactory getRestApiDriver()
      Gets the primary HTTP / REST driver factory.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getAllModbusDrivers

        public static java.util.List<com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory> getAllModbusDrivers()
        Gets all implementations of Modbus driver factories.
        Returns:
        a list of GenDriverAPI4ModbusFactory

      • getAllRestApiDrivers

        public static java.util.List<com.smartgridready.driver.api.http.GenHttpClientFactory> getAllRestApiDrivers()
        Gets all implementations of HTTP / REST driver factories.
        Returns:
        a list of GenHttpClientFactory

      • getAllMessagingDrivers

        public static java.util.List<com.smartgridready.driver.api.messaging.GenMessagingClientFactory> getAllMessagingDrivers()
        Gets all implementations of messaging driver factories.
        Returns:
        a list of GenMessagingClientFactory

      • getAllContactsDrivers

        public static java.util.List<com.smartgridready.driver.api.contacts.GenDriverAPI4ContactsFactory> getAllContactsDrivers()
        Gets all implementations of contacts driver factories.
        Returns:
        a list of GenDriverAPI4ContactsFactory

      • getModbusDriver

        public static com.smartgridready.driver.api.modbus.GenDriverAPI4ModbusFactory getModbusDriver()
        Gets the primary Modbus driver factory.
        Returns:
        an instance of GenDriverAPI4ModbusFactory, or null if none is registered

      • getRestApiDriver

        public static com.smartgridready.driver.api.http.GenHttpClientFactory getRestApiDriver()
        Gets the primary HTTP / REST driver factory.
        Returns:
        an instance of GenHttpClientFactory, or null if none is registered

      • getMessagingDriver

        public static com.smartgridready.driver.api.messaging.GenMessagingClientFactory getMessagingDriver​(com.smartgridready.driver.api.messaging.model.MessagingPlatformType platform)
        Gets the primary messaging driver factory.
        Parameters:
        platform - the type of messaging platfrom
        Returns:
        an instance of GenMessagingClientFactory, or null if none is registered

      • getContactsDriver

        public static com.smartgridready.driver.api.contacts.GenDriverAPI4ContactsFactory getContactsDriver()
        Gets the primary contacts driver factory.
        Returns:
        an instance of GenDriverAPI4ContactsFactory, or null if none is registered