com.microsoft.azure.gateway.core.GatewayModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gateway-java-binding Show documentation
Azure IoT Gateway SDK Java Module Binding
The newest version!
/*
 * Copyright (c) Microsoft. All rights reserved.
 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
 */
package com.microsoft.azure.gateway.core;

import com.microsoft.azure.gateway.messaging.Message;

import java.io.IOException;

/**
 * The Abstract {@link GatewayModule} class to be extended by the module-creator when creating any modules.
 */
public abstract class GatewayModule implements IGatewayModule{

    public abstract void receive(Message message);
    public abstract void destroy();

    /** The address of the native module pointer */
    private long _addr;

    /** The {@link Broker} to which this module belongs */
    private Broker broker;

    /** The module-specific configuration object. */
    private String configuration;

    /**
     * Constructs a {@link GatewayModule} from the provided address and {@link Broker}. A {@link GatewayModule} should always call this super
     * constructor before any module-specific constructor code.
     *
     * The {@code address} parameter must be passed to the super constructor but can be ignored by the module-implementor when writing a module implementation.
     *
     * @param address The address of the native module pointer.
     * @param broker The {@link Broker} to which this module belongs
     * @param configuration The module-specific configuration
     */
    public GatewayModule(long address, Broker broker, String configuration){
        /*Codes_SRS_JAVA_GATEWAY_MODULE_14_002: [ If broker is null the constructor shall throw an IllegalArgumentException. ]*/
        if(broker == null){
            throw new IllegalArgumentException("Broker can not be null.");
        }

        /*Codes_SRS_JAVA_GATEWAY_MODULE_14_001: [ The constructor shall save address, broker, and configuration into class variables. ]*/
        this.create(address, broker, configuration);
    }

    public void create(long moduleAddr, Broker broker, String configuration){
        this._addr = moduleAddr;
        this.broker = broker;
        this.configuration = configuration;
    }

    public void start(){}

    public void receive(byte[] serializedMessage){
        this.receive(new Message(serializedMessage));
    }

    /**
     * Publishes the {@link Message} to the {@link Broker}.
     *
     * @param message The {@link Message} to be published
     * @return 0 on success, non-zero otherwise. See Message broker documentation.
     * @throws IOException If the {@link Message} cannot be serialized.
     */
    public int publish(Message message) throws IOException {
        return this.broker.publishMessage(message, this._addr);
    }

    //Public getter methods

    final public Broker getBroker(){
        return broker;
    }

    /**
     * Gets the JSON configuration string for this {@link GatewayModule}
     * @return The JSON configuration for this {@link GatewayModule}
     */
    final public String getConfiguration(){
        return configuration;
    }
}