Add missing license headers to packetcable-driver pcmm
[packetcable.git] / packetcable-driver / src / main / java / org / pcmm / PCMMPdpDataProcess.java
index 34d086a46e1419589a50e36de0664a289a3385b6..dfcda5324ab39bae156b64240ba5b65d212c2f39 100644 (file)
-/**
- @header@
+/*
+ * Copyright (c) 2014, 2015 Cable Television Laboratories, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
 
 package org.pcmm;
 
-import org.pcmm.gates.ITransactionID;
+import org.pcmm.gates.ITransactionID.GateCommandType;
 import org.pcmm.gates.impl.PCMMGateReq;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.umu.cops.COPSStateMan;
+import org.umu.cops.prpdp.COPSPdpDataProcess;
+import org.umu.cops.prpdp.COPSPdpReqStateMan;
 import org.umu.cops.stack.COPSError;
 
-import java.util.Hashtable;
+import java.util.HashMap;
+import java.util.Map;
 
 
-public class PCMMPdpDataProcess { // extends COPSPdpDataProcess
+public class PCMMPdpDataProcess implements COPSPdpDataProcess {
 
-    public final static Logger logger = LoggerFactory.getLogger(PCMMPdpAgent.class);
+    public final static Logger logger = LoggerFactory.getLogger(PCMMPdpDataProcess.class);
 
-    private Hashtable installPolicy;
-    private Hashtable removePolicy;
-
-    public PCMMPdpDataProcess() {
+    @Override
+    public Map getRemovePolicy(final COPSPdpReqStateMan man) {
+        logger.info("Retrieving the remove policy");
+        // TODO - Implement me
+        return new HashMap();
     }
 
-    /**
-     * PDPAgent gets the policies to delete from PEP
-     *
-     * @param man
-     * @return
-     */
-    public Hashtable getRemovePolicy(PCMMPdpReqStateMan man) {
-        return removePolicy;
+    @Override
+    public Map getInstallPolicy(final COPSPdpReqStateMan man) {
+        logger.info("Retrieving the remove policy");
+        // TODO - Implement me
+        return new HashMap();
     }
 
-    /**
-     * PDPAgent gets the policies to be installed in PEP
-     *
-     * @param man
-     * @return
-     */
-    public Hashtable getInstallPolicy(PCMMPdpReqStateMan man) {
-        return installPolicy;
+    @Override
+    public void setClientData(final COPSPdpReqStateMan man, final Map<String, String> reqSIs) {
+        logger.info("Setting the client data");
+        // TODO - Implement me
     }
 
     /**
-     * PEP configuration items for sending inside the request
-     *
-     * @param man
-     * @param reqSIs
+     * Fail report received
+     * @param man - the state manager
+     * @param gateMsg - the gate request message
      */
-    public void setClientData(PCMMPdpReqStateMan man, Hashtable reqSIs) {
-
-        logger.info("Request Info");
-        /*
-                for (Enumeration e = reqSIs.keys() ; e.hasMoreElements() ;) {
-                    String strprid = (String) e.nextElement();
-                    String strepd = (String) reqSIs.get(strprid);
-
-                    // Check PRID-EPD
-                    // ....
-                    System.out.println(getClass().getName() + ": " + "PRID: " + strprid);
-                    System.out.println(getClass().getName() + ": " + "EPD: " + strepd);
-                }
-
-                // Create policies to be deleted
-                // ....
-
-                // Create policies to be installed
-                String prid = new String("<XPath>");
-                String epd = new String("<?xml this is an XML policy>");
-                installPolicy.put(prid, epd);
-        */
+    public void failReport(final COPSPdpReqStateMan man, final PCMMGateReq gateMsg) {
+        logger.info("Fail Report notified with error - " + gateMsg.getError().toString());
+        // TODO - Implement me
     }
 
-    /**
-     * Fail report received
-     *
-     * @param man
-     * @param gateMsg
-     */
-    public void failReport(PCMMPdpReqStateMan man, PCMMGateReq gateMsg) {
+    @Override
+    public void failReport(final COPSPdpReqStateMan man, final Map<String, String> reportSIs) {
+        logger.info("Fail report notified");
+        // TODO - Implement me
+    }
 
-        logger.info("Fail Report notified with error - " + gateMsg.getError().toString());
-        /*
-
-                System.out.println(getClass().getName() + ": " + "Report Info");
-                for (Enumeration e = reportSIs.keys() ; e.hasMoreElements() ;) {
-                    String strprid = (String) e.nextElement();
-                    String strepd = (String) reportSIs.get(strprid);
-
-                    // Check PRID-EPD
-                    // ....
-                    System.out.println(getClass().getName()+ ": " + "PRID: " + strprid);
-                    System.out.println(getClass().getName()+ ": " + "EPD: " + strepd);
-                }
-        */
+    @Override
+    public void successReport(final COPSPdpReqStateMan man, final Map<String, String> reportSIs) {
+        logger.info("Success report notified");
+        // TODO - Implement me
     }
 
     /**
      * Positive report received
-     *
-     * @param man
-     * @param gateMsg
+     * @param man - the state manager
+     * @param gateMsg - the gate request message
      */
-    public void successReport(PCMMPdpReqStateMan man, PCMMGateReq gateMsg) {
+    public void successReport(final COPSPdpReqStateMan man, final PCMMGateReq gateMsg) {
         logger.info("Success Report notified.");
 
-        if ( gateMsg.getTransactionID().getGateCommandType() == ITransactionID.GateDeleteAck ) {
+        if ( gateMsg.getTransactionID().getGateCommandType().equals(GateCommandType.GATE_DELETE_ACK)) {
             logger.info("GateDeleteAck: GateID = " + gateMsg.getGateID().getGateID());
             if (gateMsg.getGateID().getGateID() == PCMMGlobalConfig.getGateID1())
                 PCMMGlobalConfig.setGateID1(0);
@@ -114,95 +83,58 @@ public class PCMMPdpDataProcess { // extends COPSPdpDataProcess
                 PCMMGlobalConfig.setGateID2(0);
 
         }
-        if ( gateMsg.getTransactionID().getGateCommandType() == ITransactionID.GateSetAck ) {
+        if ( gateMsg.getTransactionID().getGateCommandType().equals(GateCommandType.GATE_SET_ACK)) {
             logger.info("GateSetAck : GateID = " + gateMsg.getGateID().getGateID());
             if (0 == PCMMGlobalConfig.getGateID1())
                 PCMMGlobalConfig.setGateID1(gateMsg.getGateID().getGateID());
             if (0 == PCMMGlobalConfig.getGateID2())
                 PCMMGlobalConfig.setGateID2(gateMsg.getGateID().getGateID());
         }
-
-        /*
-                System.out.println(getClass().getName()+ ": " + "Report Info");
-                for (Enumeration e = reportSIs.keys() ; e.hasMoreElements() ;) {
-                    String strprid = (String) e.nextElement();
-                    String strepd = (String) reportSIs.get(strprid);
-
-                    // Check PRID-EPD
-                    // ....
-                    System.out.println(getClass().getName()+ ": " + "PRID: " + strprid);
-                    System.out.println(getClass().getName()+ ": " + "EPD: " + strepd);
-                }
-        */
-
     }
 
     /**
      * Accounting report received
-     *
-     * @param man
-     * @param gateMsg
+     * @param man - the state manager
+     * @param gateMsg - the gate request message
      */
-    public void acctReport(PCMMPdpReqStateMan man, PCMMGateReq gateMsg) {
+    public void acctReport(final PCMMPdpReqStateMan man, final PCMMGateReq gateMsg) {
         logger.info("Acct Report notified.");
+        // TODO - Impelement me
+    }
 
-        /*
-                System.out.println(getClass().getName()+ ": " + "Report Info");
-                for (Enumeration e = reportSIs.keys() ; e.hasMoreElements() ;) {
-                    String strprid = (String) e.nextElement();
-                    String strepd = (String) reportSIs.get(strprid);
-
-                    // Check PRID-EPD
-                    // ....
-                    System.out.println(getClass().getName()+ ": " + "PRID: " + strprid);
-                    System.out.println(getClass().getName()+ ": " + "EPD: " + strepd);
-                }
-        */
+    @Override
+    public void acctReport (final COPSPdpReqStateMan man, final Map reportSIs) {
+        logger.info("Acct Report notified.");
+        // TODO - had to implement but do not know what to do here
     }
 
-    /**
-     * Notifies that an Accounting report is missing
-     *
-     * @param man
-     */
-    public void notifyNoAcctReport(PCMMPdpReqStateMan man) {
-        //To change body of implemented methods use File | Settings | File Templates.
+    @Override
+    public void notifyNoAcctReport(final COPSPdpReqStateMan man) {
+        logger.info("No Acct Report notified.");
+        // TODO - Impelement me
     }
 
-    /**
-     * Notifies that a KeepAlive message is missing
-     *
-     * @param man
-     */
-    public void notifyNoKAliveReceived(PCMMPdpReqStateMan man) {
-        //To change body of implemented methods use File | Settings | File Templates.
+    @Override
+    public void notifyNoKAliveReceived(final COPSStateMan man) {
+        logger.info("Notify No K alive received.");
+        // TODO - Impelement me
     }
 
-    /**
-     * PEP closed the connection
-     *
-     * @param man
-     * @param error
-     */
-    public void notifyClosedConnection(PCMMPdpReqStateMan man, COPSError error) {
+    @Override
+    public void notifyClosedConnection(final COPSStateMan man, final COPSError error) {
         logger.info("Connection was closed by PEP");
+        // TODO - Implement me
     }
 
-    /**
-     * Delete request state received
-     *
-     * @param man
-     */
-    public void notifyDeleteRequestState(PCMMPdpReqStateMan man) {
-        //To change body of implemented methods use File | Settings | File Templates.
+    @Override
+    public void notifyDeleteRequestState(final COPSPdpReqStateMan man) {
+        logger.info("Delete request state notified");
+        // TODO - Impelement me
     }
 
-    /**
-     * Closes request state
-     *
-     * @param man
-     */
-    public void closeRequestState(PCMMPdpReqStateMan man) {
-        //To change body of implemented methods use File | Settings | File Templates.
+    @Override
+    public void closeRequestState(final COPSStateMan man) {
+        logger.info("Close request state notified");
+        // TODO - Impelement me
     }
 }