org.bedework.carddav.server.jmx

Class DirHandlerConf

java.lang.Object

org.bedework.util.misc.Logged

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

org.bedework.carddav.server.jmx.DirHandlerConf

All Implemented Interfaces:

DirHandlerConfMBean, org.bedework.util.jmx.BaseMBean, org.bedework.util.jmx.ConfBaseMBean

Direct Known Subclasses:

DbDirHandlerConf, LdapDirHandlerConf

public class DirHandlerConf
extends org.bedework.util.jmx.ConfBase<DirHandlerConfig>
implements DirHandlerConfMBean

Author:

douglm

Field Summary

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

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

Fields inherited from class org.bedework.util.misc.Logged

auditLoggerName, debug, errorLoggerName, metricsLoggerName

Constructor Summary

Constructors

Constructor and Description
DirHandlerConf()

Method Summary

Modifier and Type	Method and Description
boolean	getAddressBook() True if this prefix represents an addressbook.
String	getCardKind() If set defines the default kind in this directory
String	getCardPathPrefix() Get the cardPathPrefix
String	getCardPathPrefixes() Get the cardPathPrefixes
String	getClassName() get the interface implementation
DirHandlerConfig	getConf()
boolean	getDirectory() True if this prefix represents a directory.
String	getOwnerHref() The href for the owner
String	getPathPrefix() Get the pathPrefix
String	getPrincipalPrefix() Get the pathPrefix
void	init(org.bedework.util.config.ConfigurationStore configStore, DirHandlerConfig cfg, String serviceName, String configName)
String	loadConfig()
void	setAddressBook(boolean val) True if this prefix represents an addressbook.
void	setCardKind(String val) If set defines the default kind in this directory
void	setCardPathPrefix(String val) Set the cardPathPrefix which defines the prefix for principal cards.
void	setCardPathPrefixes(String val) Set the cardPathPrefixes which defines the prefixes for principal cards based on an account prefix.
void	setClassName(String val) Set the interface implementation
void	setDirectory(boolean val) True if this prefix represents a directory.
void	setOwnerHref(String val) The href for the owner
void	setPathPrefix(String val) Set the pathPrefix which defines the paths for which we call this handler.
void	setPrincipalPrefix(String val) Set the prefix for principals which correspond to cards within this hierarchy

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

createObjectName, getConfig, getConfigInfo, getConfigInfo, getConfigInfo, getConfigName, getConfigPname, getConfigUri, getManagementContext, getPathSuffix, getRegisteredMBeans, getServiceName, getServiceObjectName, getStatus, getStore, isRunning, loadConfig, loadOnlyConfig, makeObject, register, register, saveConfig, setConfigName, setConfigPname, setConfigUri, setPathSuffix, setServiceName, setStatus, setStore, start, stop, unregister, unregister

Methods inherited from class org.bedework.util.misc.Logged

audit, debug, enableAuditLogger, enableErrorLogger, enableMetricsLogger, error, error, getAuditLoggerIfEnabled, getErrorLoggerIfEnabled, getLogger, getLogger, getMetricsLoggerIfEnabled, info, isAuditLoggerEnabled, isErrorLoggerEnabled, isMetricsLoggerEnabled, metrics, warn

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.ConfBaseMBean

getConfigName, getStatus, saveConfig, setConfigName, setStatus

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

getServiceName, isRunning, start, stop

Constructor Detail

DirHandlerConf

public DirHandlerConf()

Method Detail

init

public void init(org.bedework.util.config.ConfigurationStore configStore,
                 DirHandlerConfig cfg,
                 String serviceName,
                 String configName)

Parameters:

configStore -

cfg -

serviceName -

configName -

loadConfig

public String loadConfig()

Specified by:

loadConfig in class org.bedework.util.jmx.ConfBase<DirHandlerConfig>

setPathPrefix

public void setPathPrefix(String val)

Description copied from interface: DirHandlerConfMBean

Set the pathPrefix which defines the paths for which we call this handler.

Specified by:

setPathPrefix in interface DirHandlerConfMBean

Parameters:

