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

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

All Implemented Interfaces:

CredentialConstants, java.io.Serializable

public class IPlanetSettingsNuggetImpl
extends IPlanetSettingsNugget

A fake implementation of the IPlanetSettingsNugget. Methods do nothing or return a simple value.

See Also:

Serialized Form

Field Summary

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	connect()
boolean	containsValue(java.lang.String attribute, java.lang.String value) Returns true if the attribute contains the specified value.
void	deactivate() Used by NiM Nugget mechnanism.
protected void	disconnect()
java.lang.String	getCommonName() To retrieve the common name of the mail user.
int	getComposeTextSize() To retrieve an int value of the compose message text font size.
int	getComposeWidth() To retrieve an int value of the compose window width.
java.lang.String[]	getCopyForward() To retrieve the copy forward list of the mail user.
boolean	getCopyForwardEnabled() To retrieve the copy forward enabled/disabled flag.
boolean	getCopySend() To retrieve an indicator for the copysend field.
java.lang.String	getDescriptor() Used by NiM Nugget mechnanism.
java.lang.String	getExtendedCalendarPref(java.lang.String prefName) Returns a single value from a set of iPlanet icsExtendedUserPrefs attributes.
java.lang.String	getExtendedMailPref(java.lang.String prefName) Returns a single value from a set of iPlanet nswmExtendedUserPrefs attributes.
java.lang.String	getExtendedPref(java.lang.String attrName, java.lang.String prefName) Returns a single value from a set of preferences in an extended attribute.
java.util.Vector	getExternalMailSetting() Get the External Mail Setting.
java.util.Vector	getFilters() To retrieve filters for this user.
java.lang.String[]	getMultiValues(java.lang.String attribute) Returns all values of the attribute in the user's entry.
java.lang.String	getNotificationEmailAddress() Returns the E-mail address that notification messages are sent to.
java.lang.String[]	getNotificationFrom() Returns an array of String objects each containing an e-mail address that can trigger a notification when mail is received from that address.
boolean	getNotificationListOption() Gets the e-mail notifictaion list option.
java.lang.String	getNotificationOption() Returns the current e-mail notification option setting.
java.lang.String[]	getNotificationPhoneFrom() Returns an array of String objects each containing an e-mail address that triggers PCS phone based notification.
boolean	getNotificationPhoneListOption() Gets the phone notifictaion list option.
java.lang.String	getNotificationPhoneNumber() Returns the PCS phone number to send notification to.
java.lang.String	getNotificationPhoneOption() Returns the current phone notification option setting.
boolean	getNotificationPhoneUrgentOption() Returns whether the urgent option is set for phone notification.
boolean	getNotificationUrgentOption() Returns whether the urgent option is set for e-mail notification.
int	getPaginationSize() To retrieve an int value of the page size.
boolean	getReplyInclude() To retrieve an indicator for the reply included flag.
java.lang.String	getReplyTo() To retrieve the name of the reply to field.
java.lang.String	getSignature() To retrieve the signature of the mail user.
boolean	getSignatureEnabled() To retrieve the flag indicating whether the user signature is enabled or not.
java.lang.String	getSingleValue(java.lang.String attribute) Returns a single value of the attribute in the user's entry.
boolean	getVacationMessageEnabled() To retrieve an indicator whether the vacation message has been enabled.
java.lang.String	getVacationMessageEndDate() Retrieves the effective end date of the vacation message.
java.lang.String	getVacationMessageExternal() To retrieve the vacation message for external recipients.
java.lang.String	getVacationMessageInternal() To retrieve the vacation message for internal recipients.
int	getVacationMessageRepeatDays() Returns the number of days between sending a repeat of the vacation message to senders.
java.lang.String	getVacationMessageStartDate() Retrieves the effective start date of the vacation message.
java.lang.String	getVacationMessageSubject() To retrieve the vacation message subject line.
java.lang.String	getVCard() To retrieve the vCard of the mail user.
boolean	getVCardEnabled() To retrieve the vCard enabled flag of the mail user.
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	setCommonName(java.lang.String commonName) To set the common name of the mail user.
void	setComposeTextSize(int composeTextSize) To set the compose text font size.
void	setComposeWidth(int composeWidth) To set the width of the compose window.
void	setCopyForward(java.lang.String[] copyForwardList) To set the copy forward list for the mail user.
void	setCopyForwardEnabled(boolean enable) To set the copy forward enabled/disabled flag.
void	setCopySend(boolean copySend) To set the copy send flag.
void	setExtendedCalendarPref(java.lang.String prefName, java.lang.String prefValue) Sets an icsExtendedUserPrefs value.
void	setExtendedMailPref(java.lang.String prefName, java.lang.String prefValue) Sets an nswmExtendedUserPrefs value.
void	setExtendedPref(java.lang.String attrName, java.lang.String prefName, java.lang.String prefValue) Sets a value within a set of preferences in an extended attribute.
void	setExternalMailSetting(java.util.Vector extMailSettings) Set the External Mail Setting.
void	setFilters(java.util.Vector filters) To set the message filters for the user.
void	setMultiValues(java.lang.String attribute, java.lang.String[] values) Sets the attribute/value for the user's entry in the Directory.
void	setNotificationEmailAddress(java.lang.String address) Sets the E-mail address that notification messages are sent to.
void	setNotificationFrom(java.lang.String[] addresses) Sets an array of String objects each containing an e-mail address that can trigger a notification when mail is received from that address.
void	setNotificationListOption(boolean option) Sets the e-mail notifictaion list option.
void	setNotificationOption(java.lang.String option) Sets the current e-mail notification option setting.
void	setNotificationPhoneFrom(java.lang.String[] addresses) Sets an array of String objects each containing an e-mail address that triggers PCS phone based notification.
void	setNotificationPhoneListOption(boolean option) Sets the phone notifictaion list option.
void	setNotificationPhoneOption(java.lang.String option) Sets the current phone notification option setting.
void	setNotificationPhoneUrgentOption(boolean urgent) Sets whether the urgent option is set for phone notification.
void	setNotificationUrgentOption(boolean urgent) Sets whether the urgent option is set for e-mail notification.
void	setPaginationSize(int pageSize) To set the page size..
void	setReplyInclude(boolean replyInclude) To set the reply included flag.
void	setReplyTo(java.lang.String replyTo) To set the reply to field.
void	setSignature(java.lang.String signature) To set the signature of the mail user.
void	setSignatureEnabled(boolean enable) To set the signature enabled flag for the mail user.
void	setSingleValue(java.lang.String attribute, java.lang.String value) Sets the attribute/value pair for the user's entry in the Directory.
void	setVacationMessageEnabled(boolean enable, java.lang.String startDate, java.lang.String endDate) To set the indicator to enable or disable vacation message.
void	setVacationMessageExternal(java.lang.String vacMsg) To set the vacation message for external recipients.
void	setVacationMessageInternal(java.lang.String vacMsg) To set the vacation message for internal recipients.
void	setVacationMessageRepeatDays(int days) Sets the number of days between sending a repeat of the vacation message to senders.
void	setVacationMessageSubject(java.lang.String vacMsgSubject) To set the vacation message subject.
void	setVCard(java.lang.String vcard) To set the vCard for the mail user.
void	setVCardEnabled(boolean enable) To set the vCard enable/disable flag for the mail user.
void	startTransaction() Starts a batch of settings change.

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

