adapters/etsi-sol003-adapter/etsi-sol003-package-management/etsi-sol003-package-management-adapter/src/main/java/org/onap/so/adapters/etsi/sol003/adapter/packagemanagement/subscriptionmanagement/NotificationServiceProvider.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20 package org.onap.so.adapters.etsi.sol003.adapter.packagemanagement.subscriptionmanagement;
  21
  22 import org.onap.so.adapters.etsi.sol003.adapter.packagemanagement.model.SubscriptionsAuthentication;
  23 import org.onap.so.adapters.etsi.sol003.adapter.packagemanagement.model.SubscriptionsAuthentication.AuthTypeEnum;
  24
  25 /**
  26  * Interface which lays out requirements for a Notification Service Provider
  27  *
  28  * @author Waqas Ikram (waqas.ikram@est.tech)
  29  * @author Andrew Lamb (andrew.a.lamb@est.tech)
  30  */
  31 public interface NotificationServiceProvider {
  32
  33     /**
  34      * Method to send a notification to a uri, given the subscription authentication
  35      *
  36      * @param notification The notification to send
  37      * @param subscriptionsAuthentication Object containing the authentication details
  38      * @param callbackUri The uri to send the notification to
  39      * @return true if notification is delivered successfully, otherwise false
  40      */
  41     boolean send(final Object notification, final SubscriptionsAuthentication subscriptionsAuthentication,
  42             final String callbackUri);
  43
  44     /**
  45      * Method to get the supported authorization type of the service provider
  46      *
  47      * @return the supported AuthTypeEnum
  48      */
  49     AuthTypeEnum getAuthType();
  50
  51 }