Protocol.java

/**
 * Copyright (c) 2008-2016, XebiaLabs B.V., All rights reserved.
 *
 *
 * Overthere is licensed under the terms of the GPLv2
 * <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most XebiaLabs Libraries.
 * There are special exceptions to the terms and conditions of the GPLv2 as it is applied to
 * this software, see the FLOSS License Exception
 * <http://github.com/xebialabs/overthere/blob/master/LICENSE>.
 *
 * This program is free software; you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation; version 2
 * of the License.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this
 * program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth
 * Floor, Boston, MA 02110-1301  USA
 */
package com.xebialabs.overthere.spi;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import com.xebialabs.overthere.ConnectionOptions;

/**
 * Annotation used to specify that a class is an Overthere protocol. It will be registered on startup of the application
 * and will register under the provided name. It must also have a two-arg constructor ({@link String},
 * {@link ConnectionOptions}) and implement the {@link OverthereConnectionBuilder} interface.
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface Protocol {
    String name();
}