/**
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * (the "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
 * specific language governing rights and limitations under the License.
 *
 * The Original Code is "Receiver.java".  Description:
 * "Listens for incoming messages on a certain input stream, and
 * sends them to the appropriate location."
 *
 * The Initial Developer of the Original Code is University Health Network. Copyright (C)
 * 2002.  All Rights Reserved.
 *
 * Contributor(s): _____________.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * GNU General Public License (the  ?GPL?), in which case the provisions of the GPL are
 * applicable instead of those above.  If you wish to allow use of your version of this
 * file only under the terms of the GPL and not to allow others to use your version
 * of this file under the MPL, indicate your decision by deleting  the provisions above
 * and replace  them with the notice and other provisions required by the GPL License.
 * If you do not delete the provisions above, a recipient may use your version of
 * this file under either the MPL or the GPL.
 */
package ca.uhn.hl7v2.app;

import java.util.HashMap;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import ca.uhn.hl7v2.HL7Exception;
import ca.uhn.hl7v2.model.Message;
import ca.uhn.hl7v2.protocol.ApplicationRouter;
import ca.uhn.hl7v2.util.Terser;

/**
 * Routes messages to various Applications based on message type and trigger
 * event. The router is told which Application to which to route various
 * messages by calling the method <code>registerApplication(...)</code>.
 * 
 * @author Bryan Tripp
 * @deprecated Replaced with {@link ApplicationRouter}
 */
public class MessageTypeRouter implements Application,
                ApplicationExceptionHandler {

        private static final Logger log = LoggerFactory
                        .getLogger(MessageTypeRouter.class);
        private Map<String, Application> apps;

        /** Creates a new instance of MessageTypeRouter */
        public MessageTypeRouter() {
                apps = new HashMap<String, Application>(20);
        }

        /**
         * Returns true if at least one application has been registered to accept
         * this type of message. Applications are registered using
         * <code>registerApplication(...)</code>.
         */
        public boolean canProcess(Message in) {
                try {
                        Application match = getMatchingApplication(in);
                        return match != null && match.canProcess(in);
                } catch (Exception e) {
                        return false;
                }
        }

        /**
         * Forwards the given message to any Applications that have been registered
         * to accept messages of that type and trigger event.
         * 
         * @throws ApplicationException
         *             if no such Applications are registered, or if the underlying
         *             Application throws this exception during processing.
         */
        public Message processMessage(Message in) throws ApplicationException {
                try {
                        Application matchingApp = this.getMatchingApplication(in);
                        return matchingApp.processMessage(in);
                } catch (HL7Exception e) {
                        throw new ApplicationException("Error internally routing message: "
                                        + e.toString(), e);
                }
        }

        /**
         * Forwards the given exception to all Applications.
     * TODO this may call itself leading to infinite loops
         */
        public String processException(String incomingMessage,
                        String outgoingMessage, Exception e) throws HL7Exception {
                String outgoingMessageResult = outgoingMessage;
                for (Application app : apps.values()) {
                        if (app instanceof ApplicationExceptionHandler) {
                                ApplicationExceptionHandler aeh = (ApplicationExceptionHandler) app;
                                outgoingMessageResult = aeh.processException(incomingMessage,
                                                outgoingMessageResult, e);
                        }
                }
                return outgoingMessageResult;
        }

        /**
         * Registers the given application to handle messages corresponding to the
         * given type and trigger event. Only one application can be registered for
         * a given message type and trigger event combination. A repeated
         * registration for a particular combination of type and trigger event
         * over-writes the previous one. Use "*" as a wildcard (e.g.
         * registerApplication("ADT", "*", myApp) would register your app for all
         * ADT messages).
         */
        public synchronized void registerApplication(String messageType,
                        String triggerEvent, Application handler) {
                this.apps.put(getKey(messageType, triggerEvent), handler);
                log.info("{} registered to handle {}^{} messages", new Object[] {
                                handler.getClass().getName(), messageType, triggerEvent });
        }

        /**
         * Returns the Applications that has been registered to handle messages of
         * the type and trigger event of the given message, or null if there are
         * none.
         */
        private Application getMatchingApplication(Message message)
                        throws HL7Exception {
                Terser t = new Terser(message);
                String messageType = t.get("/MSH-9-1");
                String triggerEvent = t.get("/MSH-9-2");
                return this.getMatchingApplication(messageType, triggerEvent);
        }

        /**
         * Returns the Applications that has been registered to handle messages of
         * the given type and trigger event, or null if there are none. If there is
         * not an exact match, wildcards ("*") are tried as well.
         */
        private synchronized Application getMatchingApplication(String messageType,
                        String triggerEvent) {
                Application matchingApp = null;
                Application o = this.apps.get(getKey(messageType, triggerEvent));
                if (o == null)
                        o = this.apps.get(getKey(messageType, "*"));
                if (o == null)
                        o = this.apps.get(getKey("*", triggerEvent));
                if (o == null)
                        o = this.apps.get(getKey("*", "*"));
                if (o != null)
                        matchingApp = o;
                return matchingApp;
        }

        /**
         * Creates reproducible hash key.
         */
        private String getKey(String messageType, String triggerEvent) {
                // create hash key string by concatenating type and trigger event
                return messageType + "|" + triggerEvent;
        }

}