org.openmdx.base.naming.URLEncoder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmdx-dalvik Show documentation
openMDX/Dalvik Library
There is a newer version: 2.18.10
/*
 * ====================================================================
 * Project:     openMDX/Core, http://www.openmdx.org/
 * Description: URL Encoder 
 * Owner:       OMEX AG, Switzerland, http://www.omex.ch
 * ====================================================================
 *
 * This software is published under the BSD license as listed below.
 * 
 * Copyright (c) 2019, OMEX AG, Switzerland
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in
 *   the documentation and/or other materials provided with the
 *   distribution.
 * 
 * * Neither the name of the openMDX team nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * ------------------
 * 
 * This product includes software developed by other organizations as
 * listed in the NOTICE file.
 */
package org.openmdx.base.naming;

import org.openmdx.kernel.xri.XRIAuthorities;

/**
 * URLEncoder
 */
public class URLEncoder {
    
    /**
     * Constructor
     *
     * @param contextURL
     *            the context URL without trailing '/'
     */
    public URLEncoder(String contextURL) {
        this.contextURL = contextURL;
    }

    /**
     * the context URL without trailing '/'
     */
    private final String contextURL;

    private static final int AUTHORITY_LENGTH = XRIAuthorities.OPENMDX_AUTHORITY.length();
    
    /**
     * Appends the URL encoded XRI to the base by omitting the openMDX authority sub-segment
     * 
     * @param xri the XRI to be appended to the base URL
     * 
     * @return the encoded URL
     */
    public String encode(Path xri) {
        return contextURL + withoutFirstSubsegment(xri.toURI());
    }
    
    private String withoutFirstSubsegment(String uri) {
        final int length = uri.length();
        if(length <= AUTHORITY_LENGTH) return "";
        final boolean persistent = uri.charAt(AUTHORITY_LENGTH) == '!';
        return "/" + uri.substring(persistent ? AUTHORITY_LENGTH : AUTHORITY_LENGTH + 1);
    }

    
    /**
     * Retrieve the context URL.
     *
     * @return Returns the context URL
     */
    public String getContextURL() {
        return this.contextURL;
    }

}