com.webmethods.portal.service.dir

Interface IDirConfig

public interface IDirConfig

This interface exposes configuration information about a specific directory service. Each specific Directory Service may have more detailed information. Also, to update any properties you need to use the com.webmethods.portal.bizPolicy.command.meta.UpdateProperties command

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHENTICATE_CACHE_CAPACITY
static String	AUTHENTICATE_CACHE_ENABLED
static String	AUTHENTICATE_CACHE_TIMEOUT
static String	CACHE_CAPACITY
static String	CACHE_ENABLED
static String	CACHE_TIMEOUT
static int	GROUP_QUICK_AD
static int	GROUP_QUICK_DISABLED
static int	GROUP_QUICK_TIVOLI63

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getCommonUserAttributeMap() This returns a map of name value pairs describing the common mapping of user attributes.
String	getDirectoryName() Get the name of this directory service
int	getMembershipQuickSearch()
Map<String,Object>	getProperties() Persist any changes made to the configuration and re-initialize the IDirService
Object	getProperty(String propName) Get a specific property name
boolean	getPropertyAsBoolean(String name, boolean defaultValue)
double	getPropertyAsDouble(String name, double defaultValue)
float	getPropertyAsFloat(String name, float defaultValue)
int	getPropertyAsInt(String name, int defaultValue)
long	getPropertyAsLong(String name, long defaultValue)
String	getPropertyAsString(String name, String defaultValue)

Field Detail

CACHE_ENABLED

static final String CACHE_ENABLED

See Also:

Constant Field Values

CACHE_CAPACITY

static final String CACHE_CAPACITY

See Also:

Constant Field Values

CACHE_TIMEOUT

static final String CACHE_TIMEOUT

See Also:

Constant Field Values

AUTHENTICATE_CACHE_ENABLED

static final String AUTHENTICATE_CACHE_ENABLED

See Also:

Constant Field Values

AUTHENTICATE_CACHE_CAPACITY

static final String AUTHENTICATE_CACHE_CAPACITY

See Also:

Constant Field Values

AUTHENTICATE_CACHE_TIMEOUT

static final String AUTHENTICATE_CACHE_TIMEOUT

See Also:

Constant Field Values

GROUP_QUICK_DISABLED

static final int GROUP_QUICK_DISABLED

See Also:

Constant Field Values

GROUP_QUICK_AD

static final int GROUP_QUICK_AD

See Also:

Constant Field Values

GROUP_QUICK_TIVOLI63

static final int GROUP_QUICK_TIVOLI63

See Also:

Constant Field Values

Method Detail

getProperties

Map<String,Object> getProperties()
                          throws PortalException

Persist any changes made to the configuration and re-initialize the IDirService

Throws:

PortalException

getProperty

Object getProperty(String propName)
            throws PortalException

Get a specific property name

Parameters:

propName -

Throws:

PortalException

getDirectoryName

String getDirectoryName()
                 throws PortalException

Get the name of this directory service

Throws:

PortalException

getPropertyAsBoolean

boolean getPropertyAsBoolean(String name,
                             boolean defaultValue)
                      throws PortalException

Throws:

PortalException

See Also:

getProperty(String)

getPropertyAsInt

int getPropertyAsInt(String name,
                     int defaultValue)
              throws PortalException

Throws:

PortalException

See Also:

getProperty(String)

getPropertyAsFloat

float getPropertyAsFloat(String name,
                         float defaultValue)
                  throws PortalException

Throws:

PortalException

See Also:

getProperty(String)

getPropertyAsLong

long getPropertyAsLong(String name,
                       long defaultValue)
                throws PortalException

Throws:

PortalException

See Also:

getProperty(String)

getPropertyAsDouble

double getPropertyAsDouble(String name,
                           double defaultValue)
                    throws PortalException

Throws:

PortalException

See Also:

getProperty(String)

getPropertyAsString

String getPropertyAsString(String name,
                           String defaultValue)
                    throws PortalException

Throws:

PortalException

See Also:

getProperty(String)

getCommonUserAttributeMap

Map<String,String> getCommonUserAttributeMap()
                                      throws PortalException

This returns a map of name value pairs describing the common mapping of user attributes. For instance, an ldap config might return firstName -> cn

Throws:

PortalException

getMembershipQuickSearch

int getMembershipQuickSearch()

Returns:

is quick search enabled.