val - String

getPathPrefix

public String getPathPrefix()

Description copied from interface: DirHandlerConfMBean

Get the pathPrefix

Specified by:

getPathPrefix in interface DirHandlerConfMBean

Returns:

String

setPrincipalPrefix

public void setPrincipalPrefix(String val)

Description copied from interface: DirHandlerConfMBean

Set the prefix for principals which correspond to cards within this hierarchy

For example "/principals.users" might be a principal prefix handled by "/directory/users"

Specified by:

setPrincipalPrefix in interface DirHandlerConfMBean

Parameters:

val - String path

getPrincipalPrefix

public String getPrincipalPrefix()

Description copied from interface: DirHandlerConfMBean

Get the pathPrefix

Specified by:

getPrincipalPrefix in interface DirHandlerConfMBean

Returns:

String path

setCardPathPrefix

public void setCardPathPrefix(String val)

Description copied from interface: DirHandlerConfMBean

Set the cardPathPrefix which defines the prefix for principal cards.

Specified by:

setCardPathPrefix in interface DirHandlerConfMBean

Parameters:

val - String

getCardPathPrefix

public String getCardPathPrefix()

Description copied from interface: DirHandlerConfMBean

Get the cardPathPrefix

Specified by:

getCardPathPrefix in interface DirHandlerConfMBean

Returns:

String

setCardPathPrefixes

public void setCardPathPrefixes(String val)

Description copied from interface: DirHandlerConfMBean

Set the cardPathPrefixes which defines the prefixes for principal cards based on an account prefix.

Specified by:

setCardPathPrefixes in interface DirHandlerConfMBean

Parameters:

val - String

getCardPathPrefixes

public String getCardPathPrefixes()

Description copied from interface: DirHandlerConfMBean

Get the cardPathPrefixes

Specified by:

getCardPathPrefixes in interface DirHandlerConfMBean

Returns:

prefixes

setAddressBook

public void setAddressBook(boolean val)

Description copied from interface: DirHandlerConfMBean

True if this prefix represents an addressbook.

Specified by:

setAddressBook in interface DirHandlerConfMBean

getAddressBook

public boolean getAddressBook()

Description copied from interface: DirHandlerConfMBean

True if this prefix represents an addressbook.

Specified by:

getAddressBook in interface DirHandlerConfMBean

Returns:

boolean

setDirectory

public void setDirectory(boolean val)

Description copied from interface: DirHandlerConfMBean

True if this prefix represents a directory.

Specified by:

setDirectory in interface DirHandlerConfMBean

getDirectory

public boolean getDirectory()

Description copied from interface: DirHandlerConfMBean

True if this prefix represents a directory.

Specified by:

getDirectory in interface DirHandlerConfMBean

Returns:

boolean

setClassName

public void setClassName(String val)

Description copied from interface: DirHandlerConfMBean

Set the interface implementation

Specified by:

setClassName in interface DirHandlerConfMBean

Parameters:

val - String

getClassName

public String getClassName()

Description copied from interface: DirHandlerConfMBean

get the interface implementation

Specified by:

getClassName in interface DirHandlerConfMBean

Returns:

String

setOwnerHref

public void setOwnerHref(String val)

Description copied from interface: DirHandlerConfMBean

The href for the owner

Specified by:

setOwnerHref in interface DirHandlerConfMBean

Parameters:

val - String

getOwnerHref

public String getOwnerHref()

Description copied from interface: DirHandlerConfMBean

The href for the owner

Specified by:

getOwnerHref in interface DirHandlerConfMBean

Returns:

String

setCardKind

public void setCardKind(String val)

Description copied from interface: DirHandlerConfMBean

If set defines the default kind in this directory

Specified by:

setCardKind in interface DirHandlerConfMBean

Parameters:

val - String

getCardKind

public String getCardKind()

Description copied from interface: DirHandlerConfMBean

If set defines the default kind in this directory

Specified by:

getCardKind in interface DirHandlerConfMBean

Returns:

String

getConf

public DirHandlerConfig getConf()

Returns:

current state of config