buildframework/helium/sf/java/signaling/src/com/nokia/helium/signal/ant/types/SignalNotifierList.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 588 c7c26511138f
child 645 b8d81fa19e7d
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
* All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
* This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
* which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
* Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
* Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
* Description:  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
*/
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
package com.nokia.helium.signal.ant.types;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    21
import java.util.Vector;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    23
import org.apache.tools.ant.types.DataType;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 588
diff changeset
    25
import com.nokia.helium.signal.Notifier;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
 * Helper class to store the list of notifiers.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
 * Example:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
 * <pre>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
 *   &lt;hlm:notifierList id="defaultSignalFailNotifier"&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
 *       &lt;hlm:emailNotifier templateSrc="${helium.dir}/tools/common/templates/log/email_new.html.ftl" title="[signal] ${signal.name}"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
 *          smtp="${email.smtp.server}" ldap="${email.ldap.server}" notifyWhen="fail"&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
 *       &lt;/hlm:emailNotifier&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
 *   &lt;/hlm:notifierList&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
 * </pre>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
 * @ant.task name="notifierList" category="Signaling" 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
public class SignalNotifierList extends DataType {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
    private Vector<Notifier> notifierlist = new Vector<Notifier>();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
     * Adding a Notifier.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
     * @param notifier
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
    public void add(Notifier notifier) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
        notifierlist.add(notifier);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
            
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
     * Returns the list of variables available in the VariableSet 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
     * @return variable list
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
    public Vector<Notifier> getNotifierList() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
        return notifierlist;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
}