Package org.bedework.carddav.server.jmx

Class LdapDirHandlerConf

java.lang.Object

org.bedework.util.jmx.ConfBase<DirHandlerConfig>

org.bedework.carddav.server.jmx.DirHandlerConf

org.bedework.carddav.server.jmx.LdapDirHandlerConf

All Implemented Interfaces:

DirHandlerConfMBean, LdapDirHandlerConfMBean, org.bedework.util.jmx.BaseMBean, org.bedework.util.jmx.ConfBaseMBean, org.bedework.util.logging.Logged

public class LdapDirHandlerConf
extends DirHandlerConf
implements LdapDirHandlerConfMBean

Author:

douglm

Field Summary

Fields inherited from class org.bedework.util.jmx.ConfBase

cfg, statusDone, statusFailed, statusInterrupted, statusRunning, statusStopped, statusTimedout, statusUnknown

Constructor Summary

Constructors

Constructor	Description
LdapDirHandlerConf(String serviceName, org.bedework.util.config.ConfigurationStore store, String configName)

Method Summary

Modifier and Type	Method	Description
String	getAddressbookEntryIdAttr()
String	getAddressbookEntryObjectClass()
String	getAddressbookIdAttr()
String	getAddressbookObjectClass()
String	getAttrIds()
String	getAuthDn()	If we need an id to authenticate this is it.
String	getAuthPw()	If we need an id to authenticate this is the pw.
String	getBaseDn()
LdapDirHandlerConfig	getConf()
String	getFolderIdAttr()
String	getFolderObjectClass()
String	getGroupMemberAttr()	Attribute we want back identifying a member
String	getInitialContextFactory()
String	getPrincipalIdAttr()	Attribute we search for to get a group
String	getProviderUrl()	URL of ldap server
int	getQueryLimit()
String	getSecurityAuthentication()
String	getSecurityProtocol()	e.g "ssl"
void	setAddressbookEntryIdAttr(String val)
void	setAddressbookEntryObjectClass(String val)
void	setAddressbookIdAttr(String val)
void	setAddressbookObjectClass(String val)
void	setAttrIds(String val)
void	setAuthDn(String val)	If we need an id to authenticate this is it.
void	setAuthPw(String val)	If we need an id to authenticate this is the pw.
void	setBaseDn(String val)
void	setFolderIdAttr(String val)
void	setFolderObjectClass(String val)
void	setGroupMemberAttr(String val)	Attribute we want back identifying a member
void	setInitialContextFactory(String val)
void	setPrincipalIdAttr(String val)
void	setProviderUrl(String val)
void	setQueryLimit(int val)	Set the query limit - 0 for no limit
void	setSecurityAuthentication(String val)
void	setSecurityProtocol(String val)

Methods inherited from class org.bedework.carddav.server.jmx.DirHandlerConf

getAddressBook, getCardKind, getCardPathPrefix, getCardPathPrefixes, getClassName, getDirectory, getOwnerHref, getPathPrefix, getPrincipalPrefix, loadConfig, setAddressBook, setCardKind, setCardPathPrefix, setCardPathPrefixes, setClassName, setConfig, setDirectory, setOwnerHref, setPathPrefix, setPrincipalPrefix

Methods inherited from class org.bedework.util.jmx.ConfBase

createObjectName, ensureDir, getConfig, getConfigDirectory, getConfigInfo, getConfigInfo, getConfigInfo, getConfigName, getLogger, getManagementContext, getPathSuffix, getRegisteredMBeans, getServiceName, getServiceObjectName, getStatus, getStore, isRunning, loadConfig, makeObject, register, register, saveConfig, setStatus, setStore, start, stop, unregister, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bedework.util.jmx.BaseMBean

getServiceName, isRunning, start, stop

Methods inherited from interface org.bedework.util.jmx.ConfBaseMBean

getConfigName, getStatus, saveConfig, setStatus

Methods inherited from interface org.bedework.carddav.server.jmx.DirHandlerConfMBean

