pdpservice-build.xml

<?xml version="1.0"?>

<!--
  ~ /////////////////////////////////////////////////////////////////////////////
  ~ // This file is part of the "Hyrax Data Server" project.
  ~ //
  ~ //
  ~ // Copyright (c) 2013 OPeNDAP, Inc.
  ~ // Author: Nathan David Potter  <ndp@opendap.org>
  ~ //
  ~ // This library is free software; you can redistribute it and/or
  ~ // modify it under the terms of the GNU Lesser General Public
  ~ // License as published by the Free Software Foundation; either
  ~ // version 2.1 of the License, or (at your option) any later version.
  ~ //
  ~ // This library is distributed in the hope that it will be useful,
  ~ // but WITHOUT ANY WARRANTY; without even the implied warranty of
  ~ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  ~ // Lesser General Public License for more details.
  ~ //
  ~ // You should have received a copy of the GNU Lesser General Public
  ~ // License along with this library; if not, write to the Free Software
  ~ // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
  ~ //
  ~ // You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
  ~ /////////////////////////////////////////////////////////////////////////////
  -->

<!-- Build file for OPeNDAP core software -->

<project
        name="Simple Policy Decision Point"
        default="all" basedir=".">

    <description>Builds the Simple Policy Decision Point web service WAR file.</description>

    <!-- Global Properties for Java-OPeNDAP software development -->

    <property name="DEPLOYMENT_CONTEXT" value="pdp"/>


    <!-- ********************************************* -->
    <!-- Project-wide settings. All directories are    -->
    <!-- relative to the project "Basedir" directory,  -->
    <!-- which is assumed (by this file) to be set to  -->
    <!-- ".."                                          -->
    <!-- - - - - - - - - - - - - - - - - - - - - - - - -->

    <!-- Version Tag: Used for doing distribution builds.
         This property should be set from the command
         line by the distribution build script using
         tag information from CVS.
    -->
    <property name="PDP_SERVICE_VERSION" value="Not.A.Release"/>
    <property name="WEBAPP_DIST"   value="pdpService-${PDP_SERVICE_VERSION}-webapp"/>
    <property name="SRC_DIST"      value="pdpService-${PDP_SERVICE_VERSION}-src"/>
    <property name="DOC_DIST"      value="pdpService-${PDP_SERVICE_VERSION}-doc"/>
    <property name="OLFS_LIB"      value="pdpService-${PDP_SERVICE_VERSION}"/>


    <!-- Compiler Settings -->

    <property name="compile.debug" value="on"/>
    <property name="compile.debuglevel" value="lines,vars,source"/>
    <property name="compile.deprecation" value="on"/>

    <property name="modern.compiler" value="modern"/>
    <property name="classic.compiler" value="classic"/>

    <!--  build.compiler: This is a "magic" property.
         In the javac task, if the "compiler" property is not
         explicitly set, then javac will use the value of this
         property ("build.compiler") to set the compiler type.

    See the online ANT Users Manual.
    Read the section the comipler attribute of the javac task.
    http://ant.apache.org/manual/index.html
    -->
    <property name="build.compiler" value="${modern.compiler}"/>



    <!-- build.sysclasspath
         This is a "magic" property. The value of the build.sysclasspath
         property controls how the system classpath, ie. the classpath in
         effect when Ant is run, affects the behaviour of classpaths in
         Ant. The default behavior varies from Ant to Ant task.

         The values and their meanings are:
            only -   Only the system classpath is used and classpaths
                     specified in build files, etc are ignored. This
                     situation could be considered as the person running
                     the build file knows more about the environment
                     than the person writing the build file
            ignore - The system classpath is ignored. This situation is
                     the reverse of the above. The person running the
                     build trusts the build file writer to get the build
                     file right
            last -   The classpath is concatenated to any specified
                     classpaths at the end. This is a compromise, where
                     the build file writer has priority.
            first -  Any specified classpaths are concatenated to the
                     system classpath. This is the other form of compromise
                     where the build runner has priority.

    Excerpted from the online ANT users Manual
    http://ant.apache.org/manual/sysclasspath.html
    -->
    <property name="build.sysclasspath" value="ignore"/>



    <!-- ********************************************* -->

    <!-- Target to create the build directories -->
    <!-- prior to a compile target. We also mark -->
    <!-- the start time of the build for the log. -->

    <target name="noop" description="Do Nothing Target">
        <echo level="info" message="no-op target in ${ant.file}"/>
    </target>


    <target name="show" description="Show build settings.">

        <echo level="info" message="Project Name:          ${ant.project.name}"/>
        <echo level="info" message="Project File:          ${ant.file}"/>
        <echo level="info" message="PdP Service Version:   ${PDP_SERVICE_VERSION}"/>
        <echo level="info" message="Deployment Context:    ${DEPLOYMENT_CONTEXT}"/>
        <echo level="info" message=""/>
        <echo level="info" message="Project Directories:"/>
        <echo level="info" message="    src.dir:           ${src.dir}"/>
        <echo level="info" message="    doc.dir:           ${doc.dir}"/>
        <echo level="info" message="    lib.dir:           ${lib.dir}"/>
        <echo level="info" message="    resources.dir:     ${resources.dir}"/>
        <echo level="info" message=""/>
        <echo level="info" message="Build Directories:"/>
        <echo level="info" message="    build.dir:         ${build.dir}"/>
        <echo level="info" message="    build.classes:     ${build.classes}"/>
        <echo level="info" message="    build.doc:         ${build.docs}"/>
        <echo level="info" message="    build.resources:   ${build.resources}"/>
        <echo level="info" message=""/>
        <echo level="info" message="Ant Properties:"/>
        <echo level="info" message="    ant.file:          ${ant.file}"/>
        <echo level="info" message="    ant.home:          ${ant.home}"/>
        <echo level="info" message="    ant.java.version:  ${ant.java.version}"/>
        <echo level="info" message="    ant.project.name:  ${ant.project.name}"/>
        <echo level="info" message="    ant.version:       ${ant.version}"/>
        <echo level="info" message="    basedir:           ${basedir}"/>
        <echo level="info" message="    user.name:         ${user.name}"/>
        <echo level="info" message="    user.home:         ${user.home}"/>
        <echo level="info" message="    java.home:         ${java.home}"/>
        <echo level="info" message=""/>
        <echo level="info" message="Distribution Targets: "/>
        <echo level="info" message="    WEBAPP_DIST:       ${WEBAPP_DIST}"/>
        <echo level="info" message="    SRC_DIST:          ${SRC_DIST}"/>
        <echo level="info" message="    DOC_DIST:          ${DOC_DIST}"/>
        <echo level="info" message="    OLFS_LIB:          ${OLFS_LIB}"/>
        <echo level="info" message=""/>

    </target>


    <!-- ################################################################# -->
    <!--                      Project Settings                             -->
    <!-- ................................................................. -->



    <!-- Project directories -->
    <property name="src.dir" location="src"/>
    <property name="doc.dir" location="doc"/>
    <property name="lib.dir" location="lib"/>
    <property name="resources.dir" location="resources/pdpService"/>
    <property name="WebInfResources.dir" location="${resources.dir}/WEB-INF"/>




    <!-- Build Directories -->
    <property name="build.dir" location="build"/>
    <property name="build.classes" location="${build.dir}/classes"/>
    <property name="build.docs" location="${build.dir}/docs"/>
    <property name="build.dist" location="${build.dir}/dist"/>
    <property name="build.lib" location="${build.dir}/lib"/>
    <property name="build.run" location="${build.dir}/run"/>
    <property name="build.src" location="${build.dir}/src"/>
    <property name="build.resources" location="${build.dir}/resources"/>
    <property name="build.webapp" location="${build.dir}/webapp"/>



    <!--
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Libraries
    -->
    <property name="json.lib" value="gson-2.8.9.jar"/>


    <property name="junit.lib" value="junit-4.4.jar"/>
    <property name="jdom.lib" value="jdom-1.1.1.jar"/>
    <property name="urlRewrite.lib" value="urlrewrite-3.2.0.jar"/>


    <property name="slf4j.lib" value="slf4j-api-1.7.32.jar"/>
    <property name="logback-core.lib" value="logback-core-1.2.9.jar"/>
    <property name="logback-classic.lib" value="logback-classic-1.2.9.jar"/>

    <property name="commons-cli.lib" value="apache-commons-cli-1.2.jar"/>
    <property name="commons-codec.lib" value="apache-commons-codec-1.8.jar"/>
    <property name="commons-httpclient.lib" value="apache-commons-httpclient-3.1.jar"/>
    <property name="commons-lang.lib" value="apache-commons-lang-2.5.jar"/>
    <property name="commons-logging.lib" value="apache-commons-logging-1.1.3.jar"/>
    <property name="commons-io.lib" value="apache-commons-io-2.4.jar"/>


    <property name="http-components-httpclient.lib" value="org.apache.httpcomponents.httpclient_4.5.3.jar"/>
    <property name="http-components-httpcore.lib" value="org.apache.httpcomponents.httpcore_4.4.6.jar"/>


    <property name="xalan.lib" value="xalan-j-2.7.3.jar"/>
    <property name="xercesImpl.lib" value="xercesImpl-2.12.2.jar"/>
    <property name="xercesXmlApis.lib" value="xerces-xml-apis-2.12.2.jar"/>

    <property name="saxon-jdom.lib" value="saxon-9.1.0.5-jdom.jar"/>
    <property name="saxon-s9api.lib" value="saxon-9.1.0.5-s9api.jar"/>
    <property name="saxon.lib" value="saxon-9.1.0.5.jar"/>

    <property name="catalina.lib" value="catalina-6.0.53.jar"/>
    <property name="servlet-api.lib" value="servlet-api-3.0.jar"/>

    <property name="sjson.lib" value="json-simple-1.1.1.jar"/>

    <property name="owasp-encoder.lib" value="encoder-1.2.2.jar"/>
    <property name="owasp-encoder-jsp.lib" value="encoder-jsp-1.2.2.jar"/>



    <!-- Library (class)paths -->
    <fileset id="pdp-service-libs" dir="${lib.dir}">
        <include name="${owasp-encoder.lib}"/>
        <include name="${owasp-encoder-jsp.lib}"/>

        <include name="${json.lib}"/>
        <include name="${sjson.lib}"/>
        <include name="${jdom.lib}"/>
        <include name="${junit.lib}"/>
        <include name="${commons-cli.lib}"/>

        <include name="${commons-httpclient.lib}"/>

        <include name="${http-components-httpclient.lib}"/>
        <include name="${http-components-httpcore.lib}"/>
        <include name="${commons-logging.lib}"/>
        <include name="${commons-lang.lib}"/>
        <include name="${saxon-jdom.lib}"/>
        <include name="${saxon-s9api.lib}"/>
        <include name="${saxon.lib}"/>

        <include name="${slf4j.lib}"/>
        <include name="${logback-core.lib}"/>
        <include name="${logback-classic.lib}"/>
    </fileset>

    <!-- Library (class)paths -->
    <path id="pdp-service.compile.classpath">
        <pathelement path="${build.classes}"/>
        <!--
            We have to have the catalina and servlet api's on the classpath at
            compile time, but their not needed at deployment because they come
            bundled with Tomcat
        -->
        <fileset dir="${lib.dir}">
            <include name="${catalina.lib}"/>
            <include name="${servlet-api.lib}"/>
        </fileset>
        <fileset refid="pdp-service-libs" />
    </path>

    <target name="all" depends="clean,server"
            description="Builds lots of stuff."/>


    <target name="clean" description="Clean up ALL build products.">
        <delete dir="${build.dir}"/>
    </target>


    <target name="init" description="Prepare all build directories.">
        <mkdir dir="${build.dir}"/>
        <mkdir dir="${build.classes}"/>
        <mkdir dir="${build.docs}"/>
        <mkdir dir="${build.dist}"/>
        <mkdir dir="${build.lib}"/>
        <mkdir dir="${build.run}"/>
        <mkdir dir="${build.src}"/>

        <filter token="PdpServiceVersion" value="${PDP_SERVICE_VERSION}"/>
        <filter token="SERVICE_CONTEXT" value="${DEPLOYMENT_CONTEXT}"/>

        <tstamp/>
        <echo level="info" message="time: ${TSTAMP}"/>
    </target>




    <target  name="PreProcessSourceCode"
             depends="clean,init"
             description="Moves selected source code from the development tree into
             the build/src directory. The code text is filtered to update version numbers.">

        <echo level="info" message="AntFile: ${ant.file} Moving and filtering Source code."/>
        <echo level="info" message=""/>


        <copy todir="${build.src}" filtering="true">
            <fileset dir="${src.dir}">
                <!-- include all the java files -->
                <include name="opendap/PathBuilder.java"/>


                <include name="opendap/auth/AuthenticationControls.java"/>
                <include name="opendap/auth/AuthenticatedHttpRequest.java"/>
                <include name="opendap/auth/ConfigurationException.java"/>
                <include name="opendap/auth/EarthDataLoginAccessToken.java"/>
                <include name="opendap/auth/GuestProfile.java"/>
                <include name="opendap/auth/IdFilter.java"/>
                <include name="opendap/auth/IdPManager.java"/>
                <include name="opendap/auth/IdProvider.java"/>
                <include name="opendap/auth/UserProfile.java"/>
                <include name="opendap/auth/Util.java"/>



                <include name="opendap/bes/AdminInfo.java"/>
                <include name="opendap/bes/BadConfigurationException.java"/>
                <include name="opendap/bes/BES.java"/>
                <include name="opendap/bes/BesAdminFail.java"/>
                <include name="opendap/bes/BESChunkedOutputStream.java"/>
                <include name="opendap/bes/BESConfig.java"/>
                <include name="opendap/bes/BesConfigurationModule.java"/>
                <include name="opendap/bes/BESError.java"/>
                <include name="opendap/bes/BesGroup.java"/>
                <include name="opendap/bes/BESManager.java"/>
                <include name="opendap/bes/BESResource.java"/>
                <include name="opendap/bes/BesSiteMap.java"/>
                <include name="opendap/bes/CyclicGroup.java"/>

                <include name="opendap/bes/Version.java"/>
                <include name="opendap/bes/caching/**"/>
                <include name="opendap/bes/dap2Responders/BesApi.java"/>
                <include name="opendap/bes/dap4Responders/MediaType.java"/>




                <include name="opendap/coreServlet/RequestCache.java"/>
                <include name="opendap/coreServlet/ServletUtil.java"/>
                <include name="opendap/coreServlet/OPeNDAPException.java"/>
                <include name="opendap/coreServlet/ResourceInfo.java"/>
                <include name="opendap/coreServlet/ReqInfo.java"/>
                <include name="opendap/coreServlet/Scrub.java"/>
                <include name="opendap/coreServlet/Util.java"/>


                <include name="opendap/dap/User.java"/>
                <include name="opendap/dap/Request.java"/>

                <include name="opendap/dap4/Dap4Error.java"/>
                <include name="opendap/dap4/QueryParameters.java"/>

                <include name="opendap/http/mediaTypes/**"/>

                <include name="opendap/io/Chunk.java"/>
                <include name="opendap/io/ChunkedInputStream.java"/>
                <include name="opendap/io/ChunkedOutputStream.java"/>
                <include name="opendap/io/ChunkProtocol.java"/>
                <include name="opendap/io/HyraxStringEncoding.java"/>

                <include name="opendap/logging/Procedure.java"/>
                <include name="opendap/logging/LogUtil.java"/>
                <include name="opendap/logging/Timer.java"/>


                <include name="opendap/ngap/NgapBesApi.java"/>

                <include name="opendap/ppt/NewPPTClient.java"/>
                <include name="opendap/ppt/OPeNDAPClient.java"/>
                <include name="opendap/ppt/PPTEndOfStreamException.java"/>
                <include name="opendap/ppt/PPTException.java"/>
                <include name="opendap/ppt/PPTSessionProtocol.java"/>


                <include name="opendap/namespaces/BES.java"/>
                <include name="opendap/namespaces/DAP4.java"/>




                <include name="opendap/xml/Util.java"/>
                <include name="opendap/xml/Transformer.java"/>




                <!-- Exclude the WCS and semantics code  -->
                <exclude name="opendap/wcs/**"/>

                <!-- Exclude prototype Amazon Web Services code from production -->
                <exclude name="opendap/aws/**"/>

                <!-- Exclude async test code -->
                <exclude name="opendap/async/**"/>


                <!-- Exclude Hyrax (for the most part)   -->
                <exclude name="opendap/gateway/**"/>
                <exclude name="opendap/nciso/**"/>
                <exclude name="opendap/ncml/**"/>
                <exclude name="opendap/semantics/**"/>
                <exclude name="opendap/services/**"/>
                <exclude name="opendap/threddsHandler/**"/>
                <exclude name="opendap/viewers/**"/>
                <exclude name="opendap/wcs/**"/>
                <exclude name="opendap/webstart/**"/>



            </fileset>
        </copy>


        <!-- Copy and filter all of the web application resources -->
        <copy todir="${build.resources}" filtering="true">
            <fileset dir="${resources.dir}"/>
        </copy>



    </target>


    <target
            name="compile"
            depends="PreProcessSourceCode"
            description="Compiles the OLFS."
            >
        <echo level="info" message="AntFile: ${ant.file} Compiling OLFS"/>
        <echo level="info"
              message="Using the ${build.compiler} javac compiler"/>
        <echo level="info" message=""/>

        <javac compiler="${build.compiler}"
               destdir="${build.classes}"
               debug="${compile.debug}"
               debuglevel="${compile.debuglevel}"
               deprecation="${compile.deprecation}">

            <classpath refid="pdp-service.compile.classpath"/>

            <src path="${build.src}"/>

        </javac>

    </target>




    <target
            name="server"
            depends="clean,compile"
            description="Performs a clean build of the PdP Service software and assembles the WAR file."
            >



        <echo level="info" message="Building PdpService war file."/>
        <echo level="info" message="build.resources: ${build.resources}"/>
        <echo level="info" message="build.dist:      ${build.dist}"/>



        <war destfile="${build.dist}/${DEPLOYMENT_CONTEXT}.war"
             webxml="${build.resources}/WEB-INF/web.xml"
                >

            <lib dir="${lib.dir}">
                <include name="${jdom.lib}"/>
                <include name="${junit.lib}"/>
                <include name="${urlRewrite.lib}"/>
                <include name="${json.lib}"/>

                <include name="${commons-lang.lib}"/>
                <include name="${commons-cli.lib}"/>
                <include name="${http-components-httpclient.lib}"/>
                <include name="${http-components-httpclient-cache.lib}"/>
                <include name="${http-components-httpcore.lib}"/>
                <include name="${commons-logging.lib}"/>
                <include name="${xercesImpl.lib}"/>
                <include name="${xercesXmlApis.lib}"/>
                <include name="${saxon-jdom.lib}"/>
                <include name="${saxon-s9api.lib}"/>
                <include name="${saxon.lib}"/>

                <include name="${slf4j.lib}"/>
                <include name="${logback-core.lib}"/>
                <include name="${logback-classic.lib}"/>

            </lib>
            <classes dir="${build.classes}"/>


            <zipfileset dir="${build.resources}" prefix="">
                <include name="**/*"/>
                <exclude name="WEB-INF/web.xml"/>
            </zipfileset>



            <webinf dir="${build.resources}/WEB-INF">
                <include name="logback-test.xml"/>
                <include name="logback.xml"/>
            </webinf>


        </war>

        <delete file="${build.dist}/index.html"/>

    </target>




</project>