com.spotfire.server.userdir.spi
Interface UserDirectoryProvider

Deprecated. Use PostAuthenticationFilter

public interface UserDirectoryProvider

This SPI should be implemented by classes that provide the functionality of listing users from an external system.

Not all methods need to be supported. If a method is not supported it should throw a java.lang.UnsupportedOperationException. The methods UserDirectoryProvider.isCaseSensitive() and UserDirectoryProvider.init(Element) will be called during initialization and are mandatory.

Since:

DSS 7.3

Method Summary

void	destroy() Deprecated. Performs cleanup of any resources used by the provider, such as database connections.
HashMap	getGroupMap() Deprecated. Load a group map containing all groups and their members.
ProviderPrincipal	getPrincipalById(String id) Deprecated. Get a principal from the directory.
ProviderUserPrincipal	getUserPrincipalByName(String name) Deprecated. Get a user principal from the directory.
ProviderUserPrincipal[]	getUserPrincipals() Deprecated. Get all users in the directory.
ProviderUserPrincipal[]	getUserPrincipals(String regExp) Deprecated. Get all users with names that matches a regular expression.
void	init(Element config) Deprecated. Initialize the provider.
boolean	isCaseSensitive() Deprecated. Check if principals are matched cased sensitive or not in the directory.

Method Detail

init

void init(Element config)

Deprecated.

Initialize the provider. This method is called when the server is started and the user directory is initialized.

Parameters:

config - the configuration for this provider

destroy

void destroy()

Deprecated.

Performs cleanup of any resources used by the provider, such as database connections. This method is called when the DS Server is stopped.

isCaseSensitive

boolean isCaseSensitive()

Deprecated.

Check if principals are matched cased sensitive or not in the directory.

Returns:

true if case sensitive, false otherwise

getUserPrincipalByName

ProviderUserPrincipal getUserPrincipalByName(String name)

Deprecated.

Get a user principal from the directory.

Parameters:

name - The name of the user

Returns:

the user principal or null if the principal does not exist

Throws:

UserDirectoryException - if an error occurred in the provider

getPrincipalById

ProviderPrincipal getPrincipalById(String id)

Deprecated.

Get a principal from the directory.

Parameters:

id - The id of the principal

Returns:

the ProviderUserPrincipal or null if the principal does not exist

Throws:

UserDirectoryException - if an error occurred in the provider

getUserPrincipals

ProviderUserPrincipal[] getUserPrincipals()

Deprecated.

Get all users in the directory.

Returns:

all users

Throws:

UserDirectoryException - if an error occurred in the provider

getUserPrincipals

ProviderUserPrincipal[] getUserPrincipals(String regExp)

Deprecated.

Get all users with names that matches a regular expression.

Parameters:

regExp - A regular expression, using the java.util.regex syntax

Returns:

all matching users

Throws:

IllegalArgumentException - if the regular expression is invalid

UserDirectoryException - if an error occurred in the provider

UnsupportedOperationException - if the provider doesn't support regexp searches

getGroupMap

HashMap getGroupMap()

Deprecated.

Load a group map containing all groups and their members.

Returns:

a map containing all groups and their members

Throws:

UserDirectoryException - if an error occurred in the provider

UnsupportedOperationException - if the provider doesn't support groups