org.apache.directory.server.config.beans

Class AdsBaseBean

java.lang.Object

org.apache.directory.server.config.beans.AdsBaseBean

Direct Known Subclasses:

AuthenticatorBean, ChangeLogBean, DirectoryServiceBean, ExtendedOpHandlerBean, HttpWebAppBean, IndexBean, InterceptorBean, JournalBean, PartitionBean, PasswordPolicyBean, ReplConsumerBean, SaslMechHandlerBean, ServerBean, TransportBean

public abstract class AdsBaseBean
extends java.lang.Object

A class used to store the Base ADS configuration. It can't be instanciated

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	description The description
private org.apache.directory.api.ldap.model.name.Dn	dn the DN of the entry with which this bean is associated
private boolean	enabled The enabled flag, by default we treat every config entry as enabled if ads-enabled attribute is not present or if its value is set to 'TRUE'.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdsBaseBean() Create a new BaseBean instance

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
org.apache.directory.api.ldap.model.name.Dn	getDn()
boolean	isDisabled() a convenient method to finding if this bean was disabled in the config
boolean	isEnabled()
void	setDescription(java.lang.String description) Sets the component description
void	setDn(org.apache.directory.api.ldap.model.name.Dn dn)
void	setEnabled(boolean enabled) Enable or disable the component
java.lang.String	toString()
java.lang.String	toString(java.lang.String tabs)
protected java.lang.String	toString(java.lang.String tabs, java.lang.String name, boolean value) Formated print of a boolean
protected java.lang.String	toString(java.lang.String tabs, java.lang.String name, org.apache.directory.api.ldap.model.name.Dn value) Formated print of a Dn that can be null
protected java.lang.String	toString(java.lang.String tabs, java.lang.String name, long value) Formated print of a long
protected java.lang.String	toString(java.lang.String tabs, java.lang.String name, java.lang.String value) Formated print of a String that can be null

Methods inherited from class java.lang.Object

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

Field Detail

enabled

@ConfigurationElement(attributeType="ads-enabled",
                      isOptional=true)
private boolean enabled

The enabled flag, by default we treat every config entry as enabled if ads-enabled attribute is not present or if its value is set to 'TRUE'. A config entry is treated as disabled only if the value of ads-enabled attribute is set to 'FALSE' Note: the value true/false is case insensitive

description

@ConfigurationElement(attributeType="description",
                      isOptional=true)
private java.lang.String description

The description

dn

private org.apache.directory.api.ldap.model.name.Dn dn

the DN of the entry with which this bean is associated

Constructor Detail

AdsBaseBean

protected AdsBaseBean()

Create a new BaseBean instance

Method Detail

isEnabled

public boolean isEnabled()

Returns:

true if the component is enabled

setEnabled

public void setEnabled(boolean enabled)

Enable or disable the component

Parameters:

enabled - if true, the component is enabled.

getDescription

public java.lang.String getDescription()

Returns:

the description for this component

setDescription

public void setDescription(java.lang.String description)

Sets the component description

Parameters:

description - The description

toString

protected java.lang.String toString(java.lang.String tabs,
                                    java.lang.String name,
                                    boolean value)

Formated print of a boolean

toString

protected java.lang.String toString(java.lang.String tabs,
                                    java.lang.String name,
                                    java.lang.String value)

Formated print of a String that can be null

toString

protected java.lang.String toString(java.lang.String tabs,
                                    java.lang.String name,
                                    org.apache.directory.api.ldap.model.name.Dn value)

Formated print of a Dn that can be null

isDisabled

public final boolean isDisabled()

a convenient method to finding if this bean was disabled in the config

Returns:

true if the bean was disabled, false otherwise

toString

protected java.lang.String toString(java.lang.String tabs,
                                    java.lang.String name,
                                    long value)

Formated print of a long

toString

public java.lang.String toString(java.lang.String tabs)

setDn

public void setDn(org.apache.directory.api.ldap.model.name.Dn dn)

getDn

public org.apache.directory.api.ldap.model.name.Dn getDn()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object