pce/src/main/java/org/opendaylight/transportpce/pce/networkanalyzer/port/Factory.java

   1 /*
   2  * Copyright (c) 2024 Smartoptics 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.pce.networkanalyzer.port;
  10
  11 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.pce.rev230925.PathComputationRequestInput;
  12
  13 public interface Factory {
  14
  15     /**
  16      * Extracting preferred ports from pathComputationRequestInput.
  17      *
  18      * <p>
  19      * This is the recommended method of determining if a node/port combination
  20      * is preferred by the client.
  21      *
  22      * <p>
  23      * Pseudocode example:
  24      * <pre>
  25      *     Factory.portPreference(PCRI).preferredPort("ROADM-B-SRG1", "SRG1-PP1-TXRX");
  26      * </pre>
  27      *
  28      * @return Client port preference
  29      */
  30     Preference portPreference(PathComputationRequestInput pathComputationRequestInput);
  31
  32 }