* Licensed to the Apache Software Foundation (ASF) under one

* or more contributor license agreements.  See the NOTICE file

* distributed with this work for additional information

* regarding copyright ownership.  The ASF licenses this file

* to you 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.

*/

* This class provides the functionalities to resolve a coordinator job XML and write the job information into a DB

* table.

* <p/>

* Specifically it performs the following functions: 1. Resolve all the variables or properties using job

* configurations. 2. Insert all datasets definition as part of the <data-in> and <data-out> tags. 3. Validate the XML

* at runtime.

*/

    private Configuration conf;

    private final String authToken;

    private final String bundleId;

    private final String coordName;

    private boolean dryrun;

    private JPAService jpaService = null;

    private CoordinatorJob.Status prevStatus = CoordinatorJob.Status.PREP;

    public static final String CONFIG_DEFAULT = "coord-config-default.xml";

    public static final String COORDINATOR_XML_FILE = "coordinator.xml";

    public final String COORD_INPUT_EVENTS ="input-events";

    public final String COORD_OUTPUT_EVENTS = "output-events";

    public final String COORD_INPUT_EVENTS_DATA_IN ="data-in";

    public final String COORD_OUTPUT_EVENTS_DATA_OUT = "data-out";

    private static final Set<String> DISALLOWED_USER_PROPERTIES = new HashSet<String>();

    private static final Set<String> DISALLOWED_DEFAULT_PROPERTIES = new HashSet<String>();

    private CoordinatorJobBean coordJob = null;

    /**

     * Default timeout for normal jobs, in minutes, after which coordinator input check will timeout

     */

    public static final String CONF_DEFAULT_TIMEOUT_NORMAL = Service.CONF_PREFIX + "coord.normal.default.timeout";

    public static final String CONF_DEFAULT_CONCURRENCY = Service.CONF_PREFIX + "coord.default.concurrency";

    public static final String CONF_DEFAULT_THROTTLE = Service.CONF_PREFIX + "coord.default.throttle";

    public static final String CONF_MAT_THROTTLING_FACTOR = Service.CONF_PREFIX

            + "coord.materialization.throttling.factor";

    /**

     * Default MAX timeout in minutes, after which coordinator input check will timeout

     */

    public static final String CONF_DEFAULT_MAX_TIMEOUT = Service.CONF_PREFIX + "coord.default.max.timeout";

    public static final String CONF_QUEUE_SIZE = Service.CONF_PREFIX + "CallableQueueService.queue.size";

    private ELEvaluator evalFreq = null;

    private ELEvaluator evalNofuncs = null;

    private ELEvaluator evalData = null;

    private ELEvaluator evalInst = null;

    private ELEvaluator evalAction = null;

    private ELEvaluator evalSla = null;

    static {

        String[] badUserProps = { PropertiesUtils.YEAR, PropertiesUtils.MONTH, PropertiesUtils.DAY,

                PropertiesUtils.HOUR, PropertiesUtils.MINUTE, PropertiesUtils.DAYS, PropertiesUtils.HOURS,

                PropertiesUtils.MINUTES, PropertiesUtils.KB, PropertiesUtils.MB, PropertiesUtils.GB,

                PropertiesUtils.TB, PropertiesUtils.PB, PropertiesUtils.RECORDS, PropertiesUtils.MAP_IN,

                PropertiesUtils.MAP_OUT, PropertiesUtils.REDUCE_IN, PropertiesUtils.REDUCE_OUT, PropertiesUtils.GROUPS };

        PropertiesUtils.createPropertySet(badUserProps, DISALLOWED_USER_PROPERTIES);

        String[] badDefaultProps = { PropertiesUtils.HADOOP_USER};

        PropertiesUtils.createPropertySet(badUserProps, DISALLOWED_DEFAULT_PROPERTIES);

        PropertiesUtils.createPropertySet(badDefaultProps, DISALLOWED_DEFAULT_PROPERTIES);

    }

    /**

     * Constructor to create the Coordinator Submit Command.

     *

     * @param conf : Configuration for Coordinator job

     * @param authToken : To be used for authentication

     */

    public CoordSubmitXCommand(Configuration conf, String authToken) {

        super("coord_submit", "coord_submit", 1);

        this.conf = ParamChecker.notNull(conf, "conf");

        this.authToken = ParamChecker.notEmpty(authToken, "authToken");

        this.bundleId = null;

        this.coordName = null;

    }

    /**

     * Constructor to create the Coordinator Submit Command by bundle job.

     *

     * @param conf : Configuration for Coordinator job

     * @param authToken : To be used for authentication

     * @param bundleId : bundle id

     * @param coordName : coord name

     */

    public CoordSubmitXCommand(Configuration conf, String authToken, String bundleId, String coordName) {

        super("coord_submit", "coord_submit", 1);

        this.conf = ParamChecker.notNull(conf, "conf");

        this.authToken = ParamChecker.notEmpty(authToken, "authToken");

        this.bundleId = ParamChecker.notEmpty(bundleId, "bundleId");

        this.coordName = ParamChecker.notEmpty(coordName, "coordName");

    }

    /**

     * Constructor to create the Coordinator Submit Command.

     *

     * @param dryrun : if dryrun

     * @param conf : Configuration for Coordinator job

     * @param authToken : To be used for authentication

     */

    public CoordSubmitXCommand(boolean dryrun, Configuration conf, String authToken) {

        this(conf, authToken);

        this.dryrun = dryrun;

    }

    /* (non-Javadoc)

     * @see org.apache.oozie.command.XCommand#execute()

     */

    @Override

    protected String submit() throws CommandException {

        String jobId = null;

        LOG.info("STARTED Coordinator Submit");

        InstrumentUtils.incrJobCounter(getName(), 1, getInstrumentation());

        boolean exceptionOccured = false;

        try {

            mergeDefaultConfig();

            String appXml = readAndValidateXml();

            coordJob.setOrigJobXml(appXml);

            LOG.debug("jobXml after initial validation " + XmlUtils.prettyPrint(appXml).toString());

            String appNamespace = readAppNamespace(appXml);

            coordJob.setAppNamespace(appNamespace);

            appXml = XmlUtils.removeComments(appXml);

            initEvaluators();

            Element eJob = basicResolveAndIncludeDS(appXml, conf, coordJob);

            // checking if the coordinator application data input/output events

            // specify multiple data instance values in erroneous manner

            checkMultipleTimeInstances(eJob, COORD_INPUT_EVENTS, COORD_INPUT_EVENTS_DATA_IN);

            checkMultipleTimeInstances(eJob, COORD_OUTPUT_EVENTS, COORD_OUTPUT_EVENTS_DATA_OUT);

            LOG.debug("jobXml after all validation " + XmlUtils.prettyPrint(eJob).toString());

            jobId = storeToDB(eJob, coordJob);

            // log job info for coordinator job

            LogUtils.setLogInfo(coordJob, logInfo);

            LOG = XLog.resetPrefix(LOG);

            if (!dryrun) {

                // submit a command to materialize jobs for the next 1 hour (3600 secs)

                // so we don't wait 10 mins for the Service to run.

                queue(new CoordMaterializeTransitionXCommand(jobId, 3600), 100);

            }

            else {

                Date startTime = coordJob.getStartTime();

                long startTimeMilli = startTime.getTime();

                long endTimeMilli = startTimeMilli + (3600 * 1000);

                Date jobEndTime = coordJob.getEndTime();

                Date endTime = new Date(endTimeMilli);

                if (endTime.compareTo(jobEndTime) > 0) {

                    endTime = jobEndTime;

                }

                jobId = coordJob.getId();

                LOG.info("[" + jobId + "]: Update status to RUNNING");

                coordJob.setStatus(Job.Status.RUNNING);

                coordJob.setPending();

                CoordActionMaterializeCommand coordActionMatCom = new CoordActionMaterializeCommand(jobId, startTime,

                        endTime);

                Configuration jobConf = null;

                try {

                    jobConf = new XConfiguration(new StringReader(coordJob.getConf()));

                }

                catch (IOException e1) {

                    LOG.warn("Configuration parse error. read from DB :" + coordJob.getConf(), e1);

                }

                String action = coordActionMatCom.materializeJobs(true, coordJob, jobConf, null);

                String output = coordJob.getJobXml() + System.getProperty("line.separator")

                + "***actions for instance***" + action;

                return output;

            }

        }

        catch (CoordinatorJobException cex) {

            exceptionOccured = true;

            LOG.warn("ERROR:  ", cex);

            throw new CommandException(cex);

        }

        catch (IllegalArgumentException iex) {

            exceptionOccured = true;

            LOG.warn("ERROR:  ", iex);

            throw new CommandException(ErrorCode.E1003, iex);

        }

        catch (Exception ex) {

            exceptionOccured = true;

            LOG.warn("ERROR:  ", ex);

            throw new CommandException(ErrorCode.E0803, ex);

        }

        finally {

            if (exceptionOccured) {

                if(coordJob.getId() == null || coordJob.getId().equalsIgnoreCase("")){

                    coordJob.setStatus(CoordinatorJob.Status.FAILED);

                    coordJob.resetPending();

                }

            }

        }

        LOG.info("ENDED Coordinator Submit jobId=" + jobId);

        return jobId;

    }

    /*

     * Check against multiple data instance values inside a single <instance> tag

     * If found, the job is not submitted and user is informed to correct the error, instead of defaulting to the first instance value in the list

     */

    private void checkMultipleTimeInstances(Element eCoordJob, String eventType, String dataType) throws CoordinatorJobException {

        Element eventsSpec, dataSpec, instance;

        List<Element> instanceSpecList;

        Namespace ns = eCoordJob.getNamespace();

        String instanceValue;

        eventsSpec = eCoordJob.getChild(eventType, ns);

        if (eventsSpec != null) {

            dataSpec = eventsSpec.getChild(dataType, ns);

            if (dataSpec != null) {

                // In case of input-events, there can be multiple child <instance> datasets. Iterating to ensure none of them have errors

                instanceSpecList = dataSpec.getChildren("instance", ns);

                Iterator instanceIter = instanceSpecList.iterator();

                while(instanceIter.hasNext()) {

                    instance = ((Element) instanceIter.next());

                    if(instance.getContentSize() == 0) { //empty string or whitespace

                        throw new CoordinatorJobException(ErrorCode.E1021, "<instance> tag within " + eventType + " is empty!");

                    }

                    instanceValue = instance.getContent(0).toString();

                    boolean isInvalid = false;

                    try {

                        isInvalid = evalAction.checkForExistence(instanceValue, ",");

                    } catch (Exception e) {

                        handleELParseException(eventType, dataType, instanceValue);

                    }

                    if (isInvalid) { // reaching this block implies instance is not empty i.e. length > 0

                        handleExpresionWithMultipleInstances(eventType, dataType, instanceValue);

                    }

                }

            }

        }

    }

    private void handleELParseException(String eventType, String dataType, String instanceValue)

            throws CoordinatorJobException {

        String correctAction = null;

        if(dataType.equals(COORD_INPUT_EVENTS_DATA_IN)) {

            correctAction = "Coordinator app definition should have valid <instance> tag for data-in";

        } else if(dataType.equals(COORD_OUTPUT_EVENTS_DATA_OUT)) {

            correctAction = "Coordinator app definition should have valid <instance> tag for data-out";

        }

        throw new CoordinatorJobException(ErrorCode.E1021, eventType + " instance '" + instanceValue

                + "' is not valid. Coordinator job NOT SUBMITTED. " + correctAction);

    }

    private void handleExpresionWithMultipleInstances(String eventType, String dataType, String instanceValue)

            throws CoordinatorJobException {

        String correctAction = null;

        if(dataType.equals(COORD_INPUT_EVENTS_DATA_IN)) {

            correctAction = "Coordinator app definition should have separate <instance> tag per data-in instance";

        } else if(dataType.equals(COORD_OUTPUT_EVENTS_DATA_OUT)) {

            correctAction = "Coordinator app definition can have only one <instance> tag per data-out instance";

        }

        throw new CoordinatorJobException(ErrorCode.E1021, eventType + " instance '" + instanceValue

                + "' contains more than one date instance. Coordinator job NOT SUBMITTED. " + correctAction);

    }

    /**

     * Read the application XML and validate against coordinator Schema

     *

     * @return validated coordinator XML

     * @throws CoordinatorJobException thrown if unable to read or validate coordinator xml

     */

    private String readAndValidateXml() throws CoordinatorJobException {

        String appPath = ParamChecker.notEmpty(conf.get(OozieClient.COORDINATOR_APP_PATH),

                OozieClient.COORDINATOR_APP_PATH);

        String coordXml = readDefinition(appPath);

        validateXml(coordXml);

        return coordXml;

    }

    /**

     * Validate against Coordinator XSD file

     *

     * @param xmlContent : Input coordinator xml

     * @throws CoordinatorJobException thrown if unable to validate coordinator xml

     */

    private void validateXml(String xmlContent) throws CoordinatorJobException {

        javax.xml.validation.Schema schema = Services.get().get(SchemaService.class).getSchema(SchemaName.COORDINATOR);

        Validator validator = schema.newValidator();

        try {

            validator.validate(new StreamSource(new StringReader(xmlContent)));

        }

        catch (SAXException ex) {

            LOG.warn("SAXException :", ex);

            throw new CoordinatorJobException(ErrorCode.E0701, ex.getMessage(), ex);

        }

        catch (IOException ex) {

            LOG.warn("IOException :", ex);

            throw new CoordinatorJobException(ErrorCode.E0702, ex.getMessage(), ex);

        }

    }

    /**

     * Read the application XML schema namespace

     *

     * @param xmlContent input coordinator xml

     * @return app xml namespace

     * @throws CoordinatorJobException

     */

    private String readAppNamespace(String xmlContent) throws CoordinatorJobException {

        try {

            Element coordXmlElement = XmlUtils.parseXml(xmlContent);

            Namespace ns = coordXmlElement.getNamespace();

            if (ns != null && bundleId != null && ns.getURI().equals(SchemaService.COORDINATOR_NAMESPACE_URI_1)) {

                throw new CoordinatorJobException(ErrorCode.E1319, "bundle app can not submit coordinator namespace "

                        + SchemaService.COORDINATOR_NAMESPACE_URI_1 + ", please use 0.2 or later");

            }

            if (ns != null) {

                return ns.getURI();

            }

            else {

                throw new CoordinatorJobException(ErrorCode.E0700, "the application xml namespace is not given");

            }

        }

        catch (JDOMException ex) {

            LOG.warn("JDOMException :", ex);

            throw new CoordinatorJobException(ErrorCode.E0700, ex.getMessage(), ex);

        }

    }

    /**

     * Merge default configuration with user-defined configuration.

     *

     * @throws CommandException thrown if failed to read or merge configurations

     */

    protected void mergeDefaultConfig() throws CommandException {

        Path configDefault = null;

        try {

            String coordAppPathStr = conf.get(OozieClient.COORDINATOR_APP_PATH);

            Path coordAppPath = new Path(coordAppPathStr);

            String user = ParamChecker.notEmpty(conf.get(OozieClient.USER_NAME), OozieClient.USER_NAME);

            HadoopAccessorService has = Services.get().get(HadoopAccessorService.class);

            Configuration fsConf = has.createJobConf(coordAppPath.toUri().getAuthority());

            FileSystem fs = has.createFileSystem(user, coordAppPath.toUri(), fsConf);

            // app path could be a directory

            if (!fs.isFile(coordAppPath)) {

                configDefault = new Path(coordAppPath, CONFIG_DEFAULT);

            } else {

                configDefault = new Path(coordAppPath.getParent(), CONFIG_DEFAULT);

            }

            if (fs.exists(configDefault)) {

                Configuration defaultConf = new XConfiguration(fs.open(configDefault));

                PropertiesUtils.checkDisallowedProperties(defaultConf, DISALLOWED_DEFAULT_PROPERTIES);

                XConfiguration.injectDefaults(defaultConf, conf);

            }

            else {

                LOG.info("configDefault Doesn't exist " + configDefault);

            }

            PropertiesUtils.checkDisallowedProperties(conf, DISALLOWED_USER_PROPERTIES);

            // Resolving all variables in the job properties.

            // This ensures the Hadoop Configuration semantics is preserved.

            XConfiguration resolvedVarsConf = new XConfiguration();

            for (Map.Entry<String, String> entry : conf) {

                resolvedVarsConf.set(entry.getKey(), conf.get(entry.getKey()));

            }

            conf = resolvedVarsConf;

        }

        catch (IOException e) {

            throw new CommandException(ErrorCode.E0702, e.getMessage() + " : Problem reading default config "

                    + configDefault, e);

        }

        catch (HadoopAccessorException e) {

            throw new CommandException(e);

        }

        LOG.debug("Merged CONF :" + XmlUtils.prettyPrint(conf).toString());

    }

    /**

     * The method resolve all the variables that are defined in configuration. It also include the data set definition

     * from dataset file into XML.

     *

     * @param appXml : Original job XML

     * @param conf : Configuration of the job

     * @param coordJob : Coordinator job bean to be populated.

     * @return Resolved and modified job XML element.

     * @throws CoordinatorJobException thrown if failed to resolve basic entities or include referred datasets

     * @throws Exception thrown if failed to resolve basic entities or include referred datasets

     */

    public Element basicResolveAndIncludeDS(String appXml, Configuration conf, CoordinatorJobBean coordJob)

    throws CoordinatorJobException, Exception {

        Element basicResolvedApp = resolveInitial(conf, appXml, coordJob);

        includeDataSets(basicResolvedApp, conf);

        return basicResolvedApp;

    }

    /**

     * Insert data set into data-in and data-out tags.

     *

     * @param eAppXml : coordinator application XML

     * @param eDatasets : DataSet XML

     */

    @SuppressWarnings("unchecked")

    private void insertDataSet(Element eAppXml, Element eDatasets) {

        // Adding DS definition in the coordinator XML

        Element inputList = eAppXml.getChild("input-events", eAppXml.getNamespace());

        if (inputList != null) {

            for (Element dataIn : (List<Element>) inputList.getChildren("data-in", eAppXml.getNamespace())) {

                Element eDataset = findDataSet(eDatasets, dataIn.getAttributeValue("dataset"));

                dataIn.getContent().add(0, eDataset);

            }

        }

        Element outputList = eAppXml.getChild("output-events", eAppXml.getNamespace());

        if (outputList != null) {

            for (Element dataOut : (List<Element>) outputList.getChildren("data-out", eAppXml.getNamespace())) {

                Element eDataset = findDataSet(eDatasets, dataOut.getAttributeValue("dataset"));

                dataOut.getContent().add(0, eDataset);

            }

        }

    }

    /**

     * Find a specific dataset from a list of Datasets.

     *

     * @param eDatasets : List of data sets

     * @param name : queried data set name

     * @return one Dataset element. otherwise throw Exception

     */

    @SuppressWarnings("unchecked")

    private static Element findDataSet(Element eDatasets, String name) {

        for (Element eDataset : (List<Element>) eDatasets.getChildren("dataset", eDatasets.getNamespace())) {

            if (eDataset.getAttributeValue("name").equals(name)) {

                eDataset = (Element) eDataset.clone();

                eDataset.detach();

                return eDataset;

            }

        }

        throw new RuntimeException("undefined dataset: " + name);

    }

    /**

     * Initialize all the required EL Evaluators.

     */

    protected void initEvaluators() {

        evalFreq = CoordELEvaluator.createELEvaluatorForGroup(conf, "coord-job-submit-freq");

        evalNofuncs = CoordELEvaluator.createELEvaluatorForGroup(conf, "coord-job-submit-nofuncs");

        evalInst = CoordELEvaluator.createELEvaluatorForGroup(conf, "coord-job-submit-instances");

        evalSla = CoordELEvaluator.createELEvaluatorForGroup(conf, "coord-sla-submit");

        evalAction = CoordELEvaluator.createELEvaluatorForGroup(conf, "coord-action-start");

    }

    /**

     * Resolve basic entities using job Configuration.

     *

     * @param conf :Job configuration

     * @param appXml : Original job XML

     * @param coordJob : Coordinator job bean to be populated.

     * @return Resolved job XML element.

     * @throws CoordinatorJobException thrown if failed to resolve basic entities

     * @throws Exception thrown if failed to resolve basic entities

     */

    @SuppressWarnings("unchecked")

    protected Element resolveInitial(Configuration conf, String appXml, CoordinatorJobBean coordJob)

    throws CoordinatorJobException, Exception {

        Element eAppXml = XmlUtils.parseXml(appXml);

        // job's main attributes

        // frequency

        String val = resolveAttribute("frequency", eAppXml, evalFreq);

        int ival = ParamChecker.checkInteger(val, "frequency");

        ParamChecker.checkGTZero(ival, "frequency");

        coordJob.setFrequency(ival);

        TimeUnit tmp = (evalFreq.getVariable("timeunit") == null) ? TimeUnit.MINUTE : ((TimeUnit) evalFreq

                .getVariable("timeunit"));

        addAnAttribute("freq_timeunit", eAppXml, tmp.toString());

        // TimeUnit

        coordJob.setTimeUnit(CoordinatorJob.Timeunit.valueOf(tmp.toString()));

        // End Of Duration

        tmp = evalFreq.getVariable("endOfDuration") == null ? TimeUnit.NONE : ((TimeUnit) evalFreq

                .getVariable("endOfDuration"));

        addAnAttribute("end_of_duration", eAppXml, tmp.toString());

        // coordJob.setEndOfDuration(tmp) // TODO: Add new attribute in Job bean

        // Application name

        if (this.coordName == null) {

            val = resolveAttribute("name", eAppXml, evalNofuncs);

            coordJob.setAppName(val);

        }

        else {

            // this coord job is created from bundle

            coordJob.setAppName(this.coordName);

        }

        // start time

        val = resolveAttribute("start", eAppXml, evalNofuncs);

        ParamChecker.checkUTC(val, "start");

        coordJob.setStartTime(DateUtils.parseDateUTC(val));

        // end time

        val = resolveAttribute("end", eAppXml, evalNofuncs);

        ParamChecker.checkUTC(val, "end");

        coordJob.setEndTime(DateUtils.parseDateUTC(val));

        // Time zone

        val = resolveAttribute("timezone", eAppXml, evalNofuncs);

        ParamChecker.checkTimeZone(val, "timezone");

        coordJob.setTimeZone(val);

        // controls

        val = resolveTagContents("timeout", eAppXml.getChild("controls", eAppXml.getNamespace()), evalNofuncs);

        if (val == "") {

            val = Services.get().getConf().get(CONF_DEFAULT_TIMEOUT_NORMAL);

        }

        ival = ParamChecker.checkInteger(val, "timeout");

        if (ival < 0 || ival > Services.get().getConf().getInt(CONF_DEFAULT_MAX_TIMEOUT, 129600)) {

            ival = Services.get().getConf().getInt(CONF_DEFAULT_MAX_TIMEOUT, 129600);

        }

        coordJob.setTimeout(ival);

        val = resolveTagContents("concurrency", eAppXml.getChild("controls", eAppXml.getNamespace()), evalNofuncs);

        if (val == null || val.isEmpty()) {

            val = Services.get().getConf().get(CONF_DEFAULT_CONCURRENCY, "1");

        }

        ival = ParamChecker.checkInteger(val, "concurrency");

        coordJob.setConcurrency(ival);

        val = resolveTagContents("throttle", eAppXml.getChild("controls", eAppXml.getNamespace()), evalNofuncs);

        if (val == null || val.isEmpty()) {

            int defaultThrottle = Services.get().getConf().getInt(CONF_DEFAULT_THROTTLE, 12);

            ival = defaultThrottle;

        }

        else {

            ival = ParamChecker.checkInteger(val, "throttle");

        }

        int maxQueue = Services.get().getConf().getInt(CONF_QUEUE_SIZE, 10000);

        float factor = Services.get().getConf().getFloat(CONF_MAT_THROTTLING_FACTOR, 0.10f);

        int maxThrottle = (int) (maxQueue * factor);

        if (ival > maxThrottle || ival < 1) {

            ival = maxThrottle;

        }

        LOG.debug("max throttle " + ival);

        coordJob.setMatThrottling(ival);

        val = resolveTagContents("execution", eAppXml.getChild("controls", eAppXml.getNamespace()), evalNofuncs);

        if (val == "") {

            val = Execution.FIFO.toString();

        }

        coordJob.setExecution(Execution.valueOf(val));

        String[] acceptedVals = { Execution.LIFO.toString(), Execution.FIFO.toString(), Execution.LAST_ONLY.toString() };

        ParamChecker.isMember(val, acceptedVals, "execution");

        // datasets

        resolveTagContents("include", eAppXml.getChild("datasets", eAppXml.getNamespace()), evalNofuncs);

        // for each data set

        resolveDataSets(eAppXml);

        HashMap<String, String> dataNameList = new HashMap<String, String>();

        resolveIOEvents(eAppXml, dataNameList);

        resolveTagContents("app-path", eAppXml.getChild("action", eAppXml.getNamespace()).getChild("workflow",

                eAppXml.getNamespace()), evalNofuncs);

        // TODO: If action or workflow tag is missing, NullPointerException will

        // occur

        Element configElem = eAppXml.getChild("action", eAppXml.getNamespace()).getChild("workflow",

                eAppXml.getNamespace()).getChild("configuration", eAppXml.getNamespace());

        evalData = CoordELEvaluator.createELEvaluatorForDataEcho(conf, "coord-job-submit-data", dataNameList);

        if (configElem != null) {

            for (Element propElem : (List<Element>) configElem.getChildren("property", configElem.getNamespace())) {

                resolveTagContents("name", propElem, evalData);

                // Want to check the data-integrity but don't want to modify the

                // XML

                // for properties only

                Element tmpProp = (Element) propElem.clone();

                resolveTagContents("value", tmpProp, evalData);

            }

        }

        resolveSLA(eAppXml, coordJob);

        return eAppXml;

    }

    /**

     * Resolve SLA events

     *

     * @param eAppXml job XML

     * @param coordJob coordinator job bean

     * @throws CommandException thrown if failed to resolve sla events

     */

    private void resolveSLA(Element eAppXml, CoordinatorJobBean coordJob) throws CommandException {

        Element eSla = eAppXml.getChild("action", eAppXml.getNamespace()).getChild("info",

                Namespace.getNamespace(SchemaService.SLA_NAME_SPACE_URI));

        if (eSla != null) {

            String slaXml = XmlUtils.prettyPrint(eSla).toString();

            try {

                // EL evaluation

                slaXml = evalSla.evaluate(slaXml, String.class);

                // Validate against semantic SXD

                XmlUtils.validateData(slaXml, SchemaName.SLA_ORIGINAL);

            }

            catch (Exception e) {

                throw new CommandException(ErrorCode.E1004, "Validation ERROR :" + e.getMessage(), e);

            }

        }

    }

    /**

     * Resolve input-events/data-in and output-events/data-out tags.

     *

     * @param eJob : Job element

     * @throws CoordinatorJobException thrown if failed to resolve input and output events

     */

    @SuppressWarnings("unchecked")

    private void resolveIOEvents(Element eJobOrg, HashMap<String, String> dataNameList) throws CoordinatorJobException {

        // Resolving input-events/data-in

        // Clone the job and don't update anything in the original

        Element eJob = (Element) eJobOrg.clone();

        Element inputList = eJob.getChild("input-events", eJob.getNamespace());

        if (inputList != null) {

            TreeSet<String> eventNameSet = new TreeSet<String>();

            for (Element dataIn : (List<Element>) inputList.getChildren("data-in", eJob.getNamespace())) {

                String dataInName = dataIn.getAttributeValue("name");

                dataNameList.put(dataInName, "data-in");

                // check whether there is any duplicate data-in name

                if (eventNameSet.contains(dataInName)) {

                    throw new RuntimeException("Duplicate dataIn name " + dataInName);

                }

                else {

                    eventNameSet.add(dataInName);

                }

                resolveTagContents("instance", dataIn, evalInst);

                resolveTagContents("start-instance", dataIn, evalInst);

                resolveTagContents("end-instance", dataIn, evalInst);

            }

        }

        // Resolving output-events/data-out

        Element outputList = eJob.getChild("output-events", eJob.getNamespace());

        if (outputList != null) {

            TreeSet<String> eventNameSet = new TreeSet<String>();

            for (Element dataOut : (List<Element>) outputList.getChildren("data-out", eJob.getNamespace())) {

                String dataOutName = dataOut.getAttributeValue("name");

                dataNameList.put(dataOutName, "data-out");

                // check whether there is any duplicate data-out name

                if (eventNameSet.contains(dataOutName)) {

                    throw new RuntimeException("Duplicate dataIn name " + dataOutName);

                }

                else {

                    eventNameSet.add(dataOutName);

                }

                resolveTagContents("instance", dataOut, evalInst);

            }

        }

    }

    /**

     * Add an attribute into XML element.

     *

     * @param attrName :attribute name

     * @param elem : Element to add attribute

     * @param value :Value of attribute

     */

    private void addAnAttribute(String attrName, Element elem, String value) {

        elem.setAttribute(attrName, value);

    }

    /**

     * Resolve datasets using job configuration.

     *

     * @param eAppXml : Job Element XML

     * @throws Exception thrown if failed to resolve datasets

     */

    @SuppressWarnings("unchecked")

    private void resolveDataSets(Element eAppXml) throws Exception {

        Element datasetList = eAppXml.getChild("datasets", eAppXml.getNamespace());

        if (datasetList != null) {

            List<Element> dsElems = datasetList.getChildren("dataset", eAppXml.getNamespace());

            resolveDataSets(dsElems);

            resolveTagContents("app-path", eAppXml.getChild("action", eAppXml.getNamespace()).getChild("workflow",

                    eAppXml.getNamespace()), evalNofuncs);

        }

    }

    /**

     * Resolve datasets using job configuration.

     *

     * @param dsElems : Data set XML element.

     * @throws CoordinatorJobException thrown if failed to resolve datasets

     */

    private void resolveDataSets(List<Element> dsElems) throws CoordinatorJobException {

        for (Element dsElem : dsElems) {

            // Setting up default TimeUnit and EndOFDuraion

            evalFreq.setVariable("timeunit", TimeUnit.MINUTE);

            evalFreq.setVariable("endOfDuration", TimeUnit.NONE);

            String val = resolveAttribute("frequency", dsElem, evalFreq);

            int ival = ParamChecker.checkInteger(val, "frequency");

            ParamChecker.checkGTZero(ival, "frequency");

            addAnAttribute("freq_timeunit", dsElem, evalFreq.getVariable("timeunit") == null ? TimeUnit.MINUTE

                    .toString() : ((TimeUnit) evalFreq.getVariable("timeunit")).toString());

            addAnAttribute("end_of_duration", dsElem, evalFreq.getVariable("endOfDuration") == null ? TimeUnit.NONE

                    .toString() : ((TimeUnit) evalFreq.getVariable("endOfDuration")).toString());

            val = resolveAttribute("initial-instance", dsElem, evalNofuncs);

            ParamChecker.checkUTC(val, "initial-instance");

            checkInitialInstance(val);

            val = resolveAttribute("timezone", dsElem, evalNofuncs);

            ParamChecker.checkTimeZone(val, "timezone");

            resolveTagContents("uri-template", dsElem, evalNofuncs);

            resolveTagContents("done-flag", dsElem, evalNofuncs);

        }

    }

    /**

     * Resolve the content of a tag.

     *

     * @param tagName : Tag name of job XML i.e. <timeout> 10 </timeout>

     * @param elem : Element where the tag exists.

     * @param eval : EL evealuator

     * @return Resolved tag content.

     * @throws CoordinatorJobException thrown if failed to resolve tag content

     */

    @SuppressWarnings("unchecked")

    private String resolveTagContents(String tagName, Element elem, ELEvaluator eval) throws CoordinatorJobException {

        String ret = "";

        if (elem != null) {

            for (Element tagElem : (List<Element>) elem.getChildren(tagName, elem.getNamespace())) {

                if (tagElem != null) {

                    String updated;

                    try {

                        updated = CoordELFunctions.evalAndWrap(eval, tagElem.getText().trim());

                    }

                    catch (Exception e) {

                        throw new CoordinatorJobException(ErrorCode.E1004, e.getMessage(), e);

                    }

                    tagElem.removeContent();

                    tagElem.addContent(updated);

                    ret += updated;

                }

            }

        }

        return ret;

    }

    /**

     * Resolve an attribute value.

     *

     * @param attrName : Attribute name.

     * @param elem : XML Element where attribute is defiend

     * @param eval : ELEvaluator used to resolve

     * @return Resolved attribute value

     * @throws CoordinatorJobException thrown if failed to resolve an attribute value

     */

    private String resolveAttribute(String attrName, Element elem, ELEvaluator eval) throws CoordinatorJobException {

        Attribute attr = elem.getAttribute(attrName);

        String val = null;

        if (attr != null) {

            try {

                val = CoordELFunctions.evalAndWrap(eval, attr.getValue().trim());

            }

            catch (Exception e) {

                throw new CoordinatorJobException(ErrorCode.E1004, e.getMessage(), e);

            }

            attr.setValue(val);

        }

        return val;

    }

    /**

     * Include referred datasets into XML.

     *

     * @param resolvedXml : Job XML element.

     * @param conf : Job configuration

     * @throws CoordinatorJobException thrown if failed to include referred datasets into XML

     */

    @SuppressWarnings("unchecked")

    protected void includeDataSets(Element resolvedXml, Configuration conf) throws CoordinatorJobException {

        Element datasets = resolvedXml.getChild("datasets", resolvedXml.getNamespace());

        Element allDataSets = new Element("all_datasets", resolvedXml.getNamespace());

        List<String> dsList = new ArrayList<String>();

        if (datasets != null) {

            for (Element includeElem : (List<Element>) datasets.getChildren("include", datasets.getNamespace())) {

                String incDSFile = includeElem.getTextTrim();

                includeOneDSFile(incDSFile, dsList, allDataSets, datasets.getNamespace());

            }

            for (Element e : (List<Element>) datasets.getChildren("dataset", datasets.getNamespace())) {

                String dsName = e.getAttributeValue("name");

                if (dsList.contains(dsName)) {// Override with this DS

                    // Remove old DS

                    removeDataSet(allDataSets, dsName);

                }

                else {

                    dsList.add(dsName);

                }

                allDataSets.addContent((Element) e.clone());

            }

        }

        insertDataSet(resolvedXml, allDataSets);

        resolvedXml.removeChild("datasets", resolvedXml.getNamespace());

    }

    /**

     * Include one dataset file.

     *

     * @param incDSFile : Include data set filename.

     * @param dsList :List of dataset names to verify the duplicate.

     * @param allDataSets : Element that includes all dataset definitions.

     * @param dsNameSpace : Data set name space

     * @throws CoordinatorJobException thrown if failed to include one dataset file

     */

    @SuppressWarnings("unchecked")

    private void includeOneDSFile(String incDSFile, List<String> dsList, Element allDataSets, Namespace dsNameSpace)

    throws CoordinatorJobException {

        Element tmpDataSets = null;

        try {

            String dsXml = readDefinition(incDSFile);

            LOG.debug("DSFILE :" + incDSFile + "\n" + dsXml);

            tmpDataSets = XmlUtils.parseXml(dsXml);

        }

        catch (JDOMException e) {

            LOG.warn("Error parsing included dataset [{0}].  Message [{1}]", incDSFile, e.getMessage());

            throw new CoordinatorJobException(ErrorCode.E0700, e.getMessage());

        }

        resolveDataSets(tmpDataSets.getChildren("dataset"));

        for (Element e : (List<Element>) tmpDataSets.getChildren("dataset")) {

            String dsName = e.getAttributeValue("name");

            if (dsList.contains(dsName)) {

                throw new RuntimeException("Duplicate Dataset " + dsName);

            }

            dsList.add(dsName);

            Element tmp = (Element) e.clone();

            // TODO: Don't like to over-write the external/include DS's namespace

            tmp.setNamespace(dsNameSpace);

            tmp.getChild("uri-template").setNamespace(dsNameSpace);

            if (e.getChild("done-flag") != null) {

                tmp.getChild("done-flag").setNamespace(dsNameSpace);

            }

            allDataSets.addContent(tmp);

        }

        // nested include

        for (Element includeElem : (List<Element>) tmpDataSets.getChildren("include", tmpDataSets.getNamespace())) {

            String incFile = includeElem.getTextTrim();

            includeOneDSFile(incFile, dsList, allDataSets, dsNameSpace);

        }

    }

    /**

     * Remove a dataset from a list of dataset.

     *

     * @param eDatasets : List of dataset

     * @param name : Dataset name to be removed.

     */

    @SuppressWarnings("unchecked")

    private static void removeDataSet(Element eDatasets, String name) {

        for (Element eDataset : (List<Element>) eDatasets.getChildren("dataset", eDatasets.getNamespace())) {

            if (eDataset.getAttributeValue("name").equals(name)) {

                eDataset.detach();

            }

        }

        throw new RuntimeException("undefined dataset: " + name);

    }

    /**

     * Read coordinator definition.

     *

     * @param appPath application path.

     * @return coordinator definition.

     * @throws CoordinatorJobException thrown if the definition could not be read.

     */

    protected String readDefinition(String appPath) throws CoordinatorJobException {

        String user = ParamChecker.notEmpty(conf.get(OozieClient.USER_NAME), OozieClient.USER_NAME);

        // Configuration confHadoop = CoordUtils.getHadoopConf(conf);

        try {

            URI uri = new URI(appPath);

            LOG.debug("user =" + user);

            HadoopAccessorService has = Services.get().get(HadoopAccessorService.class);

            Configuration fsConf = has.createJobConf(uri.getAuthority());

            FileSystem fs = has.createFileSystem(user, uri, fsConf);

            Path appDefPath = null;

            // app path could be a directory

            Path path = new Path(uri.getPath());

            // check file exists for dataset include file, app xml already checked

            if (!fs.exists(path)) {

                throw new URISyntaxException(path.toString(), "path not existed : " + path.toString());

            }

            if (!fs.isFile(path)) {

                appDefPath = new Path(path, COORDINATOR_XML_FILE);

            } else {

                appDefPath = path;

            }

            Reader reader = new InputStreamReader(fs.open(appDefPath));

            StringWriter writer = new StringWriter();

            IOUtils.copyCharStream(reader, writer);

            return writer.toString();

        }

        catch (IOException ex) {

            LOG.warn("IOException :" + XmlUtils.prettyPrint(conf), ex);

            throw new CoordinatorJobException(ErrorCode.E1001, ex.getMessage(), ex);

        }

        catch (URISyntaxException ex) {

            LOG.warn("URISyException :" + ex.getMessage());

            throw new CoordinatorJobException(ErrorCode.E1002, appPath, ex.getMessage(), ex);

        }

        catch (HadoopAccessorException ex) {

            throw new CoordinatorJobException(ex);

        }

        catch (Exception ex) {

            LOG.warn("Exception :", ex);

            throw new CoordinatorJobException(ErrorCode.E1001, ex.getMessage(), ex);

        }

    }

    /**

     * Write a coordinator job into database

     *

     * @param eJob : XML element of job

     * @param coordJob : Coordinator job bean

     * @return Job id

     * @throws CommandException thrown if unable to save coordinator job to db

     */

    private String storeToDB(Element eJob, CoordinatorJobBean coordJob) throws CommandException {

        String jobId = Services.get().get(UUIDService.class).generateId(ApplicationType.COORDINATOR);

        coordJob.setId(jobId);

        coordJob.setAuthToken(this.authToken);

        coordJob.setAppPath(conf.get(OozieClient.COORDINATOR_APP_PATH));

        coordJob.setCreatedTime(new Date());

        coordJob.setUser(conf.get(OozieClient.USER_NAME));

        String group = ConfigUtils.getWithDeprecatedCheck(conf, OozieClient.JOB_ACL, OozieClient.GROUP_NAME, null);

        coordJob.setGroup(group);

        coordJob.setConf(XmlUtils.prettyPrint(conf).toString());

        coordJob.setJobXml(XmlUtils.prettyPrint(eJob).toString());

        coordJob.setLastActionNumber(0);

        coordJob.setLastModifiedTime(new Date());

        if (!dryrun) {

            coordJob.setLastModifiedTime(new Date());

            try {

                jpaService.execute(new CoordJobInsertJPAExecutor(coordJob));

            }

            catch (JPAExecutorException je) {

                throw new CommandException(je);

            }

        }

        return jobId;

    }

    /*

     * this method checks if the initial-instance specified for a particular

       is not a date earlier than the oozie server default Jan 01, 1970 00:00Z UTC

     */

    private void checkInitialInstance(String val) throws CoordinatorJobException, IllegalArgumentException {

        Date initialInstance, givenInstance;

        DateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm'Z'");

        df.setTimeZone(TimeZone.getTimeZone("UTC"));

        try {

            initialInstance = DateUtils.parseDateUTC("1970-01-01T00:00Z");

            givenInstance = DateUtils.parseDateUTC(val);

        }

        catch (Exception e) {

            throw new IllegalArgumentException("Unable to parse dataset initial-instance string '" + val + "' to Date object. ",e);

        }

        if(givenInstance.compareTo(initialInstance) < 0) {

            throw new CoordinatorJobException(ErrorCode.E1021, "Dataset initial-instance " + df.format(givenInstance) + " is earlier than the default initial instance " + df.format(initialInstance));

        }

    }

    /* (non-Javadoc)

     * @see org.apache.oozie.command.XCommand#getEntityKey()

     */

    @Override

    public String getEntityKey() {

        return null;

    }

    /* (non-Javadoc)

     * @see org.apache.oozie.command.XCommand#isLockRequired()

     */

    @Override

    protected boolean isLockRequired() {

        return false;

    }

    /* (non-Javadoc)

     * @see org.apache.oozie.command.XCommand#loadState()

     */

    @Override

    protected void loadState() throws CommandException {

        jpaService = Services.get().get(JPAService.class);

        if (jpaService == null) {

            throw new CommandException(ErrorCode.E0610);

        }

        coordJob = new CoordinatorJobBean();

        if (this.bundleId != null) {

            // this coord job is created from bundle

            coordJob.setBundleId(this.bundleId);

            // first use bundle id if submit thru bundle

            logInfo.setParameter(DagXLogInfoService.JOB, this.bundleId);

            LogUtils.setLogInfo(logInfo);

        }

        if (this.coordName != null) {

            // this coord job is created from bundle

            coordJob.setAppName(this.coordName);

        }

        setJob(coordJob);

    }

    /* (non-Javadoc)

     * @see org.apache.oozie.command.XCommand#verifyPrecondition()

     */

    @Override

    protected void verifyPrecondition() throws CommandException {

    }

    /* (non-Javadoc)

     * @see org.apache.oozie.command.TransitionXCommand#notifyParent()

     */

    @Override

    public void notifyParent() throws CommandException {

        // update bundle action

        if (coordJob.getBundleId() != null) {

            LOG.debug("Updating bundle record: " + coordJob.getBundleId() + " for coord id: " + coordJob.getId());

            BundleStatusUpdateXCommand bundleStatusUpdate = new BundleStatusUpdateXCommand(coordJob, prevStatus);

            bundleStatusUpdate.call();

        }

    }

    /* (non-Javadoc)

     * @see org.apache.oozie.command.TransitionXCommand#updateJob()

     */

    @Override

    public void updateJob() throws CommandException {

    }

    /* (non-Javadoc)

     * @see org.apache.oozie.command.TransitionXCommand#getJob()

     */

    @Override

    public Job getJob() {

        return coordJob;

    }

}