org.figure8.join.services.remoting
Interface AuthenticatedService

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

ArtifactService, CronService, MessagingService, ParameterService, ProcessControlService, ReportingService, ResourceService

All Known Implementing Classes:

AbstractAuthenticatedService, ArtifactServiceImpl, CronServiceImpl, MessagingServiceImpl, ParameterServiceImpl, ProcessControlServiceImpl, ReportingServiceImpl, ResourceServiceImpl

public interface AuthenticatedService
extends java.rmi.Remote

Base interface for remote services interface and implementation. This interface should be extend where authentication and authorization is required for remote services execution.

Version:

$Revision: 1.2 $

Author:

Laurent Broudoux

Method Summary

java.lang.String	login(java.lang.String username, java.lang.String password) Authenticates a remote user onto Join application.
void	logout(java.lang.String token) Logs out from Join application the user corresponding to the supplied token.

Method Detail

login

java.lang.String login(java.lang.String username,
                       java.lang.String password)
                       throws InvalidLoginException,
                              java.rmi.RemoteException

Authenticates a remote user onto Join application. In case of successfull authentication, this method returns a token that should be used later as a parameter for calling services required authorization.

Parameters:

username - Login of user for authentication

password - Password of corresponding user

Returns:

An authentication token to reuse later during service call

Throws:

InvalidLoginException - if user cannot be logged

java.rmi.RemoteException - if an exception occurs during the remote conversation

logout

void logout(java.lang.String token)
            throws java.rmi.RemoteException

Logs out from Join application the user corresponding to the supplied token.

Parameters:

token - An authentication token obtained with login() method.

Throws:

java.rmi.RemoteException - if an exception occurs during the remote conversation