OSX/libsecurity_cssm/lib/attachfactory.h

   1 /*
   2  * Copyright (c) 2000-2001,2004,2011,2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 //
  26 // attachfactory - industrial grade production of Attachment objects
  27 //
  28 #ifndef _H_ATTACHFACTORY
  29 #define _H_ATTACHFACTORY
  30
  31 #include "cssmint.h"
  32 #include "attachment.h"
  33
  34 #ifdef _CPP_ATTACHFACTORY
  35 # pragma export on
  36 #endif
  37
  38
  39 //
  40 // An AttachmentMaker can create an Attachment object for a particular service
  41 // type when asked nicely.
  42 //
  43 class AttachmentMaker {
  44 public:
  45     AttachmentMaker(CSSM_SERVICE_TYPE type) : mType(type) { }
  46     virtual ~AttachmentMaker();
  47
  48     virtual Attachment *make(Module *module,
  49                              const CSSM_VERSION &version,
  50                              uint32 subserviceId,
  51                              CSSM_SERVICE_TYPE subserviceType,
  52                              const CSSM_API_MEMORY_FUNCS &memoryOps,
  53                              CSSM_ATTACH_FLAGS attachFlags,
  54                              CSSM_KEY_HIERARCHY keyHierarchy,
  55                              CSSM_FUNC_NAME_ADDR *functionTable,
  56                              uint32 functionTableSize) = 0;
  57
  58     CSSM_SERVICE_TYPE factoryType() const { return mType; }
  59
  60 private:
  61     CSSM_SERVICE_TYPE mType;
  62 };
  63
  64
  65 //
  66 // An AttachmentFactory contains a registry of AttachmentMakers for different
  67 // service types, and produces the needed one on request.
  68 //
  69 class AttachmentFactory {
  70 public:
  71     AttachmentFactory();
  72
  73     AttachmentMaker *attachmentMakerFor(CSSM_SERVICE_TYPE type) const;
  74
  75 private:
  76     typedef map<CSSM_SERVICE_TYPE, AttachmentMaker *> AttachFactories;
  77     AttachFactories factories;
  78 };
  79
  80 #ifdef _CPP_ATTACHFACTORY
  81 # pragma export off
  82 #endif
  83
  84
  85 #endif //_H_ATTACHFACTORY