AuthService (Utilities 4.1.0 API)

All Superinterfaces:

ServiceBase, StatelessServiceBase

All Known Implementing Classes:

AuthServiceImpl
```
public interface AuthService
extends ServiceBase
```
An authentication service interface.

Since:

1.0.0

Version:

$Id: AuthService.java 16853 2014-03-06 02:10:11Z colin $

Author:

tlerios@marketcetera.com

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`SessionId`	`login(StatelessClientContext context, String user, char[] password)`	Logs in the client with the given context, provided the given credentials are acceptable.
`void`	`logout(ClientContext context)`	Logs out the client with the given context.

- Method Detail
  - login
```
SessionId login(StatelessClientContext context,
                String user,
                char[] password)
         throws RemoteException
```
    Logs in the client with the given context, provided the given credentials are acceptable.
    
    Parameters:
    
    context - The context.
    
    user - The user name.
    
    password - The password. Upon return, its contents are cleared (on the server) by overwriting all prior characters with the nul ('\0') character.
    
    Returns:
    
    The ID of the new session.
    
    Throws:
    
    RemoteException - Thrown if the operation cannot be completed.
  - logout
```
void logout(ClientContext context)
     throws RemoteException
```
    Logs out the client with the given context. This method is a no-op if there is no active session for that client.
    
    Parameters:
    
    context - The context.
    
    Throws:
    
    RemoteException - Thrown if the operation cannot be completed.