buildframework/helium/sf/java/signaling/src/com/nokia/helium/signal/ant/types/SignalListenerConfig.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
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: 587
diff changeset
    21
import java.util.Vector;
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    22
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import org.apache.tools.ant.types.DataType;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
 * This Ant type defines a signal input for listener based signals.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
 * E.g:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
 * <pre>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
 * &lt;hlm:signalListenerConfig id="prepSignal" target="prep-signal-test" message="some-target-name triggered a signal" &gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
 *    &lt;hlm:targetCondition  &gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
 *         &lt;/available file="some-file.txt" /&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
 *    &lt;/hlm:targetCondition&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
 *      &lt;signalInput refid="prepSignalInput" &gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
 *           &lt;notifierInput file = "${build.cache.log.dir}/signals/${build.id}_prep_status.html" /&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
 *      &lt;/signalInput&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
 *    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
 * &lt;/hlm:signalListenerConfig&gt;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
 * </pre>
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
 * @ant.type name="signalListenerConfig" category="Signaling"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
public class SignalListenerConfig extends DataType
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
{
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
   
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
    private Vector<SignalNotifierInput> signalNotifierInputs = new Vector<SignalNotifierInput>();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
    private String target;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
    private String errMsg;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
    private Vector<TargetCondition> targetConditions = new Vector<TargetCondition>();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
        
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
    private String configID;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
    public String getTargetName() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
        return target;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
    public String getErrorMessage() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
        return errMsg;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
     * Helper function to store the Name of the target for which
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
     * the signal to be processed. 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
     * @param targetName to be stored.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
     */    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
    public void setTarget(String targetName) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
        target = targetName;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
     * Helper function to store the error message of
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
     * @param errorMessage to be displayed after failure.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
     */        
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
    public void setMessage(String errorMessage) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
        errMsg = errorMessage;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    81
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    82
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    83
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    84
     * Helper function called by ant to create the new signalinput
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    85
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    86
    public SignalNotifierInput createSignalNotifierInput() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    87
        SignalNotifierInput input =  new SignalNotifierInput();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    88
        add(input);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    89
        return input;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    90
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    91
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    92
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    93
     * Helper function to add the created signalinput
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    94
     * @param filter to be added to the filterset
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    95
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    96
    public void add(SignalNotifierInput input) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    97
        signalNotifierInputs.add(input);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    98
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    99
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   100
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   101
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   102
     * Creates type target condition of type TargetCondition.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   103
     * @return ReferenceType which is created and stored by the config.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   104
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   105
    public TargetCondition createTargetCondition() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   106
        TargetCondition condition =  new TargetCondition();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   107
        add(condition);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   108
        return condition;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   109
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   110
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   111
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   112
     * Helper function to store the config id
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   113
     * @param config id to store.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   114
     */    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   115
    public void setConfigId(String confID) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   116
        configID = confID;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   117
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   118
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   119
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   120
     * Helper function to return the config id
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   121
     * @return The configuration id
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   122
     */   
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   123
    public String getConfigId() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   124
        return configID;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   125
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   126
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   127
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   128
     * Adds the TargetCondition reference to the container.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   129
     * @param TargetCondition to be added to the container, to be processed during signaling.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   130
     */    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   131
    public void add(TargetCondition condition) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   132
        if (condition != null) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   133
            targetConditions.add(condition);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   134
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   135
    }    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   136
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   137
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   138
     * Helper function to return the Targetcondition matching the target name.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   139
     * @param String name of the target for which the targetcondition is returned,
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   140
     */    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   141
    public TargetCondition getTargetCondition() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   142
        if (targetConditions.isEmpty()) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   143
            return null;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   144
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   145
        return targetConditions.get(0);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   146
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   147
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   148
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   149
     * Helper function to return the Targetcondition matching the target name.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   150
     * @param String name of the target for which the targetcondition is returned,
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   151
     */    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   152
    public SignalNotifierInput getSignalNotifierInput() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   153
        if (signalNotifierInputs.isEmpty()) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   154
            return null;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   155
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   156
        return signalNotifierInputs.get(0);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   157
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
   158
}