src/main/java/org/apache/pirk/responder/wideskies/spi/ResponderPlugin.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.pirk.responder.wideskies.spi;

import org.apache.pirk.utils.PIRException;

/**
 * Interface which launches a responder
 * <p>
 * Implement this interface to start the execution of a framework responder, the run method will be called via reflection by the ResponderDriver.
 * </p>
 */
public interface ResponderPlugin
{
  /**
   * Returns the plugin name for your framework
   * This will be the platform argument
   * @return
   */
  public String getPlatformName();
  /**
   * This method launches your framework responder.
   */
  public void run() throws PIRException;
}