org.coos.messaging.BasePluginFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of messaging-lib
The newest version!
/**
 * COOS - Connected Objects Operating System (www.connectedobjects.org).
 *
 * Copyright (C) 2009 Telenor ASA and Tellu AS. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * You may also contact one of the following for additional information:
 * Telenor ASA, Snaroyveien 30, N-1331 Fornebu, Norway (www.telenor.no)
 * Tellu AS, Hagalokkveien 13, N-1383 Asker, Norway (www.tellu.no)
 *//**
 * COOS - Connected Objects Operating System (www.connectedobjects.org).
 *
 * Copyright (C) 2009 Telenor ASA and Tellu AS. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 * You may also contact one of the following for additional information:
 * Telenor ASA, Snaroyveien 30, N-1331 Fornebu, Norway (www.telenor.no)
 * Tellu AS, Hagalokkveien 13, N-1383 Asker, Norway (www.tellu.no)
 */
package org.coos.messaging;

import org.coos.messaging.impl.DefaultChannel;
import org.coos.messaging.util.URIHelper;

import org.coos.util.macro.MacroSubstituteReader;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;

import java.util.Hashtable;

/**
 * This BasePluginFactory has methods for creation of plugins based on method calls
 * 
 * @author Knut Eilif Husa, Tellu AS
 *
 */
public class BasePluginFactory extends COFactory {

    public static final String TCP_TRANSPORT_CLASS = "org.coos.messaging.transport.TCPTransport";
    public static final String SECURE_TRANSPORT_CLASS = "org.coos.messaging.transport.SecureTCPTransport";
    public static final String PLUGIN_CHANNEL_CLASS = "org.coos.messaging.plugin.PluginChannel";

    /**
     * This factory method creates a defined plugin with tcp transport
     * @param name name of endpoint
     * @param className the endpoint implementation class
     * @param properties a set of properties provided for the endpoint
     * @param segment the segment, default is "."
     * @param hostName Ip host name
     * @param port Ip port
     * @param cl the coos container. If not specified a default container is user
     * @return the Plugin
     * @throws Exception
     */
    public static Plugin createPluginWithTCPTransport(String name, String className, Hashtable properties, String segment,
        String hostName, String port, COContainer cl) throws Exception {
        return createPluginWithTCPTransport(name, className, properties, segment, hostName, port, false, cl);
    }

    /**
     * This factory method creates a defined plugin with secure tcp transport
     * @param name name of endpoint
     * @param className the endpoint implementation class
     * @param properties a set of properties provided for the endpoint
     * @param segment the segment, default is "."
     * @param hostName Ip host name
     * @param port Ip port
     * @param cl the coos container. If not specified a default container is user
     * @return the Plugin
     * @throws Exception
     */
    public static Plugin createPluginWithSecureTCPTransport(String name, String className, Hashtable properties, String segment,
        String hostName, String port, COContainer cl) throws Exception {
        return createPluginWithTCPTransport(name, className, properties, segment, hostName, port, true, cl);
    }

    /**
     * This factory method creates a defined plugin with a tcp transport
     * @param name name of endpoint
     * @param className the endpoint implementation class
     * @param properties a set of properties provided for the endpoint
     * @param segment the segment, default is "."
     * @param hostName Ip host name
     * @param port Ip port
     * @param isSecure true if a secure tcp connection is to be created
     * @param cl the coos container. If not specified a default container is user
     * @return the Plugin
     * @throws Exception
     */
    public static Plugin createPluginWithTCPTransport(String name, String className, Hashtable properties, String segment,
        String hostName, String port, boolean isSecure, COContainer cl) throws Exception {

        if (cl != null) {
            cl = new COContainerImpl();
        }

        Plugin plugin = createPluginEndpoint(name, className, properties, segment, cl);
        Channel channel = createPluginChannel(segment, cl);
        plugin.addChannel(channel);

        properties = new Hashtable();
        properties.put("nosslcheck", "true");

        if (hostName != null)
            properties.put("host", hostName);

        if (port != null)
            properties.put("port", port);

        Transport transport;

        if (isSecure) {
            transport = createTransport(SECURE_TRANSPORT_CLASS, properties, cl);
        } else {
            transport = createTransport(TCP_TRANSPORT_CLASS, properties, cl);
        }

        channel.setTransport(transport);

        return plugin;

    }

    protected static Plugin createPluginEndpoint(String name, String className, Hashtable properties, String segment, COContainer cl)
        throws Exception {
        Plugin plugin = new Plugin();

        Class pluginClass = PluginFactory.tryClass(cl, className);
        Endpoint endpoint = (Endpoint) pluginClass.newInstance();
        endpoint.setCoContainer(cl);
        endpoint.setEndpointUri("coos://" + name);

        if (properties == null) {
            properties = new Hashtable();
        }

        endpoint.setProperties(properties);
        plugin.setEndpoint(endpoint);

        URIHelper helper = new URIHelper(endpoint.getEndpointUri());

        if (helper.isEndpointUuid()) {
            endpoint.setEndpointUuid(name);
        }

        endpoint.setName(name);

        if (segment == null) {
            segment = ".";
        }

        return plugin;

    }

    protected static Channel createPluginChannel(String segment, COContainer cl) throws Exception {
        Class channelClass = PluginFactory.tryClass(cl, PLUGIN_CHANNEL_CLASS);
        DefaultChannel channel = (DefaultChannel) channelClass.newInstance();
        channel.addProtocol("coos");
        channel.setCoContainer(cl);

        if (segment == null) {
            segment = ".";
        }

        channel.setSegment(segment);

        return channel;
    }

    protected static Transport createTransport(String className, Hashtable properties, COContainer cl) throws Exception {
        Class transportClass = PluginFactory.tryClass(cl, className);
        Transport transport = (Transport) transportClass.newInstance();
        transport.setProperties(properties);

        return transport;

    }

    private static InputStream substitute(InputStream is) throws IOException {
        InputStreamReader isr = new InputStreamReader(is);
        MacroSubstituteReader msr = new MacroSubstituteReader(isr);
        String substituted = msr.substituteMacros();
        is = new ByteArrayInputStream(substituted.getBytes());

        return is;
    }

    protected static class COContainerImpl implements COContainer {
        public Class loadClass(String className) throws ClassNotFoundException {
            return Class.forName(className);
        }

        public InputStream getResource(String resourceName) throws IOException {
            InputStream is = COContainer.class.getResourceAsStream(resourceName);

            return substitute(is);
        }

        public Object getObject(String name) {
            return null;
        }

        public void start() {
        }

        public void stop() {
        }
    }

}