addFilter, arrayToVector, checkInt, checkNonNull, createUniqueArray, isExtendedMailPrefTrue, isLegalNotificationOption, removeExtendedPref, removeStringFromArray, replaceStringInArray, setBooleanExtendedMailPref, 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

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

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.

getExternalMailSetting

public java.util.Vector getExternalMailSetting()
                                        throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Get the External Mail Setting.

Overrides:

getExternalMailSetting in class IPlanetSettingsNugget

Returns:

a vector of ExternalMailSetting object.

Throws:

IPlanetServerException

setExternalMailSetting

public void setExternalMailSetting(java.util.Vector extMailSettings)
                            throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Set the External Mail Setting.

Overrides:

setExternalMailSetting in class IPlanetSettingsNugget

Parameters:

extMailSettings - a vector of ExternalMailSetting object.

Throws:

IPlanetServerException

getVacationMessageSubject

public java.lang.String getVacationMessageSubject()
                                           throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the vacation message subject line.

Overrides:

getVacationMessageSubject in class IPlanetSettingsNugget

Returns:

String value of the vacation message's subject.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setVacationMessageSubject

public void setVacationMessageSubject(java.lang.String vacMsgSubject)
                               throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the vacation message subject.

Overrides:

setVacationMessageSubject in class IPlanetSettingsNugget

