opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/handler/ssh/client/Invoker.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. 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 package org.opendaylight.controller.netconf.util.handler.ssh.client;
   9
  10 import java.io.IOException;
  11
  12 /**
  13  * Abstract class providing mechanism of invoking various SSH level services.
  14  * Class is not allowed to be extended, as it provides its own implementations via instance initiators.
  15  */
  16 public abstract class Invoker {
  17     private boolean invoked = false;
  18
  19     private Invoker(){}
  20
  21     protected boolean isInvoked() {
  22         return invoked;
  23     }
  24
  25     abstract void invoke(SshSession session) throws IOException;
  26
  27     /**
  28      * Invoker implementation to invokes subsystem SSH service.
  29      *
  30      * @param subsystem
  31      * @return
  32      */
  33     public static Invoker subsystem(final String subsystem) {
  34         return new Invoker() {
  35             @Override
  36             void invoke(SshSession session) throws IOException {
  37                 if (isInvoked() == true) throw new IllegalStateException("Already invoked.");
  38
  39                 session.startSubSystem(subsystem);
  40             }
  41         };
  42     }
  43 }