org.apache.commons.vfs2.provider.URLFileName Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-vfs2 Show documentation
Show all versions of commons-vfs2 Show documentation
Apache Commons VFS is a Virtual File System library.
/*
* 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.commons.vfs2.provider;
import org.apache.commons.httpclient.URIException;
import org.apache.commons.httpclient.util.URIUtil;
import org.apache.commons.vfs2.FileName;
import org.apache.commons.vfs2.FileSystemException;
import org.apache.commons.vfs2.FileType;
/**
* A file name that represents URL.
*/
public class URLFileName extends GenericFileName {
private static final int BUFFER_SIZE = 250;
private final String queryString;
public URLFileName(final String scheme, final String hostName, final int port, final int defaultPort,
final String userName, final String password, final String path, final FileType type,
final String queryString) {
super(scheme, hostName, port, defaultPort, userName, password, path, type);
this.queryString = queryString;
}
/**
* Get the query string.
*
* @return the query string part of the filename
*/
public String getQueryString() {
return queryString;
}
/**
* Get the path and query string e.g. /path/servlet?param1=true.
*
* @return the path and its query string
*/
public String getPathQuery() {
final StringBuilder sb = new StringBuilder(BUFFER_SIZE);
sb.append(getPath());
sb.append("?");
sb.append(getQueryString());
return sb.toString();
}
/**
* Get the path encoded suitable for url like filesystem e.g. (http, webdav).
*
* @param charset the charset used for the path encoding
* @return The encoded path.
* @throws URIException If an error occurs encoding the URI.
* @throws FileSystemException If some other error occurs.
*/
public String getPathQueryEncoded(final String charset) throws URIException, FileSystemException {
if (getQueryString() == null) {
if (charset != null) {
return URIUtil.encodePath(getPathDecoded(), charset);
}
return URIUtil.encodePath(getPathDecoded());
}
final StringBuilder sb = new StringBuilder(BUFFER_SIZE);
if (charset != null) {
sb.append(URIUtil.encodePath(getPathDecoded(), charset));
} else {
sb.append(URIUtil.encodePath(getPathDecoded()));
}
sb.append("?");
sb.append(getQueryString());
return sb.toString();
}
/**
* Create a FileName.
*
* @param absPath The absolute path.
* @param type The FileType.
* @return The FileName
*/
@Override
public FileName createName(final String absPath, final FileType type) {
return new URLFileName(getScheme(), getHostName(), getPort(), getDefaultPort(), getUserName(), getPassword(),
absPath, type, getQueryString());
}
/**
* Append query string to the uri.
*
* @return the uri
*/
@Override
protected String createURI() {
if (getQueryString() != null) {
final StringBuilder sb = new StringBuilder(BUFFER_SIZE);
sb.append(super.createURI());
sb.append("?");
sb.append(getQueryString());
return sb.toString();
}
return super.createURI();
}
/**
* Encode a URI.
*
* @param charset The character set.
* @return The encoded URI
* @throws FileSystemException if some other exception occurs.
* @throws URIException if an exception occurs encoding the URI.
*/
public String getURIEncoded(final String charset) throws FileSystemException, URIException {
final StringBuilder sb = new StringBuilder(BUFFER_SIZE);
appendRootUri(sb, true);
sb.append(getPathQueryEncoded(charset));
return sb.toString();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy