olm/src/main/java/org/opendaylight/transportpce/olm/power/PowerMgmt.java

   1 /*
   2  * Copyright © 2017 AT&T and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.transportpce.olm.power;
  10
  11 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerSetupInput;
  12 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev210618.ServicePowerTurndownInput;
  13
  14 public interface PowerMgmt {
  15
  16     /**
  17      * This methods measures power requirement for turning up a WL
  18      * from the Spanloss at OTS transmit direction and update
  19      * roadm-connection target-output-power.
  20      *
  21      * @param input
  22      *            Input parameter from the olm servicePowerSetup rpc
  23      *
  24      * @return true/false based on status of operation.
  25      */
  26     Boolean setPower(ServicePowerSetupInput input);
  27
  28     /**
  29      * This methods turns down power a WL by performing
  30      * following steps:
  31      *
  32      * <p>
  33      * 1. Pull interfaces used in service and change
  34      * status to outOfService
  35      *
  36      * <p>
  37      * 2. For each of the ROADM node set target-output-power
  38      * to -60dbm, wait for 20 seconds, turn power mode to off
  39      *
  40      * <p>
  41      * 3. Turn down power in Z to A direction and A to Z
  42      *
  43      * @param input
  44      *            Input parameter from the olm servicePowerTurndown rpc
  45      *
  46      * @return true/false based on status of operation
  47      */
  48     Boolean powerTurnDown(ServicePowerTurndownInput input);
  49
  50 }