com.nitido.nimx.nuggets.iplanetset.dirpool
Class IPlanetSettingsNuggetImpl

java.lang.Object
  com.nitido.nim.Nugget
      com.nitido.nim.NonCachableNugget
          com.nitido.nimx.nuggets.iplanetset.IPlanetSettingsNugget
              com.nitido.nimx.nuggets.iplanetset.dirpool.IPlanetSettingsNuggetImpl

All Implemented Interfaces:

CredentialConstants, java.io.Serializable

public class IPlanetSettingsNuggetImpl
extends IPlanetSettingsNugget

IPlanetSettingsNugget is responsible for accessing and modifying the personal preferences for iPlanet/SunONE Web Technologies Servers that have been stored in a backend LDAP server. Although it was designed mainly for the Calendar Server and Message Server, it can be used to support all other services that utilizes the LDAP to store user preferences.

This nugget utilizes the com.nitido.nimx.services.dirpool.mozilla.DirPoolServiceImpl for obtaining the connections to the backend LDAP servers. Therefore, it does not contain any directory connection pool management logic. If a deployer want to adjust the connection pool settings, he/she should modify the settings for the DirPoolService instead.

Under most circumstances, a developer should use the user space implementation of the iPlanetSettingsNugget instead of this implementation. This implementation is designed to be used only for situations where the IMS settings and the regular user profiles are not stored in the same set of LDAP servers.

When using this nugget, the developer should pay attention to the replication issue described in the class descriptor JavaDoc of com.nitido.nimx.nuggets.iplanetset.IPlanetSettingsNugget.

Settings The settings used by IPlanetSettingsNugget are:

Name	Constant	Type	Description
readpool	KEY_READ_POOL	String	The name of the directory connection pool to be used for read only access.
writepool	KEY_WRITE_POOL	String	The name of the directory connection pool to be used for write access. If this name is the same as the one specified in the KEY_READ_POOL, both read and write access will share the same instance of Directory object.
dn.tokenkey	KEY_DN_PREFIX	String	The key of the credential token that contains the DN of the user's LDAP entry. This configuration allows the authentication service to determine the user's LDAP entry DN first and stuff it into the user's identifying credential. This feature is great for cases where the user's DN cannot be determined statically. (i.e. we must search for the entry first). If this setting is provided, the settings "dn.prefix" and "dn.postfix" will be ignored.
dn.prefix	KEY_DN_PREFIX	String	The prefix for the DN of the user's LDAP entry. For example, If the user profile's LDAP entry is "uid=userid,o=my.company,o=isp", the dn.prefix setting should be "uid=". This setting must be specified if "dn.tokenkey" is not specified.
dn.postfix	KEY_DN_PREFIX	String	The postfix for the DN of the user's LDAP entry. For example, If the user profile's LDAP entry is "uid=userid,o=my.company,o=isp", the dn.postfix setting should be ",o=my.company,o=isp". This setting must be specified if "dn.tokenkey" is not specified.
bindas.dn	KEY_BIND_AS_DN	String	The DN to be used for binding to the backend LDAP server. If this setting is not specified, the nugget will bind to the backend with the user's DN. The user's password will be the identyfing credential's token "KEY_PASSWORD". Moreover, the "bindas.pwd" setting will be ignored.
bindas.pwd	KEY_BIND_AS_PWD	String	The password to be used for binding to the backend LDAP server. This setting is required if the "bindas.dn" is specified. Otherwise, it is ignored.

See Also:

Serialized Form

Field Summary

protected java.lang.String	_bindDN
protected java.lang.String	_bindPwd
protected java.util.HashMap	_cachedAttr
protected OpenHash	_modifyAttr
protected DirectoryImpl	_readDir
protected java.util.HashSet	_removeAttr
protected int	_transactionLevel
protected java.lang.String	_userDN
protected DirectoryImpl	_writeDir
static java.lang.String	KEY_BIND_AS_DN
static java.lang.String	KEY_BIND_AS_PWD
static java.lang.String	KEY_DN_POSTFIX
static java.lang.String	KEY_DN_PREFIX
static java.lang.String	KEY_DN_TOKEN_KEY
static java.lang.String	KEY_READ_POOL
static java.lang.String	KEY_WRITE_POOL

Fields inherited from class com.nitido.nim.Nugget

_entity, _nim, _nuggetName, _settings

Fields inherited from interface com.nitido.nim.CredentialConstants

CRED_ADMIN, CRED_CONTAINER, CRED_HELPDESK, CRED_SYSTEM, CRED_USER, KEY_PASSWORD

Constructor Summary

IPlanetSettingsNuggetImpl(NuggetVisa visa)
Default Nugget constructor.

