dashboard/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/portalapi/IPortalSdkDecryptor.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 AT&T Intellectual Property
   6  * %%
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ========================LICENSE_END===================================
  19  */
  20 package org.oransc.ric.portal.dashboard.portalapi;
  21
  22 import org.onap.portalsdk.core.onboarding.exception.CipherUtilException;
  23
  24 /**
  25  * Supports an upgrade path among methods in CipherUtil because the PortalSDK is
  26  * changing encryption methods.
  27  */
  28 public interface IPortalSdkDecryptor {
  29
  30         /**
  31          * Decrypts the specified value using a known key.
  32          *
  33          * @param cipherText
  34          *                       Encrypted value
  35          * @return Clear text on success, null otherwise.
  36          * @throws CipherUtilException
  37          *                                 if any decryption step fails
  38          */
  39         String decrypt(String cipherText) throws CipherUtilException;
  40
  41 }