Parameters:

vacMsgSubject - String value for the vacation message.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getVacationMessageInternal

public java.lang.String getVacationMessageInternal()
                                            throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the vacation message for internal recipients.

Overrides:

getVacationMessageInternal in class IPlanetSettingsNugget

Returns:

String value of the vacation message.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setVacationMessageInternal

public void setVacationMessageInternal(java.lang.String vacMsg)
                                throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the vacation message for internal recipients.

Overrides:

setVacationMessageInternal in class IPlanetSettingsNugget

Parameters:

vacMsg - String value for the vacation message.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getVacationMessageExternal

public java.lang.String getVacationMessageExternal()
                                            throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the vacation message for external recipients.

Overrides:

getVacationMessageExternal in class IPlanetSettingsNugget

Returns:

String value of the vacation message.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setVacationMessageExternal

public void setVacationMessageExternal(java.lang.String vacMsg)
                                throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the vacation message for external recipients.

Overrides:

setVacationMessageExternal in class IPlanetSettingsNugget

Parameters:

vacMsg - String value for the vacation message.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getVacationMessageRepeatDays

public int getVacationMessageRepeatDays()
                                 throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns the number of days between sending a repeat of the vacation message to senders.

If the user has not set this setting before, it will return the default value, which is 0.

Overrides:

getVacationMessageRepeatDays in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setVacationMessageRepeatDays

public void setVacationMessageRepeatDays(int days)
                                  throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets the number of days between sending a repeat of the vacation message to senders.

Overrides:

setVacationMessageRepeatDays in class IPlanetSettingsNugget

Parameters:

days - The number of days

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setVacationMessageEnabled

public void setVacationMessageEnabled(boolean enable,
                                      java.lang.String startDate,
                                      java.lang.String endDate)
                               throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the indicator to enable or disable vacation message.

Overrides:

setVacationMessageEnabled in class IPlanetSettingsNugget

Parameters:

enable - boolean value enable or disable the vacation message

startDate - The date that vacation settings begin to take effect. In format YYYYMMDDhhmmssZ.

endDate - The date that vacation settings cease to take effect. In format YYYYMMDDhhmmssZ.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getVacationMessageEnabled

public boolean getVacationMessageEnabled()
                                  throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve an indicator whether the vacation message has been enabled.

Overrides:

getVacationMessageEnabled in class IPlanetSettingsNugget

Returns:

boolean - (vacation message enabled/disabled)

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getVacationMessageStartDate

public java.lang.String getVacationMessageStartDate()
                                             throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Retrieves the effective start date of the vacation message.

Overrides:

getVacationMessageStartDate in class IPlanetSettingsNugget

Returns:

date String representation of a date in format YYYYMMDDhhmmssZ

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getVacationMessageEndDate

public java.lang.String getVacationMessageEndDate()
                                           throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Retrieves the effective end date of the vacation message.

Overrides:

getVacationMessageEndDate in class IPlanetSettingsNugget

Returns:

date String representation of a date in format YYYYMMDDhhmmssZ

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getFilters

public java.util.Vector getFilters()
                            throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve filters for this user.

Overrides:

getFilters in class IPlanetSettingsNugget

Returns:

a vector of Filter objects. If no filter has been set, an empty vector will be returned.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setFilters

public void setFilters(java.util.Vector filters)
                throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the message filters for the user.

Overrides:

setFilters in class IPlanetSettingsNugget

Parameters:

filters - a vector of the Filter objects that represent the new filter settings.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getSignature

public java.lang.String getSignature()
                              throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the signature of the mail user.

Overrides:

getSignature in class IPlanetSettingsNugget

Returns:

