org.eurekaclinical.i2b2.client

Interface I2b2UserAuthenticator

All Known Implementing Classes:

I2b2UserAuthenticatorImpl, MockI2b2UserAuthenticator

public interface I2b2UserAuthenticator

Interface for authenticating an i2b2 user given authentication metadata for that user.

Since:

1.0

Author:

Michel Mansour

Method Summary

Modifier and Type	Method and Description
boolean	authenticateUser(I2b2AuthMetadata authMetadata) Determines whether or not a user is authenticated given their authentication metadata.

Method Detail

authenticateUser

boolean authenticateUser(I2b2AuthMetadata authMetadata)
                  throws I2b2XmlException

Determines whether or not a user is authenticated given their authentication metadata.

Parameters:

authMetadata - the i2b2 authentication metadata to provide to i2b2 to authenticate the user

Returns:

true if the user was authenticated by i2b2, false otherwise

Throws:

I2b2XmlException - if an error occurs processing the i2b2 response XML