aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/impl/protocol/dict/ProtocolProviderFactoryDictImpl.java
blob: d7eaf30934c49376798a507e3947b79d7996ec18 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.java.sip.communicator.impl.protocol.dict;

import java.util.*;

import net.java.sip.communicator.service.contactlist.*;
import net.java.sip.communicator.service.protocol.*;
import net.java.sip.communicator.util.*;

import org.osgi.framework.*;

/**
 * The Dict protocol provider factory creates instances of the Dict
 * protocol provider service. One Service instance corresponds to one account.
 *
 * @author ROTH Damien
 * @author LITZELMANN Cedric
 */
public class ProtocolProviderFactoryDictImpl
    extends ProtocolProviderFactory
{
    private static final Logger logger
        = Logger.getLogger(ProtocolProviderFactoryDictImpl.class);

    /**
     * Creates an instance of the ProtocolProviderFactoryDictImpl.
     */
    public ProtocolProviderFactoryDictImpl()
    {
        super(DictActivator.getBundleContext(), ProtocolNames.DICT);
    }

    /**
     * Initializaed and creates an account corresponding to the specified
     * accountProperties and registers the resulting ProtocolProvider in the
     * <tt>context</tt> BundleContext parameter.
     *
     * @param userIDStr The user identifier uniquely representing the newly
     *   created account within the protocol namespace.
     * @param accountProperties a set of protocol (or implementation)
     *   specific properties defining the new account.
     * @return the AccountID of the newly created account.
     */
    @Override
    public AccountID installAccount( String userIDStr,
                                     Map<String, String> accountProperties)
    {
        BundleContext context = DictActivator.getBundleContext();
        if (context == null)
        {
            throw new NullPointerException("The specified BundleContext was null");
        }
        if (userIDStr == null)
        {
            throw new NullPointerException("The specified AccountID was null");
        }
        if (accountProperties == null)
        {
            throw new NullPointerException("The specified property map was null");
        }

        accountProperties.put(USER_ID, userIDStr);

        AccountID accountID = new DictAccountID(userIDStr, accountProperties);

        //make sure we haven't seen this account id before.
        if (registeredAccounts.containsKey(accountID))
        {
            throw new IllegalStateException("An account for id " + userIDStr + " was already installed!");
        }

        //first store the account and only then load it as the load generates
        //an osgi event, the osgi event triggers (through the UI) a call to the
        //ProtocolProviderService.register() method and it needs to acces
        //the configuration service and check for a stored password.
        this.storeAccount(accountID, false);

        accountID = loadAccount(accountProperties);

        // Creates the dict contact group.
        this.createGroup();
        // Creates the default conatct for this dict server.
        this.createDefaultContact(accountID);

        return accountID;
    }

    @Override
    protected AccountID createAccountID(String userID, Map<String, String> accountProperties)
    {
        return new DictAccountID(userID, accountProperties);
    }

    @Override
    protected ProtocolProviderService createService(String userID,
        AccountID accountID)
    {
        ProtocolProviderServiceDictImpl service =
            new ProtocolProviderServiceDictImpl();

        service.initialize(userID, accountID);
        return service;
    }

    /**
     * Creates a group for the dict contacts
     */
    private void createGroup()
    {
        // Get MetaContactListService
        BundleContext bundleContext = getBundleContext();
        ServiceReference<MetaContactListService> mfcServiceRef
            = bundleContext.getServiceReference(MetaContactListService.class);

        MetaContactListService mcl = bundleContext.getService(mfcServiceRef);

        try
        {
            String groupName = DictActivator.getResources()
                .getI18NString("service.protocol.DICTIONARIES");

            mcl.createMetaContactGroup(mcl.getRoot(), groupName);
        }
        catch (MetaContactListException ex)
        {
            int errorCode = ex.getErrorCode();
            if (errorCode != MetaContactListException.CODE_GROUP_ALREADY_EXISTS_ERROR)
            {
                logger.error(ex);
            }
        }
    }

    /**
     * Creates a default contact for the new DICT server.
     * @param accountID The accountID of the dict protocol provider for which we
     * want to add a default contact.
     */
    private void createDefaultContact(AccountID accountID)
    {
        // Gets the MetaContactListService.
        BundleContext bundleContext = getBundleContext();
        ServiceReference<MetaContactListService> mfcServiceRef
            = bundleContext.getServiceReference(MetaContactListService.class);
        MetaContactListService mcl = bundleContext.getService(mfcServiceRef);

        // Gets the ProtocolProviderService.
        ServiceReference<ProtocolProviderService> serRef
            = getProviderForAccount(accountID);
        ProtocolProviderService protocolProvider
            = DictActivator.getBundleContext().getService(serRef);

        // Gets group name
        String groupName = DictActivator.getResources()
            .getI18NString("service.protocol.DICTIONARIES");

        // Gets contact name
        String contactName = DictActivator.getResources()
            .getI18NString("plugin.dictaccregwizz.ANY_DICTIONARY_FORM",
                new String[] {accountID.getUserID()});

        // Gets the MetaContactGroup for the "dictionaries" group.
        MetaContactGroup group = mcl.getRoot().getMetaContactSubgroup(groupName);

        // Sets the default contact identifier to "*" corresponding to "all the
        // dictionaries" available on the server (cf. RFC-2229).
        String dict_uin = "*";
        // Create the default contact.
        mcl.createMetaContact(protocolProvider, group, dict_uin);
        // Rename the default contact.
        mcl.renameMetaContact(
                group.getMetaContact(protocolProvider, dict_uin),
                contactName);
    }

    @Override
    public void modifyAccount(
            ProtocolProviderService protocolProvider,
            Map<String, String> accountProperties)
        throws NullPointerException
    {
        // TODO Auto-generated method stub
    }
}