Package org.kawanfw.sql.api.server.auth

Class WebServiceUserAuthenticator

java.lang.Object

org.kawanfw.sql.api.server.auth.WebServiceUserAuthenticator

All Implemented Interfaces:

UserAuthenticator

public class WebServiceUserAuthenticator
extends Object
implements UserAuthenticator

A concrete UserAuthenticator that allows zero-code remote client (username, password) authentication against a Web service.

The URL of the Web service is defined in the webServiceUserAuthenticator.url in the aceql-server.properties file.

The Web service must just implement these features:

• It must accept the 2 POST parameters username and password.
• It must return either:
  • The JSON string {"status"="OK"} if the authentication succeeds.
  • The JSON string {"status"="FAIL"} if the authentication fails.

Since:

5.0

Author:

Nicolas de Pomereu

See Also:

UserAuthenticator

Constructor Summary

Constructors

Constructor	Description
WebServiceUserAuthenticator()

Method Summary

Modifier and Type	Method	Description
boolean	login(String username, char[] password, String database, String ipAddress)	Allows to authenticate the remote (username, password) couple sent by the client side.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebServiceUserAuthenticator

public WebServiceUserAuthenticator()

Method Details

login

public boolean login(String username,
char[] password,
String database,
String ipAddress)
              throws IOException,
SQLException

Description copied from interface: UserAuthenticator

Allows to authenticate the remote (username, password) couple sent by the client side.

The AceQL HTTP Server will call the method in order to grant or not client access.

Typical usage would be to check the (username, password) couple against a LDAP server or against a SSH server, etc. The method allows to retrieve:

• The name of the database to which the client wants to connect.
• The IP address of the client.

Specified by:

login in interface UserAuthenticator

Parameters:

username - the username sent by the client

password - the password to connect to the server

database - the database name to which the client wants to connect

ipAddress - the IP address of the client user

Returns:

true if the Authentication Web Service defined in aceql-server.properties returns the JSON String {"status"="OK"}, else false .

Throws:

IOException - if an IOException occurs

SQLException - if a SQLException occurs