String - value of the mail signature file.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setSignature

public void setSignature(java.lang.String signature)
                  throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the signature of the mail user.

Overrides:

setSignature in class IPlanetSettingsNugget

Parameters:

signature - String value of the signature file

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getSignatureEnabled

public boolean getSignatureEnabled()
                            throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the flag indicating whether the user signature is enabled or not.

Overrides:

getSignatureEnabled in class IPlanetSettingsNugget

Returns:

boolean - signature enable/disable flag.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setSignatureEnabled

public void setSignatureEnabled(boolean enable)
                         throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the signature enabled flag for the mail user.

Overrides:

setSignatureEnabled in class IPlanetSettingsNugget

Parameters:

enable - boolean value of the signature enabled flag.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getVCard

public java.lang.String getVCard()
                          throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the vCard of the mail user.

Overrides:

getVCard in class IPlanetSettingsNugget

Returns:

String - value of the vCard.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setVCard

public void setVCard(java.lang.String vcard)
              throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the vCard for the mail user.

Overrides:

setVCard in class IPlanetSettingsNugget

Parameters:

vcard - String value of the vCard.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getVCardEnabled

public boolean getVCardEnabled()
                        throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the vCard enabled flag of the mail user.

Overrides:

getVCardEnabled in class IPlanetSettingsNugget

Returns:

boolean - value of the vCard enable/disable flag

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setVCardEnabled

public void setVCardEnabled(boolean enable)
                     throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the vCard enable/disable flag for the mail user.

Overrides:

setVCardEnabled in class IPlanetSettingsNugget

Parameters:

enable - boolean value of the vCard enable/disable flag.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getCopyForwardEnabled

public boolean getCopyForwardEnabled()
                              throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the copy forward enabled/disabled flag.

Overrides:

getCopyForwardEnabled in class IPlanetSettingsNugget

Returns:

boolean - value of the copy forward enable/disable flag

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setCopyForwardEnabled

public void setCopyForwardEnabled(boolean enable)
                           throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the copy forward enabled/disabled flag.

Overrides:

setCopyForwardEnabled in class IPlanetSettingsNugget

Parameters:

enable - boolean value of the copy forward enable/disable flag.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getCopyForward

public java.lang.String[] getCopyForward()
                                  throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the copy forward list of the mail user.

Overrides:

getCopyForward in class IPlanetSettingsNugget

Returns:

String[] - array value of the copy forward list.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setCopyForward

public void setCopyForward(java.lang.String[] copyForwardList)
                    throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the copy forward list for the mail user.

Overrides:

setCopyForward in class IPlanetSettingsNugget

Parameters:

copyForwardList - String[] array value of the copy forward list.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getCommonName

public java.lang.String getCommonName()
                               throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the common name of the mail user.

Overrides:

getCommonName in class IPlanetSettingsNugget

Returns:

String - value of the user common name

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setCommonName

public void setCommonName(java.lang.String commonName)
                   throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the common name of the mail user.

Overrides:

setCommonName in class IPlanetSettingsNugget

Parameters:

commonName - String value of the user common name.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getReplyTo

public java.lang.String getReplyTo()
                            throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve the name of the reply to field.

Overrides:

getReplyTo in class IPlanetSettingsNugget

Returns:

String - value of the reply to field.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setReplyTo

public void setReplyTo(java.lang.String replyTo)
                throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the reply to field.

Overrides:

setReplyTo in class IPlanetSettingsNugget

Parameters:

replyTo - String value of the reply to field.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getCopySend

public boolean getCopySend()
                    throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve an indicator for the copysend field.

Overrides:

getCopySend in class IPlanetSettingsNugget

Returns:

boolean - value of the copy send flag.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setCopySend

public void setCopySend(boolean copySend)
                 throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the copy send flag.

Overrides:

setCopySend in class IPlanetSettingsNugget

Parameters:

copySend - boolean value of the copy send flag.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getReplyInclude

public boolean getReplyInclude()
                        throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve an indicator for the reply included flag.

Overrides:

getReplyInclude in class IPlanetSettingsNugget

Returns:

boolean - value of the reply included flag.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setReplyInclude

public void setReplyInclude(boolean replyInclude)
                     throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the reply included flag.

Overrides:

setReplyInclude in class IPlanetSettingsNugget

Parameters:

replyInclude - boolean value of the reply include flag

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getComposeWidth

public int getComposeWidth()
                    throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve an int value of the compose window width.

If the user has not set this setting before, it will return the default value, which is 80.

Overrides:

getComposeWidth in class IPlanetSettingsNugget

Returns:

int - width value of the compose window.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setComposeWidth

public void setComposeWidth(int composeWidth)
                     throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the width of the compose window.

Overrides:

setComposeWidth in class IPlanetSettingsNugget

Parameters:

composeWidth - int value of the width of the compose window.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getPaginationSize

public int getPaginationSize()
                      throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve an int value of the page size.

If the user has not set this setting before, it will return the default value, which is 10.

Overrides:

getPaginationSize in class IPlanetSettingsNugget

Returns:

int - size of the page.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setPaginationSize

public void setPaginationSize(int pageSize)
                       throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the page size..

Overrides:

setPaginationSize in class IPlanetSettingsNugget

Parameters:

pageSize - int value of the page size.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getComposeTextSize

public int getComposeTextSize()
                       throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To retrieve an int value of the compose message text font size.

If the user has not set this setting before, it will return the default value, which is 12.

Overrides:

getComposeTextSize in class IPlanetSettingsNugget

Returns:

int - size of the compose message text font size

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setComposeTextSize

public void setComposeTextSize(int composeTextSize)
                        throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

To set the compose text font size.

Overrides:

setComposeTextSize in class IPlanetSettingsNugget

Parameters:

composeTextSize - int value of the compose message text font size.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getNotificationEmailAddress

public java.lang.String getNotificationEmailAddress()
                                             throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns the E-mail address that notification messages are sent to.

Overrides:

getNotificationEmailAddress in class IPlanetSettingsNugget

Returns:

address The e-mail address to send notifications to.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setNotificationEmailAddress

public void setNotificationEmailAddress(java.lang.String address)
                                 throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets the E-mail address that notification messages are sent to.

Overrides:

setNotificationEmailAddress in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getNotificationFrom

public java.lang.String[] getNotificationFrom()
                                       throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns an array of String objects each containing an e-mail address that can trigger a notification when mail is received from that address.

Overrides:

getNotificationFrom in class IPlanetSettingsNugget

Returns:

addresses Returns an array of String objects each containing an e-mail address that can trigger a notification when mail is received from that address.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setNotificationFrom

public void setNotificationFrom(java.lang.String[] addresses)
                         throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets an array of String objects each containing an e-mail address that can trigger a notification when mail is received from that address.

Overrides:

setNotificationFrom in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getNotificationOption

public java.lang.String getNotificationOption()
                                       throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns the current e-mail notification option setting. One of: "Selected", "All", "None".

Overrides:

getNotificationOption in class IPlanetSettingsNugget

Returns:

option Current notification option setting

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setNotificationOption

public void setNotificationOption(java.lang.String option)
                           throws IPlanetServerException,
                                  java.lang.IllegalArgumentException

Description copied from class: IPlanetSettingsNugget

Sets the current e-mail notification option setting. One of: "Selected", "All", "None".

Overrides:

setNotificationOption in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

java.lang.IllegalArgumentException - If the option is not one of the permissable settings

getNotificationUrgentOption

public boolean getNotificationUrgentOption()
                                    throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns whether the urgent option is set for e-mail notification.

Overrides:

getNotificationUrgentOption in class IPlanetSettingsNugget

Returns:

urgent True if the urgent option is set

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setNotificationUrgentOption

public void setNotificationUrgentOption(boolean urgent)
                                 throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets whether the urgent option is set for e-mail notification.

Overrides:

setNotificationUrgentOption in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getNotificationListOption

public boolean getNotificationListOption()
                                  throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Gets the e-mail notifictaion list option.

Overrides:

getNotificationListOption in class IPlanetSettingsNugget

Returns:

option True if the notification list option is set

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setNotificationListOption

