X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fsrc%2Fmain%2Fjava%2Forg%2Foransc%2Fpolicyagent%2Fdmaap%2FDmaapMessageConsumer.java;h=889dfafaaee5c8bdec2d24aa1e751145f2e3d534;hb=7ff95e760df22a5b6e6a77b8f7b906ab0e2a55b6;hp=42be12d3a329bca4434b4c352f81d0d21ca30427;hpb=e8c7fa0b02b0918b3b56a1fc162968a3eef282dc;p=nonrtric.git diff --git a/policy-agent/src/main/java/org/oransc/policyagent/dmaap/DmaapMessageConsumer.java b/policy-agent/src/main/java/org/oransc/policyagent/dmaap/DmaapMessageConsumer.java index 42be12d3..889dfafa 100644 --- a/policy-agent/src/main/java/org/oransc/policyagent/dmaap/DmaapMessageConsumer.java +++ b/policy-agent/src/main/java/org/oransc/policyagent/dmaap/DmaapMessageConsumer.java @@ -1,22 +1,63 @@ -package org.oransc.policyagent.dmaap; - -import java.util.Properties; -/** - * The Dmaap consumer which has the base methods to be implemented by any class - * which implements this interface +/*- + * ========================LICENSE_START================================= + * O-RAN-SC + * %% + * Copyright (C) 2019 Nordix Foundation + * %% + * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ========================LICENSE_END=================================== */ -public interface DmaapMessageConsumer extends Runnable { - - public void init(Properties baseProperties); - - public abstract void processMsg(String msg) throws Exception; - public boolean isReady(); - - public boolean isRunning(); +package org.oransc.policyagent.dmaap; - public void stopConsumer(); +/** + * The Dmaap consumer which has the base methods to be implemented by any class which implements this interface + * + */ +public interface DmaapMessageConsumer { + + /** + * The init method creates the MRConsumer with the properties passed from the Application Config + * + * @param properties + */ + public void init(); + + /** + * This method process the message and call the respective Controller + * + * @param msg + * @throws Exception + */ + public abstract void processMsg(String msg) throws Exception; + + /** + * To check whether the DMAAP Listner is alive + * + * @return boolean + */ + public boolean isAlive(); + + /** + * To Stop the DMAAP Listener + */ + public void stopConsumer(); + + /** + * It's a infinite loop run every configured seconds to fetch the message from DMAAP. This method can be stop by + * setting the alive flag to false + */ + public void run(); }