adapters/mso-adapter-utils/src/main/java/org/openecomp/mso/cloud/authentication/AuthenticationWrapper.java

   1 /*\r
   2  * ============LICENSE_START==========================================\r
   3  * ===================================================================\r
   4  * Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.\r
   5  * ===================================================================\r
   6  * Licensed under the Apache License, Version 2.0 (the "License");\r
   7  * you may not use this file except in compliance with the License.\r
   8  * You may obtain a copy of the License at\r
   9  *\r
  10  *        http://www.apache.org/licenses/LICENSE-2.0\r
  11  *\r
  12  * Unless required by applicable law or agreed to in writing, software\r
  13  * distributed under the License is distributed on an "AS IS" BASIS,\r
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  15  * See the License for the specific language governing permissions and\r
  16  * limitations under the License.\r
  17  * ============LICENSE_END============================================\r
  18  *\r
  19  * ECOMP and OpenECOMP are trademarks\r
  20  * and service marks of AT&T Intellectual Property.\r
  21  *\r
  22  */\r
  23 \r
  24 package org.openecomp.mso.cloud.authentication;\r
  25 \r
  26 import org.openecomp.mso.cloud.CloudIdentity;\r
  27 \r
  28 import com.woorea.openstack.keystone.model.Authentication;\r
  29 \r
  30 /**\r
  31  * This abstract class provides the necessary method for registering authentication\r
  32  * types with wrapper classes, and also defines the contract for providing\r
  33  * Openstack-compatible Authentication implementations for said authentication types.\r
  34  *\r
  35  */\r
  36 public abstract class AuthenticationWrapper {\r
  37 \r
  38         /**\r
  39          * Registers the implementing class to the list of Authentication Wrappers.\r
  40          *\r
  41          * @param authenticationType The authentication type that is provided by the implementing class\r
  42          * @param wrapperClass The implementing class Class object\r
  43          * @throws InstantiationException If the provided implementing class cannot be instantiated\r
  44          * @throws IllegalAccessException If the provided implementing class cannot be instantiated\r
  45          */\r
  46         public static final void register(String authenticationType, Class<? extends AuthenticationWrapper> wrapperClass) throws InstantiationException, IllegalAccessException {\r
  47                 AuthenticationMethodFactory.register(authenticationType, wrapperClass);\r
  48         }\r
  49         \r
  50         /**\r
  51          * Returns an OpenStack Authentication object for the provided CloudIdentity.\r
  52          *\r
  53          * @param cloudIdentity The input Cloud Identity instance\r
  54          * @return the OpenStack Authentication associated with this cloud identity instance\r
  55          */\r
  56         protected abstract Authentication getAuthentication(CloudIdentity cloudIdentity);\r
  57 \r
  58 }\r