Package de.xima.fc.auth

Class ClientAuthorizationHelper

java.lang.Object

de.xima.fc.auth.ClientAuthorizationHelper

public class ClientAuthorizationHelper
extends Object

Helper class for working with IClientAuthorizations

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

Modifier and Type	Method	Description
static Set<String>	lookupUserEmails(IEntityContext ec, IndirectClientAuthorization authorization)	Finds all users that belong to the given user filter (=indirect client authorization), and gets the email address for each found user.
static List<UserEmailLookupEntry>	tryLookupUserEmails(IEntityContext ec, IndirectClientAuthorization authorization)	Finds all users that belong to the given user filter (=indirect client authorization), and gets the email address for each found user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

tryLookupUserEmails

public static List<UserEmailLookupEntry> tryLookupUserEmails(IEntityContext ec,
                                                             IndirectClientAuthorization authorization)
                                                      throws com.unboundid.ldap.sdk.LDAPException,
                                                             GeneralSecurityException

Finds all users that belong to the given user filter (=indirect client authorization), and gets the email address for each found user. If a user does not have an email address, a UserEmailLookupEntry without an empty mail field is returned.

Parameters:

ec - Entity context to access the database.

authorization - User filter for which to lookup the users.

Returns:

A list with all users that belong to the given user filter, together with their email address, if it exists.

Throws:

com.unboundid.ldap.sdk.LDAPException - When the user filter requires retrieving the users from an LDAP server and the LDAP user retrieval query failed.

GeneralSecurityException - When the user filter requires establishing an SSL connection to retrieve the user and a problem occurred while creating or initializing the SSL connection.

lookupUserEmails

public static Set<String> lookupUserEmails(IEntityContext ec,
                                           IndirectClientAuthorization authorization)
                                    throws com.unboundid.ldap.sdk.LDAPException,
                                           GeneralSecurityException

Finds all users that belong to the given user filter (=indirect client authorization), and gets the email address for each found user. If a user does not have an email address, their are ignored. The returned set includes only the email addresses of users with an email.

Parameters:

ec - Entity context to access the database.

authorization - User filter for which to lookup the users.

Returns:

A list with all email addresses of the users that belong to the given user filter.

Throws:

com.unboundid.ldap.sdk.LDAPException - When the user filter requires retrieving the users from an LDAP server and the LDAP user retrieval query failed.

GeneralSecurityException - When the user filter requires establishing an SSL connection to retrieve the user and a problem occurred while creating or initializing the SSL connection.