1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.mail.internal.factory.users

File UsersMimeMessageFactory.java

 

Coverage histogram

../../../../../../img/srcFileCovDistChart8.png
54% of files have more coverage

Code metrics

0
6
1
1
73
33
1
0.17
6
1
1

Classes

Class Line # Actions
UsersMimeMessageFactory 48 6 0% 1 2
0.7142857371.4%
 

Contributing tests

This file is covered by 4 tests. .

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.mail.internal.factory.users;
21   
22    import java.util.Iterator;
23    import java.util.List;
24    import java.util.Map;
25   
26    import javax.inject.Named;
27    import javax.inject.Singleton;
28    import javax.mail.MessagingException;
29    import javax.mail.internet.MimeMessage;
30   
31    import org.xwiki.component.annotation.Component;
32    import org.xwiki.mail.MimeMessageFactory;
33    import org.xwiki.mail.internal.factory.AbstractIteratorMimeMessageFactory;
34    import org.xwiki.model.reference.DocumentReference;
35   
36    /**
37    * Generate one {@link MimeMessage} per passed user, using the passed parameters to define the
38    * {@link org.xwiki.mail.MimeMessageFactory} to call to generate the message for each user.
39    *
40    * @version $Id: e6a9193032d41752bc2bd5813e5f7abd865f4559 $
41    * @since 6.4.1
42    * @deprecated starting with 6.4.2 this is replaced by the {@code usersandroups} Mime Message Factory
43    */
44    @Component
45    @Named("users")
46    @Singleton
47    @Deprecated
 
48    public class UsersMimeMessageFactory extends AbstractIteratorMimeMessageFactory
49    {
50    private static final String HINT = "hint";
51   
52    private static final String SOURCE = "source";
53   
 
54  4 toggle @Override
55    public Iterator<MimeMessage> createMessage(Object userReferencesObject, Map<String, Object> parameters)
56    throws MessagingException
57    {
58  4 List<DocumentReference> userReferences = getTypedSource(userReferencesObject, List.class);
59   
60    // We verify that we have both a Factory hint specified but also the source for the Factory.
61  4 validateParameters(parameters, HINT, SOURCE);
62   
63    // Extract from the passed parameters the MimeMessageFactory to use to create a single mail
64  1 String factoryHint = (String) parameters.get(HINT);
65   
66  1 MimeMessageFactory factory = getInternalMimeMessageFactory(factoryHint);
67   
68  0 UsersMimeMessageIterator iterator = new UsersMimeMessageIterator(userReferences, factory, parameters,
69    this.componentManagerProvider.get());
70  0 return iterator;
71    }
72   
73    }