eap_policy.hxx

/* BEGIN_COPYRIGHT                                                        */
/*                                                                        */
/* Open Diameter: Open-source software for the Diameter and               */
/*                Diameter related protocols                              */
/*                                                                        */
/* Copyright (C) 2002-2004 Open Diameter Project                          */
/*                                                                        */
/* This library is free software; you can redistribute it and/or modify   */
/* it under the terms of the GNU Lesser General Public License as         */
/* published by the Free Software Foundation; either version 2.1 of the   */
/* License, or (at your option) any later version.                        */
/*                                                                        */
/* This library is distributed in the hope that it will be useful,        */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of         */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU      */
/* Lesser General Public License for more details.                        */
/*                                                                        */
/* You should have received a copy of the GNU Lesser General Public       */
/* License along with this library; if not, write to the Free Software    */
/* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307    */
/* USA.                                                                   */
/*                                                                        */
/* In addition, when you copy and redistribute some or the entire part of */
/* the source code of this software with or without modification, you     */
/* MUST include this copyright notice in each copy.                       */
/*                                                                        */
/* If you make any changes that are appeared to be useful, please send    */
/* sources that include the changed part to                               */
/* diameter-developers@lists.sourceforge.net so that we can reflect your  */
/* changes to one unified version of this software.                       */
/*                                                                        */
/* END_COPYRIGHT                                                          */
// $Id: eap_policy.hxx,v 1.11 2004/06/17 21:13:36 yohba Exp $

// eap_policy.hxx:  header file for EAP policy
// Written by Yoshihiro Ohba

#ifndef __EAP_POLICY_HXX__
#define __EAP_POLICY_HXX__

#include <ace/Singleton.h>
#include "eap.hxx"

class EAP_EXPORTS EapPolicyElement
{
  friend class EapPolicy;
public:
  enum PolicyType {
    FinalSuccess,  
    FinalFailure,  
    Continued      
  };

  inline bool IsContinued() 
  { 
    if (policyType==Continued) return true;
    return false;
  }
protected:
  EapPolicyElement(PolicyType t) : policyType(t) {}
  PolicyType policyType;
};

class EAP_EXPORTS EapSuccessPolicyElement : public EapPolicyElement
{
public:
  EapSuccessPolicyElement() : EapPolicyElement(FinalSuccess) {}
};

class EAP_EXPORTS EapFailurePolicyElement : public EapPolicyElement
{
public:
  EapFailurePolicyElement() : EapPolicyElement(FinalFailure) {}
};

typedef ACE_Singleton<EapSuccessPolicyElement, ACE_Recursive_Thread_Mutex> 
EapSuccessPolicyElement_S;

typedef ACE_Singleton<EapFailurePolicyElement, ACE_Recursive_Thread_Mutex> 
EapFailurePolicyElement_S;

class EAP_EXPORTS EapContinuedPolicyElement : public EapPolicyElement
{
  friend class EapPolicy;
public:
  EapContinuedPolicyElement(EapType t) : 
    EapPolicyElement(Continued), 
    nextOnSuccess(EapSuccessPolicyElement_S::instance()), 
    nextOnFailure(EapFailurePolicyElement_S::instance()), methodType(t) {}
  enum PolicySwitch {
    PolicyOnSuccess,
    PolicyOnFailure
  };
  EapPolicyElement *NextPolicyElement(PolicySwitch sw) 
  { 
    if (sw == PolicyOnSuccess)
      return nextOnSuccess;
    else
      return nextOnFailure;
  }
  void AddSuccessPolicyElement(PolicySwitch sw);
  void AddFailurePolicyElement();
  void AddContinuedPolicyElement(EapPolicyElement *p, PolicySwitch sw);
  bool IsContinued() { return true; }
  EapType GetType() { return methodType; }
private:
  EapPolicyElement *nextOnSuccess;
  EapPolicyElement *nextOnFailure;
  EapType methodType;
};

class EAP_EXPORTS EapPolicy
{
public:
  enum PolicyError {
    NoCurrentMethod // used by GetCurrentMethod
  };
  EapPolicy() : initialPolicyElement(0), currentPolicyElement(0) {}
  ~EapPolicy() {}

  EapPolicyElement* NextPolicyElement
  (EapContinuedPolicyElement::PolicySwitch sw);

  inline EapPolicyElement* CurrentPolicyElement() 
  { return currentPolicyElement; }

  void CurrentPolicyElement(EapPolicyElement *e) { currentPolicyElement = e; }

  inline EapPolicyElement* InitialPolicyElement() 
  { return initialPolicyElement; }

  void InitialPolicyElement(EapPolicyElement *e) 
  { initialPolicyElement = e; }

  EapType CurrentMethod() throw (PolicyError);

  void Update(EapContinuedPolicyElement::PolicySwitch sw);
  
  void Update(EapTypeList &typeL);

  bool Allow(EapType t);

  bool IsSatisfied();

  void MakeTypeList(EapTypeList &typeL, bool isVSE);

  bool SupportPickUp(EapType type)
  {
    if (type == EapType(1))
      return true;
    return false;
  }

private:
  void MakeTypeList(EapTypeList &typeL, bool isVSE, EapPolicyElement *pe);

  EapPolicyElement *initialPolicyElement;

  EapPolicyElement *currentPolicyElement;
};

#endif // __EAP_POLICY_HXX__

---