public void setNotificationListOption(boolean option)
                               throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets the e-mail notifictaion list option.

Overrides:

setNotificationListOption in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getNotificationPhoneFrom

public java.lang.String[] getNotificationPhoneFrom()
                                            throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns an array of String objects each containing an e-mail address that triggers PCS phone based notification.

Overrides:

getNotificationPhoneFrom in class IPlanetSettingsNugget

Returns:

addresses Array of String objects containing e-mail addresses.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setNotificationPhoneFrom

public void setNotificationPhoneFrom(java.lang.String[] addresses)
                              throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets an array of String objects each containing an e-mail address that triggers PCS phone based notification.

Overrides:

setNotificationPhoneFrom in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getNotificationPhoneNumber

public java.lang.String getNotificationPhoneNumber()
                                            throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns the PCS phone number to send notification to.

Overrides:

getNotificationPhoneNumber in class IPlanetSettingsNugget

Returns:

phone The PCS phone number to send notification to.

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getNotificationPhoneOption

public java.lang.String getNotificationPhoneOption()
                                            throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns the current phone notification option setting. One of: "Selected", "All", "None".

Overrides:

getNotificationPhoneOption in class IPlanetSettingsNugget

Returns:

option Current notification option setting

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setNotificationPhoneOption

public void setNotificationPhoneOption(java.lang.String option)
                                throws IPlanetServerException,
                                       java.lang.IllegalArgumentException

Description copied from class: IPlanetSettingsNugget

Sets the current phone notification option setting. One of: "Selected", "All", "None".

Overrides:

setNotificationPhoneOption in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

java.lang.IllegalArgumentException - If the option is not one of the permissable settings

getNotificationPhoneUrgentOption

public boolean getNotificationPhoneUrgentOption()
                                         throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns whether the urgent option is set for phone notification.

Overrides:

getNotificationPhoneUrgentOption in class IPlanetSettingsNugget

Returns:

urgent True if the urgent option is set

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setNotificationPhoneUrgentOption

public void setNotificationPhoneUrgentOption(boolean urgent)
                                      throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets whether the urgent option is set for phone notification.

Overrides:

setNotificationPhoneUrgentOption in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

getNotificationPhoneListOption

public boolean getNotificationPhoneListOption()
                                       throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Gets the phone notifictaion list option.

Overrides:

getNotificationPhoneListOption in class IPlanetSettingsNugget

Returns:

option True if the notification list option is set

Throws:

IPlanetServerException - error occurred when contacting the backend server.

setNotificationPhoneListOption

public void setNotificationPhoneListOption(boolean option)
                                    throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Sets the phone notifictaion list option.

Overrides:

setNotificationPhoneListOption in class IPlanetSettingsNugget

Throws:

IPlanetServerException - error occurred when contacting the backend server.

startTransaction

public void startTransaction()

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

commitTransaction

public void commitTransaction()

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

abortTransaction

public void abortTransaction()

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

getExtendedMailPref

public java.lang.String getExtendedMailPref(java.lang.String prefName)

Description copied from class: IPlanetSettingsNugget

Returns a single value from a set of iPlanet nswmExtendedUserPrefs attributes.

The nswmExtendedUserPrefs is a multi-values attribute used by iPlanet messaging server to store customized user preference. Each attribute value is in the format of "prefName=prefValue". Each prefName has a maximum one prefValue associated.

If you need to get/set multiple settings in a roll, you MUST invoke startTranscation() before the calls and commitTransaction() after the calls. (Note, you can interlace other IPlanetSettingsNugget calls in between the start/commit invocation. The start/commit are designed for all IPlanetSettingsNugget methods.)

Example: If one of the value of the attribute "nswmExtendedUserPrefs" is "meInitialize=true", getExtendedMailPref("meInitialized") will return the String "true".

Overrides:

getExtendedMailPref in class IPlanetSettingsNugget

Parameters:

prefName - The name of an nswmExtendUserPrefs attribute preference that is going to be fetched.

Returns:

The String contents of the attribute or null if there is no match.

setExtendedMailPref