getAddressBook, getCardKind, getCardPathPrefix, getCardPathPrefixes, getClassName, getDirectory, getOwnerHref, getPathPrefix, getPrincipalPrefix, setAddressBook, setCardKind, setCardPathPrefix, setCardPathPrefixes, setClassName, setDirectory, setOwnerHref, setPathPrefix, setPrincipalPrefix

Methods inherited from interface org.bedework.util.logging.Logged

audit, debug, debug, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, error, getLogLevel, info, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsDebugEnabled, isMetricsLoggerEnabled, metrics, setLoggerClass, setLoggerClass, trace, trace, trace, warn, warn

Constructor Details

LdapDirHandlerConf

public LdapDirHandlerConf(String serviceName,
 org.bedework.util.config.ConfigurationStore store,
 String configName)

Method Details

setInitialContextFactory

public void setInitialContextFactory(String val)

Specified by:

setInitialContextFactory in interface LdapDirHandlerConfMBean

Parameters:

val -

getInitialContextFactory

public String getInitialContextFactory()

Specified by:

getInitialContextFactory in interface LdapDirHandlerConfMBean

Returns:

String

setSecurityAuthentication

public void setSecurityAuthentication(String val)

Specified by:

setSecurityAuthentication in interface LdapDirHandlerConfMBean

Parameters:

val -

getSecurityAuthentication

public String getSecurityAuthentication()

Specified by:

getSecurityAuthentication in interface LdapDirHandlerConfMBean

Returns:

String

setSecurityProtocol

public void setSecurityProtocol(String val)

Specified by:

setSecurityProtocol in interface LdapDirHandlerConfMBean

Parameters:

val - e.g. "ssl"

getSecurityProtocol

public String getSecurityProtocol()

Description copied from interface: LdapDirHandlerConfMBean

e.g "ssl"

Specified by:

getSecurityProtocol in interface LdapDirHandlerConfMBean

Returns:

String val

setProviderUrl

public void setProviderUrl(String val)

Specified by:

setProviderUrl in interface LdapDirHandlerConfMBean

Parameters:

val - URL of ldap server

getProviderUrl

public String getProviderUrl()

Description copied from interface: LdapDirHandlerConfMBean

URL of ldap server

Specified by:

getProviderUrl in interface LdapDirHandlerConfMBean

Returns:

String val

setBaseDn

public void setBaseDn(String val)

Specified by:

setBaseDn in interface LdapDirHandlerConfMBean

Parameters:

val - ldap base dn

getBaseDn

public String getBaseDn()

Specified by:

getBaseDn in interface LdapDirHandlerConfMBean

Returns:

String val

setQueryLimit

public void setQueryLimit(int val)

Description copied from interface: LdapDirHandlerConfMBean

Set the query limit - 0 for no limit

Specified by:

setQueryLimit in interface LdapDirHandlerConfMBean

Parameters:

val - the query limit - 0 for no limit

getQueryLimit

public int getQueryLimit()

Specified by:

getQueryLimit in interface LdapDirHandlerConfMBean

Returns:

int val

setAttrIds

public void setAttrIds(String val)

Specified by:

setAttrIds in interface LdapDirHandlerConfMBean

Parameters:

val - comma separated list of attribute ids

getAttrIds

public String getAttrIds()

Specified by:

getAttrIds in interface LdapDirHandlerConfMBean

Returns:

String val

setFolderObjectClass

public void setFolderObjectClass(String val)

Specified by:

setFolderObjectClass in interface LdapDirHandlerConfMBean

Parameters:

val - objectclass used to represent a folder

getFolderObjectClass

public String getFolderObjectClass()

Specified by:

getFolderObjectClass in interface LdapDirHandlerConfMBean

Returns:

String val

setAddressbookObjectClass

public void setAddressbookObjectClass(String val)

Specified by:

setAddressbookObjectClass in interface LdapDirHandlerConfMBean

Parameters:

