Package org.bedework.carddav.server.jmx
Interface DirHandlerConfMBean
- All Superinterfaces:
org.bedework.util.jmx.BaseMBean,org.bedework.util.jmx.ConfBaseMBean
- All Known Subinterfaces:
DbDirHandlerConfMBean,LdapDirHandlerConfMBean
- All Known Implementing Classes:
DbDirHandlerConf,DirHandlerConf,LdapDirHandlerConf
public interface DirHandlerConfMBean
extends org.bedework.util.jmx.ConfBaseMBean
Configure a carddav service dir handler
- Author:
- douglm
-
Method Summary
Modifier and TypeMethodDescriptionbooleanTrue if this prefix represents an addressbook.If set defines the default kind in this directoryGet the cardPathPrefixGet the cardPathPrefixesget the interface implementationbooleanTrue if this prefix represents a directory.The href for the ownerGet the pathPrefixGet the pathPrefixvoidsetAddressBook(boolean val) voidsetCardKind(String val) If set defines the default kind in this directoryvoidsetCardPathPrefix(String val) Set the cardPathPrefix which defines the prefix for principal cards.voidSet the cardPathPrefixes which defines the prefixes for principal cards based on an account prefix.voidsetClassName(String val) Set the interface implementationvoidsetDirectory(boolean val) voidsetOwnerHref(String val) The href for the ownervoidsetPathPrefix(String val) Set the pathPrefix which defines the paths for which we call this handler.voidsetPrincipalPrefix(String val) Set the prefix for principals which correspond to cards within this hierarchyMethods inherited from interface org.bedework.util.jmx.BaseMBean
getServiceName, isRunning, start, stopMethods inherited from interface org.bedework.util.jmx.ConfBaseMBean
getConfigName, getStatus, saveConfig, setStatus
-
Method Details
-
setPathPrefix
Set the pathPrefix which defines the paths for which we call this handler.- Parameters:
val- String
-
getPathPrefix
String getPathPrefix()Get the pathPrefix- Returns:
- String
-
setPrincipalPrefix
Set the prefix for principals which correspond to cards within this hierarchyFor example "/principals.users" might be a principal prefix handled by "/directory/users"
- Parameters:
val- String path
-
getPrincipalPrefix
String getPrincipalPrefix()Get the pathPrefix- Returns:
- String path
-
setCardPathPrefix
Set the cardPathPrefix which defines the prefix for principal cards.- Parameters:
val- String
-
getCardPathPrefix
String getCardPathPrefix()Get the cardPathPrefix- Returns:
- String
-
setCardPathPrefixes
Set the cardPathPrefixes which defines the prefixes for principal cards based on an account prefix.- Parameters:
val- String
-
getCardPathPrefixes
String getCardPathPrefixes()Get the cardPathPrefixes- Returns:
- prefixes
-
setAddressBook
void setAddressBook(boolean val) - Parameters:
val- True if this prefix represents an addressbook.
-
getAddressBook
boolean getAddressBook()True if this prefix represents an addressbook.- Returns:
- boolean
-
setDirectory
void setDirectory(boolean val) - Parameters:
val- True if this prefix represents a directory.
-
getDirectory
boolean getDirectory()True if this prefix represents a directory.- Returns:
- boolean
-
setClassName
Set the interface implementation- Parameters:
val- String
-
getClassName
String getClassName()get the interface implementation- Returns:
- String
-
setOwnerHref
The href for the owner- Parameters:
val- String
-
getOwnerHref
String getOwnerHref()The href for the owner- Returns:
- String
-
setCardKind
If set defines the default kind in this directory- Parameters:
val- String
-
getCardKind
String getCardKind()If set defines the default kind in this directory- Returns:
- String
-