com.sshtools.ssh2.BannerDisplay Maven / Gradle / Ivy
The newest version!
/**
* Copyright 2003-2016 SSHTOOLS Limited. All Rights Reserved.
*
* For product documentation visit https://www.sshtools.com/
*
* This file is part of J2SSH Maverick.
*
* J2SSH Maverick is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* J2SSH Maverick 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 J2SSH Maverick. If not, see
* Callback interface to display authentication banner messages.
*
*
*
* In some jurisdictions sending a warning message before authentication may be
* relevant for getting legal protection. Many UNIX machines, for example,
* normally display text from `/etc/issue', or use "tcp wrappers" or similar
* software to display a banner before issuing a login prompt.
*
*
*
* Implement this interface to show the authentication banner message. The
* method should display the message and should not return until the user
* accepts the message
*
*
*
* To configure a banner display you must setup the Ssh2Context on a SshConnector instance using the following
* code:
*
*
* SshConnector con = SshConnector.getInstance();
*
* BannerDisplay display = new BannerDisplay() {
* public void displayBanner(String message) {
* System.out.println(message);
* System.in.read();
* }
* };
* Ssh2Context context = (Ssh2Context) con.getContext(SshConnector.SSH2);
* context.setBannerDisplay(display);
*
*
*
*
* @author Lee David Painter
*/
public interface BannerDisplay {
/**
* Called when a banner message is received.
*
* @param message
* the message to display.
*/
public void displayBanner(String message);
}