val - Addressbook ObjectClass

getAddressbookObjectClass

public String getAddressbookObjectClass()

Specified by:

getAddressbookObjectClass in interface LdapDirHandlerConfMBean

Returns:

String val

setAddressbookEntryObjectClass

public void setAddressbookEntryObjectClass(String val)

Specified by:

setAddressbookEntryObjectClass in interface LdapDirHandlerConfMBean

Parameters:

val - Addressbook entry ObjectClass

getAddressbookEntryObjectClass

public String getAddressbookEntryObjectClass()

Specified by:

getAddressbookEntryObjectClass in interface LdapDirHandlerConfMBean

Returns:

String val

setPrincipalIdAttr

public void setPrincipalIdAttr(String val)

Specified by:

setPrincipalIdAttr in interface LdapDirHandlerConfMBean

Parameters:

val - Attribute we search for to get a principal

getPrincipalIdAttr

public String getPrincipalIdAttr()

Description copied from interface: LdapDirHandlerConfMBean

Attribute we search for to get a group

Specified by:

getPrincipalIdAttr in interface LdapDirHandlerConfMBean

Returns:

String val

setFolderIdAttr

public void setFolderIdAttr(String val)

Specified by:

setFolderIdAttr in interface LdapDirHandlerConfMBean

Parameters:

val - attribute used to designate the equivalent of a folder

getFolderIdAttr

public String getFolderIdAttr()

Specified by:

getFolderIdAttr in interface LdapDirHandlerConfMBean

Returns:

String val

setAddressbookIdAttr

public void setAddressbookIdAttr(String val)

Specified by:

setAddressbookIdAttr in interface LdapDirHandlerConfMBean

Parameters:

val - addressbook Id Attr

getAddressbookIdAttr

public String getAddressbookIdAttr()

Specified by:

getAddressbookIdAttr in interface LdapDirHandlerConfMBean

Returns:

String val

setAddressbookEntryIdAttr

public void setAddressbookEntryIdAttr(String val)

Specified by:

setAddressbookEntryIdAttr in interface LdapDirHandlerConfMBean

Parameters:

val -

getAddressbookEntryIdAttr

public String getAddressbookEntryIdAttr()

Specified by:

getAddressbookEntryIdAttr in interface LdapDirHandlerConfMBean

Returns:

String val

setGroupMemberAttr

public void setGroupMemberAttr(String val)

Description copied from interface: LdapDirHandlerConfMBean

Attribute we want back identifying a member

Specified by:

setGroupMemberAttr in interface LdapDirHandlerConfMBean

Parameters:

val -

getGroupMemberAttr

public String getGroupMemberAttr()

Description copied from interface: LdapDirHandlerConfMBean

Attribute we want back identifying a member

Specified by:

getGroupMemberAttr in interface LdapDirHandlerConfMBean

Returns:

String val

setAuthDn

public void setAuthDn(String val)

Description copied from interface: LdapDirHandlerConfMBean

If we need an id to authenticate this is it.

Specified by:

setAuthDn in interface LdapDirHandlerConfMBean

Parameters:

val -

getAuthDn

public String getAuthDn()

Description copied from interface: LdapDirHandlerConfMBean

If we need an id to authenticate this is it.

Specified by:

getAuthDn in interface LdapDirHandlerConfMBean

Returns:

String val

setAuthPw

public void setAuthPw(String val)

Description copied from interface: LdapDirHandlerConfMBean

If we need an id to authenticate this is the pw.

Specified by:

setAuthPw in interface LdapDirHandlerConfMBean

Parameters:

val -

getAuthPw

public String getAuthPw()

Description copied from interface: LdapDirHandlerConfMBean

If we need an id to authenticate this is the pw.

Specified by:

getAuthPw in interface LdapDirHandlerConfMBean

Returns:

String val

getConf

public LdapDirHandlerConfig getConf()

Overrides:

getConf in class DirHandlerConf

Returns:

current state of config