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