Refactor PCMM aspects of COPS message data objects.
[packetcable.git] / packetcable-driver / src / main / java / org / pcmm / PCMMPdpConnection.java
index e691721acf26347e88df2934eaa7191279db24a3..f9961c404bb938c7d8795e136de52c8514ec3918 100644 (file)
-/*\r
- @header@\r
- */\r
-\r
-package org.pcmm;\r
-\r
-import org.slf4j.Logger;\r
-import org.slf4j.LoggerFactory;\r
-import org.umu.cops.prpdp.COPSPdpException;\r
-import org.umu.cops.stack.*;\r
-\r
-import java.io.IOException;\r
-import java.net.Socket;\r
-import java.util.Date;\r
-import java.util.Enumeration;\r
-import java.util.Hashtable;\r
-\r
-/**\r
- * Class for managing an provisioning connection at the PDP side.\r
- */\r
-public class PCMMPdpConnection implements Runnable {\r
-\r
-\r
-    public final static Logger logger = LoggerFactory.getLogger(PCMMPdpConnection.class);\r
-\r
-    /**\r
-    Socket connected to PEP\r
-     */\r
-    private Socket _sock;\r
-\r
-    /**\r
-    PEP identifier\r
-    */\r
-    private COPSPepId _pepId;\r
-\r
-    /**\r
-    Time of the latest keep-alive sent\r
-     */\r
-    private Date _lastKa;\r
-\r
-    /**\r
-   Opcode of the latest message sent\r
-    */\r
-    private byte _lastmessage;\r
-\r
-    /**\r
-     *  Time of the latest keep-alive received\r
-     */\r
-    protected Date _lastRecKa;\r
-\r
-    /**\r
-   Maps a Client Handle to a Handler\r
-     */\r
-    protected Hashtable _managerMap;\r
-    // map < String(COPSHandle), COPSPdpHandler> HandlerMap;\r
-\r
-    /**\r
-     *  PDP policy data processor class\r
-     */\r
-    protected PCMMPdpDataProcess _process;\r
-\r
-    /**\r
-   Accounting timer value (secs)\r
-     */\r
-    protected short _acctTimer;\r
-\r
-    /**\r
-   Keep-alive timer value (secs)\r
-     */\r
-    protected short _kaTimer;\r
-\r
-    /**\r
-   COPS error returned by PEP\r
-     */\r
-    protected COPSError _error;\r
-\r
-    /**\r
-     * Creates a new PDP connection\r
-     *\r
-     * @param pepId PEP-ID of the connected PEP\r
-     * @param sock Socket connected to PEP\r
-     * @param process Object for processing policy data\r
-     */\r
-    public PCMMPdpConnection(COPSPepId pepId, Socket sock, PCMMPdpDataProcess process) {\r
-        _sock = sock;\r
-        _pepId = pepId;\r
-\r
-        _lastKa = new Date();\r
-        _lastmessage = COPSHeader.COPS_OP_OPN;\r
-        _managerMap = new Hashtable(20);\r
-\r
-        _kaTimer = 120;\r
-        _process = process;\r
-    }\r
-\r
-    /**\r
-     * Gets the time of that latest keep-alive sent\r
-     * @return Time of that latest keep-alive sent\r
-     */\r
-    public Date getLastKAlive() {\r
-        return _lastKa;\r
-    }\r
-\r
-    /**\r
-     * Sets the keep-alive timer value\r
-     * @param kaTimer Keep-alive timer value (secs)\r
-     */\r
-    public void setKaTimer(short kaTimer) {\r
-        _kaTimer = kaTimer;\r
-    }\r
-\r
-    /**\r
-     * Gets the keep-alive timer value\r
-     * @return Keep-alive timer value (secs)\r
-     */\r
-    public short getKaTimer() {\r
-        return _kaTimer;\r
-    }\r
-\r
-    /**\r
-     * Sets the accounting timer value\r
-     * @param acctTimer Accounting timer value (secs)\r
-     */\r
-    public void setAccTimer(short acctTimer) {\r
-        _acctTimer = acctTimer;\r
-    }\r
-\r
-    /**\r
-     * Gets the accounting timer value\r
-     * @return Accounting timer value (secs)\r
-     */\r
-    public short getAcctTimer() {\r
-        return _acctTimer;\r
-    }\r
-\r
-    /**\r
-     * Gets the latest COPS message\r
-     * @return   Code of the latest message sent\r
-     */\r
-    public byte getLastMessage() {\r
-        return _lastmessage;\r
-    }\r
-\r
-    /**\r
-     * Gets active handles\r
-     * @return   An <tt>Enumeration</tt> holding all active handles\r
-     */\r
-    public Enumeration getHandles() {\r
-        return _managerMap.keys();\r
-    }\r
-\r
-    /**\r
-     * Gets the handle map\r
-     * @return   A <tt>Hashtable</tt> holding the handle map\r
-     */\r
-    public Hashtable getReqStateMans() {\r
-        return _managerMap;\r
-    }\r
-\r
-    /**\r
-     * Gets the PEP-ID\r
-     * @return   The ID of the PEP, as a <tt>String</tt>\r
-     */\r
-    public String getPepId() {\r
-        return _pepId.getData().str();\r
-    }\r
-\r
-    /**\r
-     * Checks whether the socket to the PEP is closed or not\r
-     * @return   <tt>true</tt> if closed, <tt>false</tt> otherwise\r
-     */\r
-    public boolean isClosed() {\r
-        return _sock.isClosed();\r
-    }\r
-\r
-    /**\r
-     * Closes the socket to the PEP\r
-     * @throws IOException\r
-     */\r
-    protected void close()\r
-    throws IOException {\r
-        _sock.close();\r
-    }\r
-\r
-    /**\r
-     * Gets the socket to the PEP\r
-     * @return   Socket connected to the PEP\r
-     */\r
-    public Socket getSocket() {\r
-        return _sock;\r
-    }\r
-\r
-    /**\r
-     * Main loop\r
-     */\r
-    public void run () {\r
-        Date _lastSendKa = new Date();\r
-        _lastRecKa = new Date();\r
-        try {\r
-            while (!_sock.isClosed()) {\r
-                if (_sock.getInputStream().available() != 0) {\r
-                    _lastmessage = processMessage(_sock);\r
-                    _lastRecKa = new Date();\r
-                }\r
-\r
-                // Keep Alive\r
-                if (_kaTimer > 0) {\r
-                    // Timeout at PDP\r
-                    int _startTime = (int) (_lastRecKa.getTime());\r
-                    int cTime = (int) (new Date().getTime());\r
-\r
-                    if ((int)(cTime - _startTime) > _kaTimer*1000) {\r
-                        _sock.close();\r
-                        // Notify all Request State Managers\r
-                        notifyNoKAAllReqStateMan();\r
-                    }\r
-\r
-                    // Send to PEP\r
-                    _startTime = (int) (_lastSendKa.getTime());\r
-                    cTime = (int) (new Date().getTime());\r
-\r
-                    if ((cTime - _startTime) > ((_kaTimer * 3/4) * 1000)) {\r
-                        COPSHeader hdr = new COPSHeader(COPSHeader.COPS_OP_KA);\r
-                        COPSKAMsg msg = new COPSKAMsg();\r
-\r
-                        msg.add(hdr);\r
-\r
-                        COPSTransceiver.sendMsg(msg, _sock);\r
-                        _lastSendKa = new Date();\r
-                    }\r
-                }\r
-\r
-                try {\r
-                    Thread.sleep(500);\r
-                } catch (Exception e) {\r
-                    logger.error("Unexpected exception while sleeping", e);\r
-                }\r
-\r
-            }\r
-        } catch (Exception e) {\r
-            logger.error("Error reading messages from socket", e);\r
-        }\r
-\r
-        // connection closed by server\r
-        // COPSDebug.out(getClass().getName(),"Connection closed by client");\r
-        try {\r
-            _sock.close();\r
-        } catch (IOException e) {\r
-            logger.error("Error closing socket", e);\r
-        }\r
-\r
-        // Notify all Request State Managers\r
-        try {\r
-            notifyCloseAllReqStateMan();\r
-        } catch (COPSPdpException e) {\r
-            logger.error("Error closing state managers", e);\r
-        }\r
-    }\r
-\r
-    /**\r
-     * Gets a COPS message from the socket and processes it\r
-     * @param    conn Socket connected to the PEP\r
-     * @return Type of COPS message\r
-     */\r
-    private byte processMessage(Socket conn)\r
-    throws COPSPdpException, COPSException, IOException {\r
-        COPSMsg msg = COPSTransceiver.receiveMsg(conn);\r
-\r
-        if (msg.getHeader().isAClientClose()) {\r
-            handleClientCloseMsg(conn, msg);\r
-            return COPSHeader.COPS_OP_CC;\r
-        } else if (msg.getHeader().isAKeepAlive()) {\r
-            handleKeepAliveMsg(conn, msg);\r
-            return COPSHeader.COPS_OP_KA;\r
-        } else if (msg.getHeader().isARequest()) {\r
-            handleRequestMsg(conn, msg);\r
-            return COPSHeader.COPS_OP_REQ;\r
-        } else if (msg.getHeader().isAReport()) {\r
-            handleReportMsg(conn, msg);\r
-            return COPSHeader.COPS_OP_RPT;\r
-        } else if (msg.getHeader().isADeleteReq()) {\r
-            handleDeleteRequestMsg(conn, msg);\r
-            return COPSHeader.COPS_OP_DRQ;\r
-        } else if (msg.getHeader().isASyncComplete()) {\r
-            handleSyncComplete(conn, msg);\r
-            return COPSHeader.COPS_OP_SSC;\r
-        } else {\r
-            throw new COPSPdpException("Message not expected (" + msg.getHeader().getOpCode() + ").");\r
-        }\r
-    }\r
-\r
-    /**\r
-     * Handle Client Close Message, close the passed connection\r
-     *\r
-     * @param    conn                a  Socket\r
-     * @param    msg                 a  COPSMsg\r
-     *\r
-     *\r
-     * <Client-Close> ::= <Common Header>\r
-     *  <Error>\r
-     *  [<Integrity>]\r
-     *\r
-     * Not support [<Integrity>]\r
-     *\r
-     */\r
-    private void handleClientCloseMsg(Socket conn, COPSMsg msg) {\r
-        COPSClientCloseMsg cMsg = (COPSClientCloseMsg) msg;\r
-        _error = cMsg.getError();\r
-\r
-        // COPSDebug.out(getClass().getName(),"Got close request, closing connection " +\r
-        //  conn.getInetAddress() + ":" + conn.getPort() + ":[Error " + _error.getDescription() + "]");\r
-\r
-        try {\r
-            // Support\r
-            if (cMsg.getIntegrity() != null) {\r
-                logger.error("Unsupported objects (Integrity) to connection " + conn.getInetAddress());\r
-            }\r
-\r
-            conn.close();\r
-        } catch (Exception unae) {\r
-            logger.error("Unexpected exception closing connection", unae);\r
-        }\r
-    }\r
-\r
-    /**\r
-     * Gets the occurred COPS Error\r
-     * @return   <tt>COPSError</tt> object\r
-     */\r
-    protected COPSError getError()  {\r
-        return _error;\r
-    }\r
-\r
-    /**\r
-     * Handle Keep Alive Message\r
-     *\r
-     * <Keep-Alive> ::= <Common Header>\r
-     *                  [<Integrity>]\r
-     *\r
-     * Not support [<Integrity>]\r
-     *\r
-     * @param    conn                a  Socket\r
-     * @param    msg                 a  COPSMsg\r
-     *\r
-     */\r
-    private void handleKeepAliveMsg(Socket conn, COPSMsg msg) {\r
-        COPSKAMsg cMsg = (COPSKAMsg) msg;\r
-\r
-        COPSKAMsg kaMsg = (COPSKAMsg) msg;\r
-        try {\r
-            // Support\r
-            if (cMsg.getIntegrity() != null) {\r
-                logger.error("Unsupported objects (Integrity) to connection " + conn.getInetAddress());\r
-            }\r
-\r
-            kaMsg.writeData(conn);\r
-        } catch (Exception unae) {\r
-            logger.error("Unexpected exception while writing keep-alive message", unae);\r
-        }\r
-    }\r
-\r
-    /**\r
-     * Handle Delete Request Message\r
-     *\r
-     * <Delete Request> ::= <Common Header>\r
-     *                      <Client Handle>\r
-     *                      <Reason>\r
-     *                      [<Integrity>]\r
-     *\r
-     * Not support [<Integrity>]\r
-     *\r
-     * @param    conn                a  Socket\r
-     * @param    msg                 a  COPSMsg\r
-     *\r
-     */\r
-    private void handleDeleteRequestMsg(Socket conn, COPSMsg msg)\r
-    throws COPSPdpException {\r
-        COPSDeleteMsg cMsg = (COPSDeleteMsg) msg;\r
-        // COPSDebug.out(getClass().getName(),"Removing ClientHandle for " +\r
-        //  conn.getInetAddress() + ":" + conn.getPort() + ":[Reason " + cMsg.getReason().getDescription() + "]");\r
-\r
-        // Support\r
-        if (cMsg.getIntegrity() != null) {\r
-            logger.error("Unsupported objects (Integrity) to connection " + conn.getInetAddress());\r
-        }\r
-\r
-        // Delete clientHandler\r
-        if (_managerMap.remove(cMsg.getClientHandle().getId().str()) == null) {\r
-            // COPSDebug.out(getClass().getName(),"Missing for ClientHandle " +\r
-            //  cMsg.getClientHandle().getId().getData());\r
-        }\r
-\r
-        PCMMPdpReqStateMan man = (PCMMPdpReqStateMan) _managerMap.get(cMsg.getClientHandle().getId().str());\r
-        if (man == null) {\r
-            logger.warn("State manager not found");\r
-        } else {\r
-            man.processDeleteRequestState(cMsg);\r
-        }\r
-\r
-    }\r
-\r
-    /**\r
-     * Handle Request Message\r
-     *\r
-     * <Request> ::= <Common Header>\r
-     *  <Client Handle>\r
-     *  <Context>\r
-     *  *(<Named ClientSI>)\r
-     *  [<Integrity>]\r
-     * <Named ClientSI> ::= <*(<PRID> <EPD>)>\r
-     *\r
-     * Not support [<Integrity>]\r
-     *\r
-     * @param    conn                a  Socket\r
-     * @param    msg                 a  COPSMsg\r
-     *\r
-     */\r
-    private void handleRequestMsg(Socket conn, COPSMsg msg)\r
-    throws COPSPdpException {\r
-\r
-        COPSReqMsg reqMsg = (COPSReqMsg) msg;\r
-        COPSContext cntxt = reqMsg.getContext();\r
-        COPSHeader header = reqMsg.getHeader();\r
-        //short reqType = cntxt.getRequestType();\r
-        short cType   = header.getClientType();\r
-\r
-        // Support\r
-        if (reqMsg.getIntegrity() != null) {\r
-            logger.error("Unsupported objects (Integrity) to connection " + conn.getInetAddress());\r
-        }\r
-\r
-        PCMMPdpReqStateMan man;\r
-        man = (PCMMPdpReqStateMan) _managerMap.get(reqMsg.getClientHandle().getId().str());\r
-        if (man == null) {\r
-\r
-            man = new PCMMPdpReqStateMan(cType, reqMsg.getClientHandle().getId().str());\r
-            _managerMap.put(reqMsg.getClientHandle().getId().str(),man);\r
-            man.setDataProcess(_process);\r
-            man.initRequestState(_sock);\r
-\r
-            // COPSDebug.out(getClass().getName(),"createHandler called, clientType=" +\r
-            //    header.getClientType() + " msgType=" +\r
-            //    cntxt.getMessageType() + ", connId=" + conn.toString());\r
-        }\r
-\r
-        man.processRequest(reqMsg);\r
-    }\r
-\r
-    /**\r
-     * Handle Report Message\r
-     *\r
-     * <Report State> ::= <Common Header>\r
-     *  <Client Handle>\r
-     *  <Report Type>\r
-     *  *(<Named ClientSI>)\r
-     *  [<Integrity>]\r
-     *\r
-     * Not support [<Integrity>]\r
-     *\r
-     * @param    conn                a  Socket\r
-     * @param    msg                 a  COPSMsg\r
-     *\r
-     */\r
-    private void handleReportMsg(Socket conn, COPSMsg msg)\r
-    throws COPSPdpException {\r
-        COPSReportMsg repMsg = (COPSReportMsg) msg;\r
-        // COPSHandle handle = repMsg.getClientHandle();\r
-        // COPSHeader header = repMsg.getHeader();\r
-\r
-        // Support\r
-        if (repMsg.getIntegrity() != null) {\r
-            logger.error("Unsupported objects (Integrity) to connection " + conn.getInetAddress());\r
-        }\r
-\r
-        PCMMPdpReqStateMan man = (PCMMPdpReqStateMan) _managerMap.get(repMsg.getClientHandle().getId().str());\r
-        if (man == null) {\r
-            logger.warn("State manager not found");\r
-        } else {\r
-            man.processReport(repMsg);\r
-        }\r
-    }\r
-\r
-    /**\r
-     * Method handleSyncComplete\r
-     *\r
-     * @param    conn                a  Socket\r
-     * @param    msg                 a  COPSMsg\r
-     *\r
-     */\r
-    private void handleSyncComplete(Socket conn, COPSMsg msg)\r
-    throws COPSPdpException {\r
-        COPSSyncStateMsg cMsg = (COPSSyncStateMsg) msg;\r
-        // COPSHandle handle = cMsg.getClientHandle();\r
-        // COPSHeader header = cMsg.getHeader();\r
-\r
-        // Support\r
-        if (cMsg.getIntegrity() != null) {\r
-            logger.error("Unsupported objects (Integrity) to connection " + conn.getInetAddress());\r
-        }\r
-\r
-        PCMMPdpReqStateMan man = (PCMMPdpReqStateMan) _managerMap.get(cMsg.getClientHandle().getId().str());\r
-        if (man == null) {\r
-            logger.warn("State manager not found");\r
-        } else {\r
-            man.processSyncComplete(cMsg);\r
-        }\r
-    }\r
-\r
-    /**\r
-     * Requests a COPS sync from the PEP\r
-     * @throws COPSException\r
-     * @throws COPSPdpException\r
-     */\r
-    protected void syncAllRequestState()\r
-    throws COPSException, COPSPdpException {\r
-        if (_managerMap.size() > 0) {\r
-            for (Enumeration e = _managerMap.keys() ; e.hasMoreElements() ;) {\r
-                String handle = (String) e.nextElement();\r
-                PCMMPdpReqStateMan man = (PCMMPdpReqStateMan) _managerMap.get(handle);\r
-\r
-                man.syncRequestState();\r
-            }\r
-        }\r
-    }\r
-\r
-    private void notifyCloseAllReqStateMan()\r
-    throws COPSPdpException {\r
-        if (_managerMap.size() > 0) {\r
-            for (Enumeration e = _managerMap.keys() ; e.hasMoreElements() ;) {\r
-                String handle = (String) e.nextElement();\r
-                PCMMPdpReqStateMan man = (PCMMPdpReqStateMan) _managerMap.get(handle);\r
-\r
-                man.processClosedConnection(_error);\r
-            }\r
-        }\r
-    }\r
-\r
-    private void notifyNoKAAllReqStateMan()\r
-    throws COPSPdpException {\r
-        if (_managerMap.size() > 0) {\r
-            for (Enumeration e = _managerMap.keys() ; e.hasMoreElements() ;) {\r
-                String handle = (String) e.nextElement();\r
-                PCMMPdpReqStateMan man = (PCMMPdpReqStateMan) _managerMap.get(handle);\r
-\r
-                man.processNoKAConnection();\r
-            }\r
-        }\r
-    }\r
-\r
-}\r
+/*
+ @header@
+ */
+
+package org.pcmm;
+
+import org.umu.cops.prpdp.COPSPdpConnection;
+import org.umu.cops.prpdp.COPSPdpReqStateMan;
+import org.umu.cops.stack.COPSPepId;
+import org.umu.cops.stack.COPSReqMsg;
+
+import javax.annotation.concurrent.ThreadSafe;
+import java.net.Socket;
+
+/**
+ * Class for managing an provisioning connection at the PDP side for receiving and brokering out COPS messages.
+ */
+@ThreadSafe
+public class PCMMPdpConnection extends COPSPdpConnection {
+
+    /**
+     *  PDP policy data processor class
+     */
+    protected final PCMMPdpDataProcess _thisProcess;
+
+    /**
+     * Creates a new PDP connection
+     *
+     * @param pepId PEP-ID of the connected PEP
+     * @param sock Socket connected to PEP
+     * @param process Object for processing policy data
+     */
+    public PCMMPdpConnection(final COPSPepId pepId, final Socket sock, final PCMMPdpDataProcess process,
+                             final short kaTimer, final short acctTimer) {
+        super(pepId, sock, process, kaTimer, acctTimer);
+        _thisProcess = process;
+    }
+
+    /**
+     * Returns an instance of a COPSPdpReqStateMan
+     * @param reqMsg - the request on which to create the state manager
+     * @return - the state manager
+     */
+    protected COPSPdpReqStateMan createStateManager(final COPSReqMsg reqMsg) {
+        return new PCMMPdpReqStateMan(reqMsg.getHeader().getClientType(), reqMsg.getClientHandle(), _thisProcess,
+                _sock);
+    }
+
+}