public void setExtendedMailPref(java.lang.String prefName,
                                java.lang.String prefValue)

Description copied from class: IPlanetSettingsNugget

Sets an nswmExtendedUserPrefs value. If the directory already contains a value for the specific extended user preference, the new value will replace the old one. You can remove an existing preference value by setting it to a null object or empty string.

The nswmExtendedUserPrefs is a multi-values attribute used by iPlanet messaging server to store customized user preference. Each attribute value is in the format of "prefName=prefValue". Each prefName has a maximum one prefValue associated.

If you need to get/set multiple settings in a roll, you MUST invoke startTranscation() before the calls and commitTransaction() after the calls. (Note, you can interlace other IPlanetSettingsNugget calls in between the start/commit invocation. The start/commit are designed for all IPlanetSettingsNugget methods.)

Example: setting "meInitialized" to "true" would result in the value "meInitialized=true" being added to the attribute "nswmExtendedUserPrefs". If the directory already contains another value starts with "meInitialized=", the old value will be removed before adding the new value.

Special Instruction for Creating Default Mail Folder If you are creating a new user for the messaging server via the directory, that use is not completely initialized for the iPlanet messaging server to use. That user does not has the default folders and the corresponding user preference attributes. Therefore, you may need to create the folders and set the attributes for a new user.

Once the default folders are created, you can set the required attributes with the following code:

 // assuming you have got the SprintUser object assigned to variable
 // "user".
 try {
     IPlanetSettingsNugget nugget = user.getNugget( "IPSetNugget" );
     nugget.startTransaction();  // You must invoke this first
     nugget.setExtendedMailPref( "meInitialized", "true" );
     nugget.setExtendedMailPref( "meDraftFolder", "Drafts" );
     nugget.setExtendedMailPref( "meSentFolder", "Sent" );
     nugget.setExtendedMailPref( "meTrashFolder", "Trash" );
     nugget.commitTransaction();  // You must invoke this after
 } catch( Exception e ) {
     // your error handling mechanism
 } // end catch
 

Overrides:

setExtendedMailPref in class IPlanetSettingsNugget

Parameters:

prefName - The name of an nswmExtendUserPrefs attribute preference that is going to be modified.

prefValue - The String contents of the attribute or null if there is no match.

getExtendedCalendarPref

public java.lang.String getExtendedCalendarPref(java.lang.String prefName)

Description copied from class: IPlanetSettingsNugget

Returns a single value from a set of iPlanet icsExtendedUserPrefs attributes.

The icsExtendedUserPrefs is a multi-values attribute used by iPlanet Calendar Server to store customized user preference. Each attribute value is in the format of "prefName=prefValue". Each prefName has a maximum one prefValue associated.

If you need to get/set multiple settings in a roll, you MUST invoke startTranscation() before the calls and commitTransaction() after the calls. (Note, you can interlace other IPlanetSettingsNugget calls in between the start/commit invocation. The start/commit are designed for all IPlanetSettingsNugget methods.)

Example: If one of the value of the attribute "icsExtendedUserPrefs" is "ceDateOrder=MDY", getExtendedCalendarPref("ceDateOrder") will return the String "MDY".

Overrides:

getExtendedCalendarPref in class IPlanetSettingsNugget

Parameters:

prefName - The name of an icsExtendUserPrefs attribute preference that is going to be fetched.

Returns:

The String contents of the attribute or null if there is no match.

setExtendedCalendarPref

public void setExtendedCalendarPref(java.lang.String prefName,
                                    java.lang.String prefValue)

Description copied from class: IPlanetSettingsNugget

Sets an icsExtendedUserPrefs value. If the directory already contains a value for the specific extended user preference, the new value will replace the old one. You can remove an existing preference value by setting it to a null object or empty string.

The icsExtendedUserPrefs is a multi-values attribute used by iPlanet Calendar server to store customized user preference. Each attribute value is in the format of "prefName=prefValue". Each prefName has a maximum one prefValue associated.

If you need to get/set multiple settings in a roll, you MUST invoke startTranscation() before the calls and commitTransaction() after the calls. (Note, you can interlace other IPlanetSettingsNugget calls in between the start/commit invocation. The start/commit are designed for all IPlanetSettingsNugget methods.)

