org.jboss.virtual
Class VFSUtils

java.lang.Object
  org.jboss.virtual.VFSUtils

public class VFSUtils
extends Object

VFS Utilities

Version:

$Revision: 1.1 $

Author:

Adrian Brock

Field Summary

static String	VFS_LINK_NAME
static String	VFS_LINK_PREFIX
static String	VFS_LINK_TARGET

Constructor Summary

VFSUtils()

Method Summary

static void	addManifestLocations(VirtualFile file, List<VirtualFile> paths) Add manifest paths
static String	fixName(String name) Fix a name (removes any trailing slash)
static Manifest	getManifest(VFS archive) Get a manifest from a virtual file system, assuming the root of the VFS is the root of an archive
static Manifest	getManifest(VirtualFile archive) Get a manifest from a virtual file, assuming the virtual file is the root of an archive
static String	getName(URI uri)
static String	getPathsString(Collection<VirtualFile> paths) Get the paths string for a collection of virtual files
static boolean	isLink(String name) Does a vf name contain the VFS link prefix
static void	parseLinkProperties(InputStream is, List<LinkInfo> info, Properties props) Parse a properties link file
static Map<String,String>	parseURLQuery(String query) Take a URL.getQuery string and parse it into name=value pairs
static List<LinkInfo>	readLinkInfo(InputStream is, String name, Properties props) Read the link information from the stream based on the type as determined from the name suffix.
static Manifest	readManifest(VirtualFile manifest) Read the manifest from given manifest VirtualFile.
static URI	toURI(URL url) Deal with urls that may include spaces.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VFS_LINK_PREFIX

public static final String VFS_LINK_PREFIX

See Also:

Constant Field Values

VFS_LINK_NAME

public static final String VFS_LINK_NAME

See Also:

Constant Field Values

VFS_LINK_TARGET

public static final String VFS_LINK_TARGET

See Also:

Constant Field Values

Constructor Detail

VFSUtils

public VFSUtils()

Method Detail

getPathsString

public static String getPathsString(Collection<VirtualFile> paths)

Get the paths string for a collection of virtual files

Parameters:

paths - the paths

Returns:

the string

Throws:

IllegalArgumentException - for null paths

addManifestLocations

public static void addManifestLocations(VirtualFile file,
                                        List<VirtualFile> paths)
                                 throws IOException

Add manifest paths

Parameters:

file - the file

paths - the paths to add to

Throws:

IOException - if there is an error reading the manifest or the virtual file is closed

IllegalStateException - if the file has no parent

IllegalArgumentException - for a null file or paths

getManifest

public static Manifest getManifest(VirtualFile archive)
                            throws IOException

Get a manifest from a virtual file, assuming the virtual file is the root of an archive

Parameters:

archive - the root the archive

Returns:

the manifest or null if not found

Throws:

IOException - if there is an error reading the manifest or the virtual file is closed

IllegalArgumentException - for a null archive

readManifest

public static Manifest readManifest(VirtualFile manifest)
                             throws IOException

Read the manifest from given manifest VirtualFile.

Parameters:

manifest - the VF to read from

Returns:

JAR's manifest

Throws:

IOException - if problems while opening VF stream occur

getManifest

public static Manifest getManifest(VFS archive)
                            throws IOException

Get a manifest from a virtual file system, assuming the root of the VFS is the root of an archive

Parameters:

archive - the vfs

Returns:

the manifest or null if not found

Throws:

IOException - if there is an error reading the manifest

IllegalArgumentException - for a null archive

fixName

public static String fixName(String name)

Fix a name (removes any trailing slash)

Parameters:

name - the name to fix

Returns:

the fixed name

Throws:

IllegalArgumentException - for a null name

getName

public static String getName(URI uri)

Parameters:

uri -

Returns:

name from uri's path

parseURLQuery

public static Map<String,String> parseURLQuery(String query)

Take a URL.getQuery string and parse it into name=value pairs

Parameters:

query - Possibly empty/null url query string

Returns:

String[] for the name/value pairs in the query. May be empty but never null.

isLink

public static boolean isLink(String name)

Does a vf name contain the VFS link prefix

Parameters:

name - - the name portion of a virtual file

Returns:

true if the name starts with VFS_LINK_PREFIX, false otherwise

readLinkInfo

public static List<LinkInfo> readLinkInfo(InputStream is,
                                          String name,
                                          Properties props)
                                   throws IOException,
                                          URISyntaxException

Read the link information from the stream based on the type as determined from the name suffix.

Parameters:

is - - input stream to the link file contents

name - - the name of the virtual file representing the link

props - the propertes

Returns:

a list of the links read from the stream

Throws:

IOException - on failure to read/parse the stream

URISyntaxException - for an error parsing a URI

parseLinkProperties

public static void parseLinkProperties(InputStream is,
                                       List<LinkInfo> info,
                                       Properties props)
                                throws IOException,
                                       URISyntaxException

Parse a properties link file

Parameters:

is - - input stream to the link file contents

info - the link infos

props - the propertes

Throws:

IOException - on failure to read/parse the stream

URISyntaxException - for an error parsing a URI

toURI

public static URI toURI(URL url)
                 throws URISyntaxException

Deal with urls that may include spaces.

Parameters:

url - the url

Returns:

uri the uri

Throws:

URISyntaxException - for any error