gerrit.onap Code Review - policy/apex-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.service.engine.engdep;
  22
  23 import java.net.InetSocketAddress;
  24
  25 import org.onap.policy.apex.core.infrastructure.messaging.MessagingService;
  26 import org.onap.policy.apex.core.infrastructure.messaging.MessagingServiceFactory;
  27 import org.onap.policy.apex.core.infrastructure.messaging.util.MessagingUtils;
  28 import org.onap.policy.apex.core.protocols.Message;
  29 import org.onap.policy.apex.service.engine.runtime.EngineService;
  30 import org.slf4j.ext.XLogger;
  31 import org.slf4j.ext.XLoggerFactory;
  32
  33 /**
  34  * The Class EngDepMessagingService is used to encapsulate the server side of EngDep communication. This class allows
  35  * users to create and start an EngDep server.
  36  *
  37  * @author Liam Fallon (liam.fallon@ericsson.com)
  38  */
  39 public class EngDepMessagingService {
  40     private static final XLogger LOGGER = XLoggerFactory.getXLogger(EngDepMessagingService.class);
  41
  42     private final MessagingService<Message> messageService;
  43
  44     // The listener that is listening for messages coming in on the EngDep protocol from clients
  45     private final EngDepMessageListener messageListener;
  46
  47     /**
  48      * Instantiates a new EngDep messaging service. It creates the message service instance, a listener for incoming
  49      * messages, and starts the message listener thread for handling incoming messages.
  50      *
  51      * @param service the Apex engine service that this EngDep service is running for
  52      * @param port the port The port to use for EngDep communication
  53      */
  54     public EngDepMessagingService(final EngineService service, final int port) {
  55         LOGGER.entry(service);
  56
  57         // Create the service and listener and add the listener.
  58         messageService = getMessageService(port);
  59         messageListener = new EngDepMessageListener(service);
  60         messageService.addMessageListener(messageListener);
  61
  62         // Start incoming message processing on the listener
  63         messageListener.startProcessorThread();
  64         LOGGER.exit();
  65     }
  66
  67     /**
  68      * Start the server, open the communication mechanism for connections.
  69      */
  70     public void start() {
  71         LOGGER.info("engine<-->deployment messaging starting . . .");
  72         messageService.startConnection();
  73         LOGGER.info("engine<-->deployment messaging started");
  74     }
  75
  76     /**
  77      * Start the server, close the communication mechanism.
  78      */
  79     public void stop() {
  80         LOGGER.info("engine<-->deployment messaging stopping . . .");
  81         messageService.stopConnection();
  82         messageListener.stopProcessorThreads();
  83         LOGGER.info("engine<-->deployment messaging stopped");
  84     }
  85
  86     /**
  87      * Is the server started?.
  88      *
  89      * @return true, if checks if is started
  90      */
  91     public boolean isStarted() {
  92         return messageService.isStarted();
  93     }
  94
  95     /**
  96      * Is the server stopped?.
  97      *
  98      * @return true, if checks if is stopped
  99      */
 100     public boolean isStopped() {
 101         return !messageService.isStarted();
 102     }
 103
 104     /**
 105      * Get a message service instance. This method is protected so that it can be intercepted in unit test.
 106      * @param port the message service port
 107      * @return the message service
 108      */
 109     protected MessagingService<Message> getMessageService(final int port) {
 110         // Messaging service is used to transmit and receive messages over a communication protocol
 111         MessagingServiceFactory<Message> factory = new MessagingServiceFactory<>();
 112         return factory.createServer(new InetSocketAddress(MessagingUtils.checkPort(port)));
 113     }
 114 }