gerrit.onap Code Review - so.git/blob

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