Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
pr_methods:validatesettings [2023/04/04 07:06] – removed - external edit (Unknown date) 127.0.0.1pr_methods:validatesettings [2025/06/12 04:00] (current) – Change to AwareIM aware_support3
Line 1: Line 1:
 +{{tag>Index Programmers_Reference Methods IChannelSettingsEditor ValidateSettings Index}}
 +====validateSettings (Properties, int)====
 +<code java>public void validateSettings (Properties settings, int intelligenceType)
 +throws Exception</code>
 +
 +This method is called when changes to the business object (which include changes to the channels) are committed. The editor is supposed to validate the settings and throw the exception with the appropriate message if the settings are invalid. The validation should happen during editing as well, however, this method may be useful when the editor was never invoked by the user in the first place so that the default settings are committed. The default settings for the channel, however, may not be complete and need validation.
 +
 +===Parameters===
 +|''intelligenceType''|the intelligence type of the business object for which the channel is configured. Possible values are specified in the [[pr_methods:getintelligencetypeapplicability|getIntelligenceTypeApplicability]] method of the ''[[docs:3500:0400:0420|IChannelType]]'' interface.|
 +|''settings''|the current values of the channel settings to be validated. |
 +
 +===Throws===
 +The exception if channel settings are invalid.
 +
 +<callout type="primary" title="note" icon="true">If you want //**AwareIM**// to build the channel with the intelligent business object when the //**AwareIM**// server starts up so that //**AwareIM**// receives notifications from the business object, set the value of ''CommonConstants.CHANNEL_SETTINGS_BUILD_NOTIF_CHANNEL'' to be "true" in the channel settings.</callout>
 +
 +Below is an example of the Channel Settings Editor that edits the settings of the E-mail channel:
 +
 +<code java>public class EmailSettingsEditor implements IChannelSettingsEditor
 +{
 +    public EmailSettingsEditor()
 +    {}
 +    public PropertiesstartEditing (int intelligenceType, Componentparent, PropertiesinitialSettings, boolean viewOnly)
 +    throws Exception
 +    {
 +        StringhostServer =null;
 +        StringfromAddress=null;
 +        StringuserName=null, password=null;
 +        if (initialSettings!=null)
 +        {
 +            hostServer =initialSettings.getProperty (MAIL_HOST);
 +            fromAddress=initialSettings.getProperty (MAIL_FROM_ADDRESS);
 +            userName =initialSettings.getProperty (CHANNEL_SETTINGS_USER_NAME);
 +            password =initialSettings.getProperty (CHANNEL_SETTINGS_PASSWORD);
 +        }
 +        EmailSettingsDlgdlg=null;
 +        if (parent instanceof Frame)
 +        {
 +            dlg=new EmailSettingsDlg((Frame)parent,hostServer, fromAddress,userName,password,viewOnly);
 +        }
 +        else if (parent instanceof Dialog)
 +        {
 +            dlg= new EmailSettingsDlg((Dialog)parent,hostServer, fromAddress,userName, password,viewOnly);
 +        }
 +        dlg.show();
 +        if (dlg.getReturnStatus()!=EmailSettingsDlg.RET_OK)
 +            return null ;
 +        Propertiesprops=new Properties();
 +        props.setProperty(MAIL_HOST,dlg.getHostName());
 +        props.setProperty(MAIL_FROM_ADDRESS,dlg.getFromAddress());
 +        props.setProperty(CHANNEL_SETTINGS_USER_NAME, dlg.getUserName());
 +        props.setProperty(CHANNEL_SETTINGS_PASSWORD, dlg.getPassword());
 +        return props;
 +    }
 +    public void validateSettings(Propertiessettings, int intelligenceType)
 +    throws Exception
 +    {
 +        StringhostServer = null ;
 +        StringfromAddress= null ;
 +        if (settings!= null )
 +        {
 +            hostServer =settings.getProperty(MAIL_HOST);
 +            fromAddress=settings.getProperty(MAIL_FROM_ADDRESS);
 +        }
 +        if (hostServer== null ||hostServer.length()==0)
 +            throw  new Exception("Mail host name for e-mail channel is not specified");
 +        if (fromAddress== null ||fromAddress.length()==0)
 +            throw  new Exception("Mail 'from' address for e-mail channel is not specified");
 +    }
 +}</code>