001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.q2;
020
021import java.io.File;
022
023/**
024 * Provides optional decoration (variable substitution, templating, etc.) for Q2 deploy descriptor files.
025 */
026public interface ConfigDecorationProvider
027{
028    /**
029     * Initializes this provider with the given Q2 deploy directory.
030     * @param deployDir the Q2 deploy directory
031     * @throws Exception on initialization failure
032     */
033    void initialize(File deployDir) throws Exception;
034    /** Releases resources used by this provider. */
035    void uninitialize();
036    /**
037     * Processes and decorates a deploy descriptor file.
038     * @param f deploy descriptor file
039     * @return the decorated content
040     * @throws Exception on processing failure
041     */
042    String decorateFile(File f) throws Exception;
043}