src/main/java/org/apache/sling/api/resource/uri/ResourceUriBuilder.java - sling-org-apache-sling-api - Git at Google

 /*
  * 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.
  */
 package org.apache.sling.api.resource.uri;

 import java.net.URI;
 import java.net.URISyntaxException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.LinkedHashMap;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;

 import org.apache.commons.lang3.StringUtils;
 import org.apache.sling.api.SlingHttpServletRequest;
 import org.apache.sling.api.request.RequestPathInfo;
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ResourceResolver;

 public class ResourceUriBuilder {

     static final String CHAR_HASH = "#";
     static final String CHAR_QM = "?";
     static final String CHAR_DOT = ".";
     static final String CHAR_SLASH = "/";
     static final String CHAR_AT = "@";
     static final String SELECTOR_DOT_REGEX = "\\.(?!\\.?/)"; // (?!\\.?/) to avoid matching ./ and ../
     static final String CHAR_COLON = ":";
     static final String CHAR_SEMICOLON = ";";
     static final String CHAR_EQUALS = "=";
     static final String CHAR_SINGLEQUOTE = "'";

     public static ResourceUriBuilder create() {
         return new ResourceUriBuilder();
     }

     /** Creates a builder from another ResourceUri.
      *
      * @param resourceUri
      * @return a ResourceUriBuilder */
     public static ResourceUriBuilder createFrom(ResourceUri resourceUri) {
         return create()
                 .setScheme(resourceUri.getScheme())
                 .setUserInfo(resourceUri.getUserInfo())
                 .setHost(resourceUri.getHost())
                 .setPort(resourceUri.getPort())
                 .setResourcePath(resourceUri.getResourcePath())
                 .setPathParameters(resourceUri.getPathParameters())
                 .setSelectors(resourceUri.getSelectors())
                 .setExtension(resourceUri.getExtension())
                 .setSuffix(resourceUri.getSuffix())
                 .setQuery(resourceUri.getQuery())
                 .setFragment(resourceUri.getFragment())
                 .setSchemeSpecificPart(resourceUri.getSchemeSpecificPart())
                 .setResourceResolver(resourceUri instanceof ImmutableResourceUri
                         ? ((ImmutableResourceUri) resourceUri).getBuilder().resourceResolver
                         : null);
     }

     /** Creates a builder from a Resource (only taking the resource path into account).
      *
      * @param resource
      * @return a ResourceUriBuilder */
     public static ResourceUriBuilder createFrom(Resource resource) {
         return create()
                 .setResourcePath(resource.getPath())
                 .setResourceResolver(resource.getResourceResolver());
     }

     /** Creates a builder from a RequestPathInfo instance .
      *
      * @param requestPathInfo
      * @return a ResourceUriBuilder */
     public static ResourceUriBuilder createFrom(RequestPathInfo requestPathInfo) {
         return create()
                 .setResourcePath(requestPathInfo.getResourcePath())
                 .setSelectors(requestPathInfo.getSelectors())
                 .setExtension(requestPathInfo.getExtension())
                 .setSuffix(requestPathInfo.getSuffix());
     }

     /** Creates a builder from a request.
      *
      * @param request
      * @return a ResourceUriBuilder */
     public static ResourceUriBuilder createFrom(SlingHttpServletRequest request) {
         return createFrom(request.getRequestPathInfo())
                 .setResourceResolver(request.getResourceResolver())
                 .setScheme(request.getScheme())
                 .setHost(request.getServerName())
                 .setPort(request.getServerPort());
     }

     /** Creates a builder from a URI.
      *
      * @param uri
      * @return a ResourceUriBuilder */
     public static ResourceUriBuilder createFrom(URI uri, ResourceResolver resourceResolver) {
         String path = uri.getPath();
         boolean pathExists = !StringUtils.isBlank(path);
         boolean schemeSpecificRelevant = !pathExists && uri.getQuery() == null;
         return create()
                 .setResourceResolver(resourceResolver)
                 .setScheme(uri.getScheme())
                 .setUserInfo(uri.getUserInfo())
                 .setHost(uri.getHost())
                 .setPort(uri.getPort())
                 .setPath(pathExists ? path : null)
                 .setQuery(uri.getQuery())
                 .setFragment(uri.getFragment())
                 .setSchemeSpecificPart(schemeSpecificRelevant ? uri.getSchemeSpecificPart() : null);
     }

     /** Creates a builder from an arbitrary URI string.
      *
      * @param resourceUriStr
      * @return a ResourceUriBuilder */
     public static ResourceUriBuilder parse(String resourceUriStr, ResourceResolver resourceResolver) {
         URI uri;
         try {
             uri = new URI(resourceUriStr);
             return createFrom(uri, resourceResolver);
         } catch (URISyntaxException e) {
             throw new IllegalArgumentException("Invalid URI " + resourceUriStr + ": " + e.getMessage(), e);
         }
     }

     /** Creates a builder from a resource path.
      *
      * @param resourcePathStr
      * @return a ResourceUriBuilder */
     public static ResourceUriBuilder forPath(String resourcePathStr) {
         return new ResourceUriBuilder().setPath(resourcePathStr);
     }

     private String scheme = null;

     private String userInfo = null;
     private String host = null;
     private int port = -1;

     private String resourcePath = null;
     private final List<String> selectors = new LinkedList<>();
     private String extension = null;
     private final Map<String, String> pathParameters = new LinkedHashMap<>();
     private String suffix = null;
     private String schemeSpecificPart = null;
     private String query = null;
     private String fragment = null;

     // only needed for getSuffixResource() from interface RequestPathInfo
     private ResourceResolver resourceResolver = null;

     private ResourceUriBuilder() {
     }

     /** @param userInfo
      * @return the builder for method chaining */
     public ResourceUriBuilder setUserInfo(String userInfo) {
         if (schemeSpecificPart != null) {
             return this;
         }
         this.userInfo = userInfo;
         return this;
     }

     /** @param host
      * @return the builder for method chaining */
     public ResourceUriBuilder setHost(String host) {
         if (schemeSpecificPart != null) {
             return this;
         }
         this.host = host;
         return this;
     }

     /** @param port
      * @return the builder for method chaining */
     public ResourceUriBuilder setPort(int port) {
         if (schemeSpecificPart != null) {
             return this;
         }
         this.port = port;
         return this;
     }

     /** @param path
      * @return the builder for method chaining */
     public ResourceUriBuilder setPath(String path) {
         if (schemeSpecificPart != null) {
             return this;
         }

         // path parameters
         Map<String, String> currentPathParameters = null;
         if (path != null) {
             Pattern pathParameterRegex = Pattern.compile(";([a-zA-z0-9]+)=(?:\\'([^']*)\\'|([^/]+))");

             StringBuffer resultString = null;
             Matcher regexMatcher = pathParameterRegex.matcher(path);
             while (regexMatcher.find()) {
                 if (resultString == null) {
                     resultString = new StringBuffer();
                 }
                 if (currentPathParameters == null) {
                     currentPathParameters = new LinkedHashMap<>();
                 }
                 regexMatcher.appendReplacement(resultString, "");
                 String key = regexMatcher.group(1);
                 String value = StringUtils.defaultIfEmpty(regexMatcher.group(2), regexMatcher.group(3));
                 currentPathParameters.put(key, value);
             }
             if (resultString != null) {
                 regexMatcher.appendTail(resultString);
                 path = resultString.toString();
                 pathParameters.putAll(currentPathParameters);
             }
         }

         // regular RequestPathInfo
         Matcher dotMatcher;
         if (path != null && (dotMatcher = Pattern.compile(SELECTOR_DOT_REGEX).matcher(path)).find()) {
             int firstDotPosition = dotMatcher.start();
             int firstSlashAfterFirstDotPosition = path.indexOf(CHAR_SLASH, firstDotPosition);
             String pathWithoutSuffix = firstSlashAfterFirstDotPosition > -1 ? path.substring(0, firstSlashAfterFirstDotPosition) : path;
             String[] pathBits = pathWithoutSuffix.split(SELECTOR_DOT_REGEX);
             setResourcePath(pathBits[0]);
             if (pathBits.length > 2) {
                 setSelectors(Arrays.copyOfRange(pathBits, 1, pathBits.length - 1));
             }
             setExtension(pathBits.length > 1 ? pathBits[pathBits.length - 1] : null);
             setSuffix(firstSlashAfterFirstDotPosition > -1 ? path.substring(firstSlashAfterFirstDotPosition) : null);
         } else {
             setResourcePath(path);
         }

         if (resourceResolver != null) {
             balanceResourcePath();
         }

         return this;
     }

     public ResourceUriBuilder balanceResourcePath() {
         if (schemeSpecificPart != null) {
             return this;
         }
         if (resourceResolver == null) {
             throw new IllegalStateException("setResourceResolver() needs to be called before balanceResourcePath()");
         }
         List<String> potentialResourcePathBits = new ArrayList<>();
         potentialResourcePathBits.add(resourcePath);
         potentialResourcePathBits.addAll(selectors);
         if (extension != null) {
             potentialResourcePathBits.add(extension);
         }
         String fullPathWithSuffix = String.join(".", potentialResourcePathBits) + suffix;
         if (resourceResolver.getResource(fullPathWithSuffix) != null) {
             this.resourcePath = fullPathWithSuffix;
             selectors.clear();
             extension = null;
             suffix = null;
         } else {
             for (int i = potentialResourcePathBits.size(); i > 1; i--) {
                 String potentialResourcePath = String.join(".", potentialResourcePathBits.subList(0, i));
                 if (resourceResolver.getResource(potentialResourcePath) != null) {
                     this.resourcePath = potentialResourcePath;
                     selectors.clear();
                     extension = null;
                     List<String> remainingList = potentialResourcePathBits.subList(i, potentialResourcePathBits.size());
                     if (!remainingList.isEmpty()) {
                         extension = remainingList.get(remainingList.size() - 1);
                         selectors.addAll(remainingList.subList(0, remainingList.size() - 1));
                     }
                     break;
                 }
             }
         }
         return this;
     }

     /** @param resourcePath
      * @return the builder for method chaining */
     public ResourceUriBuilder setResourcePath(String resourcePath) {
         if (schemeSpecificPart != null) {
             return this;
         }
         this.resourcePath = resourcePath;
         return this;
     }

     /** @param selectors
      * @return the builder for method chaining */
     public ResourceUriBuilder setSelectors(String[] selectors) {
         if (schemeSpecificPart != null || resourcePath == null) {
             return this;
         }
         this.selectors.clear();
         Arrays.stream(selectors).forEach(this.selectors::add);
         return this;
     }

     /** @param selector
      * @return the builder for method chaining */
     public ResourceUriBuilder addSelector(String selector) {
         if (schemeSpecificPart != null || resourcePath == null) {
             return this;
         }
         this.selectors.add(selector);
         return this;
     }

     /** @param extension
      * @return the builder for method chaining */
     public ResourceUriBuilder setExtension(String extension) {
         if (schemeSpecificPart != null || resourcePath == null) {
             return this;
         }
         this.extension = extension;
         return this;
     }

     /** @return returns the path parameters */
     public ResourceUriBuilder setPathParameter(String key, String value) {
         if (schemeSpecificPart != null || resourcePath == null) {
             return this;
         }
         this.pathParameters.put(key, value);
         return this;
     }

     public ResourceUriBuilder setPathParameters(Map<String, String> pathParameters) {
         this.pathParameters.clear();
         this.pathParameters.putAll(pathParameters);
         return this;
     }

     /** @param suffix
      * @return the builder for method chaining */
     public ResourceUriBuilder setSuffix(String suffix) {
         if (schemeSpecificPart != null || resourcePath == null) {
             return this;
         }
         if (suffix != null && !StringUtils.startsWith(suffix, "/")) {
             throw new IllegalArgumentException("Suffix needs to start with slash");
         }
         this.suffix = suffix;
         return this;
     }

     /** @param query
      * @return the builder for method chaining */
     public ResourceUriBuilder setQuery(String query) {
         if (schemeSpecificPart != null) {
             return this;
         }
         this.query = query;
         return this;
     }

     /** @param urlFragment
      * @return the builder for method chaining */
     public ResourceUriBuilder setFragment(String urlFragment) {
         if (schemeSpecificPart != null) {
             return this;
         }
         this.fragment = urlFragment;
         return this;
     }

     /** @param scheme
      * @return the builder for method chaining */
     public ResourceUriBuilder setScheme(String scheme) {
         this.scheme = scheme;
         return this;
     }

     /** @param schemeSpecificPart
      * @return the builder for method chaining */
     public ResourceUriBuilder setSchemeSpecificPart(String schemeSpecificPart) {
         if (schemeSpecificPart != null && schemeSpecificPart.isEmpty()) {
             return this;
         }
         this.schemeSpecificPart = schemeSpecificPart;
         return this;
     }

     /** Will remove scheme and authority (that is user info, host and port).
      *
      * @return the builder for method chaining */
     public ResourceUriBuilder removeSchemeAndAuthority() {
         setScheme(null);
         setUserInfo(null);
         setHost(null);
         setPort(-1);
         return this;
     }

     /** Will take over scheme and authority (user info, host and port) from provided resourceUri.
      *
      * @param resourceUri
      * @return the builder for method chaining */
     public ResourceUriBuilder useSchemeAndAuthority(ResourceUri resourceUri) {
         setScheme(resourceUri.getScheme());
         setUserInfo(resourceUri.getUserInfo());
         setHost(resourceUri.getHost());
         setPort(resourceUri.getPort());
         return this;
     }

     // only to support getSuffixResource() from interface RequestPathInfo
     private ResourceUriBuilder setResourceResolver(ResourceResolver resourceResolver) {
         this.resourceResolver = resourceResolver;
         return this;
     }

     /** Will take over scheme and authority (user info, host and port) from provided uri.
      *
      * @param uri
      * @return the builder for method chaining */
     public ResourceUriBuilder useSchemeAndAuthority(URI uri) {
         useSchemeAndAuthority(createFrom(uri, resourceResolver).build());
         return this;
     }

     /** Builds the immutable ResourceUri from this builder.
      *
      * @return the builder for method chaining */
     public ResourceUri build() {
         return new ImmutableResourceUri();
     }

     /** @return string representation of builder */
     public String toString() {
         return build().toString();
     }

     // read-only view on the builder data (to avoid another copy of the data into a new object)
     private class ImmutableResourceUri implements ResourceUri {

         private static final String HTTPS_SCHEME = "https";
         private static final int HTTPS_DEFAULT_PORT = 443;
         private static final String HTTP_SCHEME = "http";
         private static final int HTTP_DEFAULT_PORT = 80;

         @Override
         public String getResourcePath() {
             return resourcePath;
         }

         // returns null in line with
         // https://sling.apache.org/apidocs/sling11/org/apache/sling/api/request/RequestPathInfo.html#getSelectorString--
         @Override
         public String getSelectorString() {
             return !selectors.isEmpty() ? String.join(CHAR_DOT, selectors) : null;
         }

         @Override
         public String[] getSelectors() {
             return selectors.toArray(new String[selectors.size()]);
         }

         @Override
         public String getExtension() {
             return extension;
         }

         @Override
         public Map<String, String> getPathParameters() {
             return pathParameters;
         }

         @Override
         public String getSuffix() {
             return suffix;
         }

         @Override
         public String getSchemeSpecificPart() {
             return schemeSpecificPart;
         }

         @Override
         public String getQuery() {
             return query;
         }

         @Override
         public String getFragment() {
             return fragment;
         }

         @Override
         public String getScheme() {
             return scheme;
         }

         @Override
         public String getHost() {
             return host;
         }

         @Override
         public int getPort() {
             return port;
         }

         @Override
         public Resource getSuffixResource() {
             if (StringUtils.isNotBlank(suffix) && resourceResolver != null) {
                 return resourceResolver.resolve(suffix);
             } else {
                 return null;
             }
         }

         @Override
         public String getUserInfo() {
             return userInfo;
         }

         @Override
         public String toString() {
             StringBuilder requestUri = new StringBuilder();

             if (StringUtils.isNotBlank(scheme)) {
                 requestUri.append(scheme + CHAR_COLON);
             }
             if (isFullUri()) {
                 requestUri.append(CHAR_SLASH + CHAR_SLASH);
                 if (StringUtils.isNotBlank(userInfo)) {
                     requestUri.append(userInfo + CHAR_AT);
                 }
                 requestUri.append(host);
                 if (port > 0
                         && !(scheme.equals(HTTP_SCHEME) && port == HTTP_DEFAULT_PORT)
                         && !(scheme.equals(HTTPS_SCHEME) && port == HTTPS_DEFAULT_PORT)) {
                     requestUri.append(CHAR_COLON + port);
                 }
             }
             if (resourcePath != null) {
                 requestUri.append(resourcePath);
             }
             if (!pathParameters.isEmpty()) {
                 for (Map.Entry<String, String> pathParameter : pathParameters.entrySet()) {
                     requestUri.append(CHAR_SEMICOLON + pathParameter.getKey() + CHAR_EQUALS +
                             CHAR_SINGLEQUOTE + pathParameter.getValue() + CHAR_SINGLEQUOTE);
                 }
             }

             if (!selectors.isEmpty()) {
                 requestUri.append(CHAR_DOT + String.join(CHAR_DOT, selectors));
             }
             if (!StringUtils.isBlank(extension)) {
                 requestUri.append(CHAR_DOT + extension);
             }

             if (!StringUtils.isBlank(suffix)) {
                 requestUri.append(suffix);
             }
             if (schemeSpecificPart != null) {
                 requestUri.append(schemeSpecificPart);
             }
             if (query != null) {
                 requestUri.append(CHAR_QM + query);
             }
             if (fragment != null) {
                 requestUri.append(CHAR_HASH + fragment);
             }
             return requestUri.toString();
         }

         @Override
         public URI toUri() {
             String uriString = toString();
             try {
                 return new URI(uriString);
             } catch (URISyntaxException e) {
                 throw new IllegalArgumentException("Invalid Sling URI: " + uriString, e);
             }
         }

         private ResourceUriBuilder getBuilder() {
             return ResourceUriBuilder.this;
         }

     }

 }
	/*
	* 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.
	*/
	package org.apache.sling.api.resource.uri;

	import java.net.URI;
	import java.net.URISyntaxException;
	import java.util.ArrayList;
	import java.util.Arrays;
	import java.util.LinkedHashMap;
	import java.util.LinkedList;
	import java.util.List;
	import java.util.Map;
	import java.util.regex.Matcher;
	import java.util.regex.Pattern;

	import org.apache.commons.lang3.StringUtils;
	import org.apache.sling.api.SlingHttpServletRequest;
	import org.apache.sling.api.request.RequestPathInfo;
	import org.apache.sling.api.resource.Resource;
	import org.apache.sling.api.resource.ResourceResolver;

	public class ResourceUriBuilder {

	static final String CHAR_HASH = "#";
	static final String CHAR_QM = "?";
	static final String CHAR_DOT = ".";
	static final String CHAR_SLASH = "/";
	static final String CHAR_AT = "@";
	static final String SELECTOR_DOT_REGEX = "\\.(?!\\.?/)"; // (?!\\.?/) to avoid matching ./ and ../
	static final String CHAR_COLON = ":";
	static final String CHAR_SEMICOLON = ";";
	static final String CHAR_EQUALS = "=";
	static final String CHAR_SINGLEQUOTE = "'";

	public static ResourceUriBuilder create() {
	return new ResourceUriBuilder();
	}

	/** Creates a builder from another ResourceUri.
	*
	* @param resourceUri
	* @return a ResourceUriBuilder */
	public static ResourceUriBuilder createFrom(ResourceUri resourceUri) {
	return create()
	.setScheme(resourceUri.getScheme())
	.setUserInfo(resourceUri.getUserInfo())
	.setHost(resourceUri.getHost())
	.setPort(resourceUri.getPort())
	.setResourcePath(resourceUri.getResourcePath())
	.setPathParameters(resourceUri.getPathParameters())
	.setSelectors(resourceUri.getSelectors())
	.setExtension(resourceUri.getExtension())
	.setSuffix(resourceUri.getSuffix())
	.setQuery(resourceUri.getQuery())
	.setFragment(resourceUri.getFragment())
	.setSchemeSpecificPart(resourceUri.getSchemeSpecificPart())
	.setResourceResolver(resourceUri instanceof ImmutableResourceUri
	? ((ImmutableResourceUri) resourceUri).getBuilder().resourceResolver
	: null);
	}

	/** Creates a builder from a Resource (only taking the resource path into account).
	*
	* @param resource
	* @return a ResourceUriBuilder */
	public static ResourceUriBuilder createFrom(Resource resource) {
	return create()
	.setResourcePath(resource.getPath())
	.setResourceResolver(resource.getResourceResolver());
	}

	/** Creates a builder from a RequestPathInfo instance .
	*
	* @param requestPathInfo
	* @return a ResourceUriBuilder */
	public static ResourceUriBuilder createFrom(RequestPathInfo requestPathInfo) {
	return create()
	.setResourcePath(requestPathInfo.getResourcePath())
	.setSelectors(requestPathInfo.getSelectors())
	.setExtension(requestPathInfo.getExtension())
	.setSuffix(requestPathInfo.getSuffix());
	}

	/** Creates a builder from a request.
	*
	* @param request
	* @return a ResourceUriBuilder */
	public static ResourceUriBuilder createFrom(SlingHttpServletRequest request) {
	return createFrom(request.getRequestPathInfo())
	.setResourceResolver(request.getResourceResolver())
	.setScheme(request.getScheme())
	.setHost(request.getServerName())
	.setPort(request.getServerPort());
	}

	/** Creates a builder from a URI.
	*
	* @param uri
	* @return a ResourceUriBuilder */
	public static ResourceUriBuilder createFrom(URI uri, ResourceResolver resourceResolver) {
	String path = uri.getPath();
	boolean pathExists = !StringUtils.isBlank(path);
	boolean schemeSpecificRelevant = !pathExists && uri.getQuery() == null;
	return create()
	.setResourceResolver(resourceResolver)
	.setScheme(uri.getScheme())
	.setUserInfo(uri.getUserInfo())
	.setHost(uri.getHost())
	.setPort(uri.getPort())
	.setPath(pathExists ? path : null)
	.setQuery(uri.getQuery())
	.setFragment(uri.getFragment())
	.setSchemeSpecificPart(schemeSpecificRelevant ? uri.getSchemeSpecificPart() : null);
	}

	/** Creates a builder from an arbitrary URI string.
	*
	* @param resourceUriStr
	* @return a ResourceUriBuilder */
	public static ResourceUriBuilder parse(String resourceUriStr, ResourceResolver resourceResolver) {
	URI uri;
	try {
	uri = new URI(resourceUriStr);
	return createFrom(uri, resourceResolver);
	} catch (URISyntaxException e) {
	throw new IllegalArgumentException("Invalid URI " + resourceUriStr + ": " + e.getMessage(), e);
	}
	}

	/** Creates a builder from a resource path.
	*
	* @param resourcePathStr
	* @return a ResourceUriBuilder */
	public static ResourceUriBuilder forPath(String resourcePathStr) {
	return new ResourceUriBuilder().setPath(resourcePathStr);
	}

	private String scheme = null;

	private String userInfo = null;
	private String host = null;
	private int port = -1;

	private String resourcePath = null;
	private final List<String> selectors = new LinkedList<>();
	private String extension = null;
	private final Map<String, String> pathParameters = new LinkedHashMap<>();
	private String suffix = null;
	private String schemeSpecificPart = null;
	private String query = null;
	private String fragment = null;

	// only needed for getSuffixResource() from interface RequestPathInfo
	private ResourceResolver resourceResolver = null;

	private ResourceUriBuilder() {
	}

	/** @param userInfo
	* @return the builder for method chaining */
	public ResourceUriBuilder setUserInfo(String userInfo) {
	if (schemeSpecificPart != null) {
	return this;
	}
	this.userInfo = userInfo;
	return this;
	}

	/** @param host
	* @return the builder for method chaining */
	public ResourceUriBuilder setHost(String host) {
	if (schemeSpecificPart != null) {
	return this;
	}
	this.host = host;
	return this;
	}

	/** @param port
	* @return the builder for method chaining */
	public ResourceUriBuilder setPort(int port) {
	if (schemeSpecificPart != null) {
	return this;
	}
	this.port = port;
	return this;
	}

	/** @param path
	* @return the builder for method chaining */
	public ResourceUriBuilder setPath(String path) {
	if (schemeSpecificPart != null) {
	return this;
	}

	// path parameters
	Map<String, String> currentPathParameters = null;
	if (path != null) {
	Pattern pathParameterRegex = Pattern.compile(";([a-zA-z0-9]+)=(?:\\'([^']*)\\'\|([^/]+))");

	StringBuffer resultString = null;
	Matcher regexMatcher = pathParameterRegex.matcher(path);
	while (regexMatcher.find()) {
	if (resultString == null) {
	resultString = new StringBuffer();
	}
	if (currentPathParameters == null) {
	currentPathParameters = new LinkedHashMap<>();
	}
	regexMatcher.appendReplacement(resultString, "");
	String key = regexMatcher.group(1);
	String value = StringUtils.defaultIfEmpty(regexMatcher.group(2), regexMatcher.group(3));
	currentPathParameters.put(key, value);
	}
	if (resultString != null) {
	regexMatcher.appendTail(resultString);
	path = resultString.toString();
	pathParameters.putAll(currentPathParameters);
	}
	}

	// regular RequestPathInfo
	Matcher dotMatcher;
	if (path != null && (dotMatcher = Pattern.compile(SELECTOR_DOT_REGEX).matcher(path)).find()) {
	int firstDotPosition = dotMatcher.start();
	int firstSlashAfterFirstDotPosition = path.indexOf(CHAR_SLASH, firstDotPosition);
	String pathWithoutSuffix = firstSlashAfterFirstDotPosition > -1 ? path.substring(0, firstSlashAfterFirstDotPosition) : path;
	String[] pathBits = pathWithoutSuffix.split(SELECTOR_DOT_REGEX);
	setResourcePath(pathBits[0]);
	if (pathBits.length > 2) {
	setSelectors(Arrays.copyOfRange(pathBits, 1, pathBits.length - 1));
	}
	setExtension(pathBits.length > 1 ? pathBits[pathBits.length - 1] : null);
	setSuffix(firstSlashAfterFirstDotPosition > -1 ? path.substring(firstSlashAfterFirstDotPosition) : null);
	} else {
	setResourcePath(path);
	}

	if (resourceResolver != null) {
	balanceResourcePath();
	}

	return this;
	}

	public ResourceUriBuilder balanceResourcePath() {
	if (schemeSpecificPart != null) {
	return this;
	}
	if (resourceResolver == null) {
	throw new IllegalStateException("setResourceResolver() needs to be called before balanceResourcePath()");
	}
	List<String> potentialResourcePathBits = new ArrayList<>();
	potentialResourcePathBits.add(resourcePath);
	potentialResourcePathBits.addAll(selectors);
	if (extension != null) {
	potentialResourcePathBits.add(extension);
	}
	String fullPathWithSuffix = String.join(".", potentialResourcePathBits) + suffix;
	if (resourceResolver.getResource(fullPathWithSuffix) != null) {
	this.resourcePath = fullPathWithSuffix;
	selectors.clear();
	extension = null;
	suffix = null;
	} else {
	for (int i = potentialResourcePathBits.size(); i > 1; i--) {
	String potentialResourcePath = String.join(".", potentialResourcePathBits.subList(0, i));
	if (resourceResolver.getResource(potentialResourcePath) != null) {
	this.resourcePath = potentialResourcePath;
	selectors.clear();
	extension = null;
	List<String> remainingList = potentialResourcePathBits.subList(i, potentialResourcePathBits.size());
	if (!remainingList.isEmpty()) {
	extension = remainingList.get(remainingList.size() - 1);
	selectors.addAll(remainingList.subList(0, remainingList.size() - 1));
	}
	break;
	}
	}
	}
	return this;
	}

	/** @param resourcePath
	* @return the builder for method chaining */
	public ResourceUriBuilder setResourcePath(String resourcePath) {
	if (schemeSpecificPart != null) {
	return this;
	}
	this.resourcePath = resourcePath;
	return this;
	}

	/** @param selectors
	* @return the builder for method chaining */
	public ResourceUriBuilder setSelectors(String[] selectors) {
	if (schemeSpecificPart != null \|\| resourcePath == null) {
	return this;
	}
	this.selectors.clear();
	Arrays.stream(selectors).forEach(this.selectors::add);
	return this;
	}

	/** @param selector
	* @return the builder for method chaining */
	public ResourceUriBuilder addSelector(String selector) {
	if (schemeSpecificPart != null \|\| resourcePath == null) {
	return this;
	}
	this.selectors.add(selector);
	return this;
	}

	/** @param extension
	* @return the builder for method chaining */
	public ResourceUriBuilder setExtension(String extension) {
	if (schemeSpecificPart != null \|\| resourcePath == null) {
	return this;
	}
	this.extension = extension;
	return this;
	}

	/** @return returns the path parameters */
	public ResourceUriBuilder setPathParameter(String key, String value) {
	if (schemeSpecificPart != null \|\| resourcePath == null) {
	return this;
	}
	this.pathParameters.put(key, value);
	return this;
	}

	public ResourceUriBuilder setPathParameters(Map<String, String> pathParameters) {
	this.pathParameters.clear();
	this.pathParameters.putAll(pathParameters);
	return this;
	}

	/** @param suffix
	* @return the builder for method chaining */
	public ResourceUriBuilder setSuffix(String suffix) {
	if (schemeSpecificPart != null \|\| resourcePath == null) {
	return this;
	}
	if (suffix != null && !StringUtils.startsWith(suffix, "/")) {
	throw new IllegalArgumentException("Suffix needs to start with slash");
	}
	this.suffix = suffix;
	return this;
	}

	/** @param query
	* @return the builder for method chaining */
	public ResourceUriBuilder setQuery(String query) {
	if (schemeSpecificPart != null) {
	return this;
	}
	this.query = query;
	return this;
	}

	/** @param urlFragment
	* @return the builder for method chaining */
	public ResourceUriBuilder setFragment(String urlFragment) {
	if (schemeSpecificPart != null) {
	return this;
	}
	this.fragment = urlFragment;
	return this;
	}

	/** @param scheme
	* @return the builder for method chaining */
	public ResourceUriBuilder setScheme(String scheme) {
	this.scheme = scheme;
	return this;
	}

	/** @param schemeSpecificPart
	* @return the builder for method chaining */
	public ResourceUriBuilder setSchemeSpecificPart(String schemeSpecificPart) {
	if (schemeSpecificPart != null && schemeSpecificPart.isEmpty()) {
	return this;
	}
	this.schemeSpecificPart = schemeSpecificPart;
	return this;
	}

	/** Will remove scheme and authority (that is user info, host and port).
	*
	* @return the builder for method chaining */
	public ResourceUriBuilder removeSchemeAndAuthority() {
	setScheme(null);
	setUserInfo(null);
	setHost(null);
	setPort(-1);
	return this;
	}

	/** Will take over scheme and authority (user info, host and port) from provided resourceUri.
	*
	* @param resourceUri
	* @return the builder for method chaining */
	public ResourceUriBuilder useSchemeAndAuthority(ResourceUri resourceUri) {
	setScheme(resourceUri.getScheme());
	setUserInfo(resourceUri.getUserInfo());
	setHost(resourceUri.getHost());
	setPort(resourceUri.getPort());
	return this;
	}

	// only to support getSuffixResource() from interface RequestPathInfo
	private ResourceUriBuilder setResourceResolver(ResourceResolver resourceResolver) {
	this.resourceResolver = resourceResolver;
	return this;
	}

	/** Will take over scheme and authority (user info, host and port) from provided uri.
	*
	* @param uri
	* @return the builder for method chaining */
	public ResourceUriBuilder useSchemeAndAuthority(URI uri) {
	useSchemeAndAuthority(createFrom(uri, resourceResolver).build());
	return this;
	}

	/** Builds the immutable ResourceUri from this builder.
	*
	* @return the builder for method chaining */
	public ResourceUri build() {
	return new ImmutableResourceUri();
	}

	/** @return string representation of builder */
	public String toString() {
	return build().toString();
	}

	// read-only view on the builder data (to avoid another copy of the data into a new object)
	private class ImmutableResourceUri implements ResourceUri {

	private static final String HTTPS_SCHEME = "https";
	private static final int HTTPS_DEFAULT_PORT = 443;
	private static final String HTTP_SCHEME = "http";
	private static final int HTTP_DEFAULT_PORT = 80;

	@Override
	public String getResourcePath() {
	return resourcePath;
	}

	// returns null in line with
	// https://sling.apache.org/apidocs/sling11/org/apache/sling/api/request/RequestPathInfo.html#getSelectorString--
	@Override
	public String getSelectorString() {
	return !selectors.isEmpty() ? String.join(CHAR_DOT, selectors) : null;
	}

	@Override
	public String[] getSelectors() {
	return selectors.toArray(new String[selectors.size()]);
	}

	@Override
	public String getExtension() {
	return extension;
	}

	@Override
	public Map<String, String> getPathParameters() {
	return pathParameters;
	}

	@Override
	public String getSuffix() {
	return suffix;
	}

	@Override
	public String getSchemeSpecificPart() {
	return schemeSpecificPart;
	}

	@Override
	public String getQuery() {
	return query;
	}

	@Override
	public String getFragment() {
	return fragment;
	}

	@Override
	public String getScheme() {
	return scheme;
	}

	@Override
	public String getHost() {
	return host;
	}

	@Override
	public int getPort() {
	return port;
	}

	@Override
	public Resource getSuffixResource() {
	if (StringUtils.isNotBlank(suffix) && resourceResolver != null) {
	return resourceResolver.resolve(suffix);
	} else {
	return null;
	}
	}

	@Override
	public String getUserInfo() {
	return userInfo;
	}

	@Override
	public String toString() {
	StringBuilder requestUri = new StringBuilder();

	if (StringUtils.isNotBlank(scheme)) {
	requestUri.append(scheme + CHAR_COLON);
	}
	if (isFullUri()) {
	requestUri.append(CHAR_SLASH + CHAR_SLASH);
	if (StringUtils.isNotBlank(userInfo)) {
	requestUri.append(userInfo + CHAR_AT);
	}
	requestUri.append(host);
	if (port > 0
	&& !(scheme.equals(HTTP_SCHEME) && port == HTTP_DEFAULT_PORT)
	&& !(scheme.equals(HTTPS_SCHEME) && port == HTTPS_DEFAULT_PORT)) {
	requestUri.append(CHAR_COLON + port);
	}
	}
	if (resourcePath != null) {
	requestUri.append(resourcePath);
	}
	if (!pathParameters.isEmpty()) {
	for (Map.Entry<String, String> pathParameter : pathParameters.entrySet()) {
	requestUri.append(CHAR_SEMICOLON + pathParameter.getKey() + CHAR_EQUALS +
	CHAR_SINGLEQUOTE + pathParameter.getValue() + CHAR_SINGLEQUOTE);
	}
	}

	if (!selectors.isEmpty()) {
	requestUri.append(CHAR_DOT + String.join(CHAR_DOT, selectors));
	}
	if (!StringUtils.isBlank(extension)) {
	requestUri.append(CHAR_DOT + extension);
	}

	if (!StringUtils.isBlank(suffix)) {
	requestUri.append(suffix);
	}
	if (schemeSpecificPart != null) {
	requestUri.append(schemeSpecificPart);
	}
	if (query != null) {
	requestUri.append(CHAR_QM + query);
	}
	if (fragment != null) {
	requestUri.append(CHAR_HASH + fragment);
	}
	return requestUri.toString();
	}

	@Override
	public URI toUri() {
	String uriString = toString();
	try {
	return new URI(uriString);
	} catch (URISyntaxException e) {
	throw new IllegalArgumentException("Invalid Sling URI: " + uriString, e);
	}
	}

	private ResourceUriBuilder getBuilder() {
	return ResourceUriBuilder.this;
	}

	}

	}