view app/src/main/java/net/sourceforge/jsocks/server/UserValidation.java @ 472:9ff443085f00

cleanup documentation
author Carl Byington <carl@five-ten-sg.com>
date Sat, 05 Oct 2019 08:24:18 -0700
parents d29cce60f393
children
line wrap: on
line source

package net.sourceforge.jsocks.server;

/**
  Interface which provides for user validation, based on user name
  password and where it connects from.
*/
public interface UserValidation{
    /**
     Implementations of this interface are expected to use some or all
     of the information provided plus any information they can extract
     from other sources to decide wether given user should be allowed
     access to SOCKS server, or whatever you use it for.

     @return true to indicate user is valid, false otherwise.
     @param username User whom implementation should validate.
     @param password Password this user provided.
     @param connection Socket which user used to connect to the server.
    */
    boolean isUserValid(String username,String password,
                        java.net.Socket connection);
}