Example: setting "ceDateOrder" to "MDY" would result in the value "ceDateOrder=MDY" being added to the attribute "icsExtendedUserPrefs". If the directory already contains another value starts with "ceDateOrder=", the old value will be removed before adding the new value.

Overrides:

setExtendedCalendarPref in class IPlanetSettingsNugget

Parameters:

prefName - The name of an icsExtendUserPrefs attribute preference that is going to be modified.

prefValue - The String contents of the attribute or null if there is no match.

getExtendedPref

public java.lang.String getExtendedPref(java.lang.String attrName,
                                        java.lang.String prefName)

Description copied from class: IPlanetSettingsNugget

Returns a single value from a set of preferences in an extended attribute. An extended attribute is a multi-values attribute that stores "name-value" pairs instead of just the values.

This method is intended to be used by future extension. In most cases, you can use getExtendedMailPref() or getExtendedCalendarPref().

If you need to get/set multiple settings in a roll, you MUST invoke startTranscation() before the calls and commitTransaction() after the calls. (Note, you can interlace other IPlanetSettingsNugget calls in between the start/commit invocation. The start/commit are designed for all IPlanetSettingsNugget methods.)

Example: If one of the value of the attribute "nswmExtendedUserPrefs" is "meInitialize=true", the method call getExtendedPref("nswmExtendedUserPrefs", "meInitialized") will return the String "true".

Overrides:

getExtendedPref in class IPlanetSettingsNugget

Parameters:

attrName - The name of the extended attribute

prefName - The name of "name-value" pair that is stored in the specified extended attribute.

Returns:

The String contents of the attribute or null if there is no match.

setExtendedPref

public void setExtendedPref(java.lang.String attrName,
                            java.lang.String prefName,
                            java.lang.String prefValue)

Description copied from class: IPlanetSettingsNugget

Sets a value within a set of preferences in an extended attribute. An extended attribute is a multi-values attribute that stores "name-value" pairs instead of just the values.

This method is intended to be used by future extension. In most cases, you can use getExtendedMailPref() or getExtendedCalendarPref().

If the directory already contains a value for the specific extendedUserPref, the new value will replace the old one. You can remove an existing preference value by setting it to a null object or empty string.

If you need to get/set multiple settings in a roll, you MUST invoke startTranscation() before the calls and commitTransaction() after the calls. (Note, you can interlace other IPlanetSettingsNugget calls in between the start/commit invocation. The start/commit are designed for all IPlanetSettingsNugget methods.)

Example: setting attribute "nswExtendedUserPrefs"'s preference "meInitialized" to "true" would result in the value "meInitialized=true" being added to the attribute "nswmExtendedUserPrefs". If the attribute already contains another value starts with "meInitialized=", the old value will be removed before adding the new value.

Overrides:

setExtendedPref in class IPlanetSettingsNugget

Parameters:

attrName - The name of the extended attribute

prefName - The name of "name-value" pair that is stored in the specified extended attribute.

prefValue - The String contents of the attribute or null if there is no match.

getSingleValue

public java.lang.String getSingleValue(java.lang.String attribute)
                                throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns a single value of the attribute in the user's entry. If the attribute has more than one value, this method will return the first value sent by the directory server.

Overrides:

getSingleValue in class IPlanetSettingsNugget

Returns:

value The value associated with the attribute or null if there is none.

Throws:

IPlanetServerException - If there is a connection problem with the connection

containsValue

public boolean containsValue(java.lang.String attribute,
                             java.lang.String value)
                      throws IPlanetServerException

Description copied from class: IPlanetSettingsNugget

Returns true if the attribute contains the specified value.

This method is usually used to check the existence of some value within multi-values attributes. For example, looking for "pabperson" in objectclass and "autoreply" in mailDeliveryOption and

Overrides:

containsValue in class IPlanetSettingsNugget

Returns:

True if the multi-values attribute contains the value specified.

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.

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.

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.

connect

protected void connect()
                throws java.lang.Exception

Throws:

java.lang.Exception

disconnect

protected void disconnect()
                   throws java.lang.Exception

Throws:

java.lang.Exception

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.