packetcable-driver/src/main/java/org/umu/cops/prpep/COPSPepDataProcess.java

   1 /*
   2  * Copyright (c) 2004 University of Murcia.  All rights reserved.
   3  * --------------------------------------------------------------
   4  * For more information, please see <http://www.umu.euro6ix.org/>.
   5  */
   6
   7 package org.umu.cops.prpep;
   8
   9 import org.umu.cops.stack.COPSError;
  10
  11 import java.util.Map;
  12
  13 /**
  14  * COPSPepDataProcess process policy data and events.
  15  *
  16  * @version COPSPepDataProcess.java, v 2.00 2004
  17  *
  18  */
  19 public abstract class COPSPepDataProcess {
  20
  21     /**
  22      * Establish PDP decisions
  23      *
  24      * @param man - the state manager
  25      * @param removeDecs - the remove decisions
  26      * @param installDecs - the install decisions
  27      * @param errorDecs - the error decisions
  28      */
  29
  30         public abstract void setDecisions(COPSPepReqStateMan man, Map<String, String> removeDecs,
  31                                       Map<String, String> installDecs, Map<String, String> errorDecs);
  32
  33     /**
  34      *  If the report is fail, return true
  35      *
  36      * @return - t/f
  37      */
  38     public abstract boolean isFailReport(COPSPepReqStateMan man);
  39
  40     /**
  41      * Return Report Data
  42      *
  43      * @return - the report data
  44      */
  45     public abstract Map<String, String> getReportData(COPSPepReqStateMan man);
  46
  47     /**
  48      * Return Client Data
  49      *
  50      * @return - the client data
  51      */
  52     public abstract Map<String, String> getClientData(COPSPepReqStateMan man);
  53
  54     /**
  55      * Return Accounting Data
  56      *
  57      * @return - the accounting data
  58      */
  59     public abstract Map<String, String> getAcctData(COPSPepReqStateMan man);
  60
  61     /**
  62      * Notify the connection closed
  63      */
  64     public abstract void notifyClosedConnection(COPSPepReqStateMan man, COPSError error);
  65
  66     /**
  67      * Notify the KAlive timeout
  68      */
  69     public abstract void notifyNoKAliveReceived(COPSPepReqStateMan man);
  70
  71     /**
  72      * Process a PDP request to close a Request State
  73      *
  74      * @param man       Request State Manager
  75      */
  76     public abstract void closeRequestState(COPSPepReqStateMan man);
  77
  78     /**
  79      * Process a PDP request to open a new Request State
  80      *
  81      * @param man       Request State Manager
  82      */
  83     public abstract void newRequestState(COPSPepReqStateMan man);
  84 }
  85