WrappedUrlProvisionOption.java

/*
 * Copyright 2008 Alin Dreghiciu.
 *
 * Licensed 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.
 */
package org.ops4j.pax.exam.options;

/**
 * Option specifying a provision url that will wrap (osgify) another bundle.
 *
 * @author Alin Dreghiciu (adreghiciu@gmail.com)
 * @since 0.3.0, December 27, 2008
 */
public class WrappedUrlProvisionOption
    extends AbstractUrlProvisionOption<WrappedUrlProvisionOption>
{

    /**
     * Wrapped jar bundle symbolic name. Can be null.
     */
    private String m_bundleSymbolicName;
    /**
     * Wrapped jar bundle version. Can be null.
     */
    private String m_bundleVersion;
    /**
     * Wrapped jar imports.
     */
    private String[] m_imports;
    /**
     * Wrapped jar exports.
     */
    private String[] m_exports;
    /**
     * Wrapped jar raw instructions.
     */
    private String[] m_instructions;
    private WrappedUrlProvisionOption.OverwriteMode m_overwriteMode;

    /**
     * Constructor.
     *
     * @param url wrapped jar url (cannot be null or empty)
     *
     * @throws IllegalArgumentException - If url is null or empty
     */
    public WrappedUrlProvisionOption( final String url )
    {
        super( url );
    }

    /**
     * Constructor.
     *
     * @param url wrapped jar url (cannot be null)
     *
     * @throws IllegalArgumentException - If url is null
     */
    public WrappedUrlProvisionOption( final UrlReference url )
    {
        super( url );
    }

    /**
     * {@inheritDoc}
     */
    public String getURL()
    {
        final StringBuilder options = new StringBuilder();
        if( m_overwriteMode != null )
        {
            if( options.length() > 0 )
            {
                options.append( "&" );
            }
            options.append( "overwrite=" ).append( m_overwriteMode );
        }
        if( m_bundleSymbolicName != null )
        {
            if( options.length() > 0 )
            {
                options.append( "&" );
            }
            options.append( "Bundle-SymboliName=" ).append( m_bundleSymbolicName );
        }
        if( m_bundleVersion != null )
        {
            if( options.length() > 0 )
            {
                options.append( "&" );
            }
            options.append( "Bundle-Version=" ).append( m_bundleVersion );
        }
        if( m_imports != null && m_imports.length > 0 )
        {
            if( options.length() > 0 )
            {
                options.append( "&" );
            }
            options.append( "Import-Package=" );
            for( String entry : m_imports )
            {
                options.append( entry ).append( "," );
            }
            options.delete( options.length() - 1, options.length() );
        }
        if( m_exports != null && m_exports.length > 0 )
        {
            if( options.length() > 0 )
            {
                options.append( "&" );
            }
            options.append( "Export-Package=" );
            for( String entry : m_exports )
            {
                options.append( entry ).append( "," );
            }
            options.delete( options.length() - 1, options.length() );
        }
        if( m_instructions != null && m_instructions.length > 0 )
        {
            for( String entry : m_instructions )
            {
                if( options.length() > 0 )
                {
                    options.append( "&" );
                }
                options.append( entry );
            }
        }
        if( options.length() > 0 )
        {
            options.insert( 0, "$" );
        }
        return "wrap:" + super.getURL() + options.toString();
    }

    /**
     * Sets wrapped jar bundle symbolic name.
     *
     * @param bundleSymbolicName bundle symbolic name
     *
     * @return itself
     */
    public WrappedUrlProvisionOption bundleSymbolicName( final String bundleSymbolicName )
    {
        m_bundleSymbolicName = bundleSymbolicName;

        return this;
    }

    /**
     * Sets wrapped jar bundle version.
     *
     * @param bundleVersion bundle symbolic name
     *
     * @return itself
     */
    public WrappedUrlProvisionOption bundleVersion( final String bundleVersion )
    {
        m_bundleVersion = bundleVersion;

        return this;
    }

    /**
     * Sets wrapped jar imports.
     *
     * @param imports BND style imports
     *
     * @return itself
     */
    public WrappedUrlProvisionOption imports( final String... imports )
    {
        m_imports = imports;

        return this;
    }

    /**
     * Sets wrapped jar exports.
     *
     * @param exports BND style exports
     *
     * @return itself
     */
    public WrappedUrlProvisionOption exports( final String... exports )
    {
        m_exports = exports;

        return this;
    }

    /**
     * Sets wrapped jar manifest overwrite mode.
     *
     * @param mode overwrite mode
     *
     * @return itself
     */
    public WrappedUrlProvisionOption overwriteManifest( final OverwriteMode mode )
    {
        m_overwriteMode = mode;

        return this;
    }

    /**
     * Sets wrapped jar raw BND instructions.
     *
     * @param instructions BND instructions
     *
     * @return itself
     */
    public WrappedUrlProvisionOption instructions( final String... instructions )
    {
        m_instructions = instructions;

        return this;
    }

    /**
     * {@inheritDoc}
     */
    protected WrappedUrlProvisionOption itself()
    {
        return this;
    }

    /**
     * Strategy to use regarding manifest rewrite, for a jar that is already a bundle (has osgi manifest attributes).
     */
    public static enum OverwriteMode
    {

        /**
         * Keep existing manifest.
         */
        KEEP,

        /**
         * Merge instructions with current manifest entries.
         */
        MERGE,

        /**
         * Full rewrite.
         */
        FULL

    }

}