OICRLdapAuthentication (SeqWare 1.1.2 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- net.sourceforge.solexatools.authentication.Authentication
- - net.sourceforge.solexatools.authentication.OICRLdapAuthentication

```
public class OICRLdapAuthentication
extends Authentication
```
This authentication plugin allows the SeqWare Portal to authenticate against the Ontario Institute for Cancer Research (OICR) LDAP server. Users will pass in an email address and password. An associated list of uids that match the email address will be retrieved via an LDAP directory search. More than one uid will be returned for users who have multiple credentials. This plugin will loop through the uids and attempt to authenticate with the provided password.

Version:

$Id: $Id

Author:

boconnor

Constructor Summary

Constructors
Constructor and Description

OICRLdapAuthentication()

Method Summary

Methods
Modifier and Type	Method and Description
`DirContext`	`getDirContext()` getDirContext.
`List<String>`	`getUids(NamingEnumeration<SearchResult> searchResultEnum)` getUids.
`boolean`	`loginSuccess(String uid, String password)` loginSuccess.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OICRLdapAuthentication
```
public OICRLdapAuthentication()
```
- Method Detail
  - loginSuccess
```
public boolean loginSuccess(String uid,
                   String password)
```
    loginSuccess.
    
    Overrides:
    
    loginSuccess in class Authentication
    
    Parameters:
    uid - a String object.
    password - a String object.
    
    Returns:
  - getDirContext
```
public DirContext getDirContext()
                         throws NamingException
```
    getDirContext.
    
    Returns:
    a DirContext object.
    
    Throws:
    
    NamingException - if any.
  - getUids
```
public List<String> getUids(NamingEnumeration<SearchResult> searchResultEnum)
                     throws NamingException
```
    getUids.
    
    Parameters:
    searchResultEnum - a NamingEnumeration object.
    
    Returns:
    a List object.
    
    Throws:
    
    NamingException - if any.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2015 SeqWare. All rights reserved.