Method Summary

void	abortTransaction() Abort a batch of settings change.
void	activate() Used by NiM Nugget mechanism.
void	commitTransaction() Commits a batch of settings change.
protected void	connectRead()
protected void	connectWrite()
void	deactivate() Used by NiM Nugget mechnanism.
protected void	disconnectRead()
protected void	disconnectWrite()
java.lang.String	getDescriptor() Used by NiM Nugget mechnanism.
java.lang.String[]	getMultiValues(java.lang.String attribute) Returns all values of the attribute in the user's entry.
protected void	initImpl() This method is called by the init() method after the member variables _nuggetName, _entity and _settings are assigned.
protected void	removeMultiValues(java.lang.String attribute) Removes the specified attribute from the user's entry.
void	setMultiValues(java.lang.String attribute, java.lang.String[] values) Sets the attribute/value for the user's entry in the Directory.
void	setSingleValue(java.lang.String attribute, java.lang.String value) Sets the attribute/value pair for the user's entry in the Directory.
void	startTransaction() Starts a batch of settings change.

Methods inherited from class com.nitido.nimx.nuggets.iplanetset.IPlanetSettingsNugget

addFilter, arrayToVector, checkInt, checkNonNull, containsValue, createUniqueArray, getCommonName, getComposeTextSize, getComposeWidth, getCopyForward, getCopyForwardEnabled, getCopySend, getExtendedCalendarPref, getExtendedMailPref, getExtendedPref, getExternalMailSetting, getFilters, getNotificationEmailAddress, getNotificationFrom, getNotificationListOption, getNotificationOption, getNotificationPhoneFrom, getNotificationPhoneListOption, getNotificationPhoneNumber, getNotificationPhoneOption, getNotificationPhoneUrgentOption, getNotificationUrgentOption, getPaginationSize, getReplyInclude, getReplyTo, getSignature, getSignatureEnabled, getSingleValue, getVacationMessageEnabled, getVacationMessageEndDate, getVacationMessageExternal, getVacationMessageInternal, getVacationMessageRepeatDays, getVacationMessageStartDate, getVacationMessageSubject, getVCard, getVCardEnabled, isExtendedMailPrefTrue, isLegalNotificationOption, removeExtendedPref, removeStringFromArray, replaceStringInArray, setBooleanExtendedMailPref, setCommonName, setComposeTextSize, setComposeWidth, setCopyForward, setCopyForwardEnabled, setCopySend, setExtendedCalendarPref, setExtendedMailPref, setExtendedPref, setExternalMailSetting, setFilters, setNotificationEmailAddress, setNotificationFrom, setNotificationListOption, setNotificationOption, setNotificationPhoneFrom, setNotificationPhoneListOption, setNotificationPhoneOption, setNotificationPhoneUrgentOption, setNotificationUrgentOption, setPaginationSize, setReplyInclude, setReplyTo, setSignature, setSignatureEnabled, setVacationMessageEnabled, setVacationMessageExternal, setVacationMessageInternal, setVacationMessageRepeatDays, setVacationMessageSubject, setVCard, setVCardEnabled, vectorToArray

Methods inherited from class com.nitido.nim.NonCachableNugget

isCachable

Methods inherited from class com.nitido.nim.Nugget

destroy, destroyImpl, getEntity, getNuggetName, getSetting, getSettings, init, requestBegin, requestEnd

Methods inherited from class java.lang.Object

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

Field Detail

KEY_READ_POOL

public static final java.lang.String KEY_READ_POOL

See Also:

Constant Field Values

KEY_WRITE_POOL

public static final java.lang.String KEY_WRITE_POOL

See Also:

Constant Field Values

KEY_DN_PREFIX

public static final java.lang.String KEY_DN_PREFIX

See Also:

Constant Field Values

KEY_DN_POSTFIX

public static final java.lang.String KEY_DN_POSTFIX

See Also:

Constant Field Values

KEY_DN_TOKEN_KEY

public static final java.lang.String KEY_DN_TOKEN_KEY

See Also:

Constant Field Values

KEY_BIND_AS_DN

public static final java.lang.String KEY_BIND_AS_DN

See Also:

Constant Field Values

KEY_BIND_AS_PWD

public static final java.lang.String KEY_BIND_AS_PWD

See Also:

Constant Field Values

_readDir

protected transient DirectoryImpl _readDir

_writeDir

protected transient DirectoryImpl _writeDir

_userDN

protected transient java.lang.String _userDN

_bindDN

protected transient java.lang.String _bindDN

_bindPwd

protected transient java.lang.String _bindPwd

_modifyAttr

protected transient OpenHash _modifyAttr

