-
public interface LoginProxy
A login proxy.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description String
clientTypeId()
void
close()
Disposes of all resources used by this LoginProxy, after a call to this method the proxy should be regarded as unusable.RemoteClient
login(RemoteClient remoteClient)
Performs login validation for the user specified by the remote client and returns a remote client with the same clientId and user but possibly a different databaseUser to propagate to further login proceduresstatic List<LoginProxy>
loginProxies()
void
logout(RemoteClient remoteClient)
Called after the given client has been disconnected
-
-
-
Method Detail
-
clientTypeId
String clientTypeId()
- Returns:
- the String identifying the client type for which to use this login proxy, null to share between all clients
-
login
RemoteClient login(RemoteClient remoteClient) throws LoginException
Performs login validation for the user specified by the remote client and returns a remote client with the same clientId and user but possibly a different databaseUser to propagate to further login procedures- Parameters:
remoteClient
- the client- Returns:
- a new client with the same clientId but not necessarily the same user or databaseUser
- Throws:
LoginException
- in case the login fails- See Also:
RemoteClient.databaseUser()
-
logout
void logout(RemoteClient remoteClient)
Called after the given client has been disconnected- Parameters:
remoteClient
- the remote client
-
close
void close()
Disposes of all resources used by this LoginProxy, after a call to this method the proxy should be regarded as unusable. This method should be called by a server using this LoginProxy on shutdown, giving the LoginProxy a chance to release resources in an orderly manner. Any exception thrown by this method is ignored.
-
loginProxies
static List<LoginProxy> loginProxies()
- Returns:
- a list containing all the LoginProxies registered with
ServiceLoader
.
-
-