_removeAttr

protected transient java.util.HashSet _removeAttr

_cachedAttr

protected transient java.util.HashMap _cachedAttr

_transactionLevel

protected transient int _transactionLevel

Constructor Detail

IPlanetSettingsNuggetImpl

public IPlanetSettingsNuggetImpl(NuggetVisa visa)

Default Nugget constructor.

Method Detail

activate

public void activate()
              throws ActivationException

Used by NiM Nugget mechanism. An application developer should never invoke this.

Overrides:

activate in class IPlanetSettingsNugget

Throws:

ActivationException - If unable to activate the Nugget

deactivate

public void deactivate()
                throws ActivationException

Used by NiM Nugget mechnanism. An application developer should never invoke this.

Overrides:

deactivate in class IPlanetSettingsNugget

Throws:

ActivationException - If unable to deactivate the Nugget

initImpl

protected void initImpl()
                 throws InitializationFailedException,
                        InvalidSettingException

Description copied from class: Nugget

This method is called by the init() method after the member variables _nuggetName, _entity and _settings are assigned. This method allows nugget implementations to put in code for initializing itself.

Specified by:

initImpl in class Nugget

Throws:

InitializationFailedException - If unable to initialize the nugget with the given parameters.

InvalidSettingException - If any of the expected initialization settings are null.

getDescriptor

public java.lang.String getDescriptor()

Used by NiM Nugget mechnanism. An application developer should never invoke this.

Overrides:

getDescriptor in class IPlanetSettingsNugget

Returns:

The string with the description of the Nugget.

connectRead

protected void connectRead()
                    throws IPlanetServerException

Throws:

IPlanetServerException

disconnectRead

protected void disconnectRead()

connectWrite

protected void connectWrite()
                     throws IPlanetServerException

Throws:

IPlanetServerException

disconnectWrite

protected void disconnectWrite()

setSingleValue

public void setSingleValue(java.lang.String attribute,
                           java.lang.String value)
                    throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets the attribute/value pair for the user's entry in the Directory. Any existing values will be removed (i.e. this is a "replace" instead of "add".)

Specified by:

setSingleValue in class IPlanetSettingsNugget

Parameters:

attribute - The attribute name

value - The new value.

Throws:

IPlanetServerException - If there is a connection problem with the Directory object.

getMultiValues

public java.lang.String[] getMultiValues(java.lang.String attribute)
                                  throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns all values of the attribute in the user's entry.

Note: if the attribute has only one value stored, it simply returns an array of size one no matter whether the underlying attribute is single-value or multi-values.

Specified by:

getMultiValues in class IPlanetSettingsNugget

Returns:

values Array of values associated with attribute. If the attribute has no value, it will return a String array of size 0.

Throws:

IPlanetServerException - If there is a connection problem with the Directory object.

setMultiValues

public void setMultiValues(java.lang.String attribute,
                           java.lang.String[] values)
                    throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets the attribute/value for the user's entry in the Directory. Any existing values will be removed (i.e. this is a "replace" instead of "add".)

Specified by:

setMultiValues in class IPlanetSettingsNugget

Parameters:

attribute - The attribute name

values - The new values.

Throws:

IPlanetServerException - If there is a connection problem with the Directory object.

removeMultiValues

protected void removeMultiValues(java.lang.String attribute)
                          throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Removes the specified attribute from the user's entry.

Specified by:

removeMultiValues in class IPlanetSettingsNugget

Throws:

IPlanetServerException - If there is a connection problem with the Directory object.

startTransaction

public void startTransaction()
                      throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Starts a batch of settings change. If you need to set/get a number of attributes in a row, you should invoke this method before the calls.

Please see the class description for more details on why and when to use these transaction methods.

Specified by:

startTransaction in class IPlanetSettingsNugget

Throws:

IPlanetServerException

commitTransaction

public void commitTransaction()
                       throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Commits a batch of settings change. If you need to set/get a number of attributes in a row, you should use this method after the calls.

Please see the class description for more details on why and when to use these transaction methods.

Specified by:

commitTransaction in class IPlanetSettingsNugget

Throws:

IPlanetServerException

abortTransaction

public void abortTransaction()
                      throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Abort a batch of settings change. This method will drop the transaction and LDAP connection. All setXXX changes after the startTransaction() method call will be lost. This method is is usually called when the application encountered an exception and need to drop the transaction.

If no transaction was in process when this method is called, this method will not do anything and no exception will be thrown.

Please see the class description for more details on why and when to use these transaction methods.

Specified by:

abortTransaction in class IPlanetSettingsNugget

Throws:

IPlanetServerException