org.jboss.deployers.vfs.spi.structure
Interface VFSDeploymentContext

All Superinterfaces:
DeploymentContext, ManagedObjectAttachments, ManagedObjectsWithTransientAttachments, PredeterminedManagedObjectAttachments, Serializable
All Known Implementing Classes:
AbstractVFSDeploymentContext

public interface VFSDeploymentContext
extends DeploymentContext

VFSDeploymentContext.

Version:
$Revision: 1.1 $
Author:
Adrian Brock, Ales Justin

Method Summary
 void appendClassPath(List<org.jboss.virtual.VirtualFile> files)
          Add virtual files to the classpath
 void appendClassPath(org.jboss.virtual.VirtualFile... files)
          Append virtual files to the classpath
 void appendMetaDataLocation(org.jboss.virtual.VirtualFile... locations)
          Append metadata file locations.
 List<org.jboss.virtual.VirtualFile> getClassPath()
          Get the class path
 org.jboss.virtual.VirtualFile getFile(String name)
          Gets a file from this deployment
 org.jboss.virtual.VirtualFile getMetaDataFile(String name)
          Gets a metadata file
 List<org.jboss.virtual.VirtualFile> getMetaDataFiles(String name, String suffix)
          Gets metadata files for this deployment
 List<org.jboss.virtual.VirtualFile> getMetaDataFiles(org.jboss.virtual.VirtualFileFilter filter)
          Gets the metadata files for this deployment unit
 List<org.jboss.virtual.VirtualFile> getMetaDataLocations()
          Get the meta data locations
 VFSDeploymentResourceLoader getResourceLoader()
          Get a resource loader
 org.jboss.virtual.VirtualFile getRoot()
          Get the root file
 VFSDeploymentContext getTopLevel()
          Get the top level deployment context
 void prependClassPath(List<org.jboss.virtual.VirtualFile> files)
          Prepend virtual files to the classpath
 void prependClassPath(org.jboss.virtual.VirtualFile... files)
          Prepend virtual files to the classpath
 void prependMetaDataLocation(org.jboss.virtual.VirtualFile... locations)
          Prepend metadata file locations.
 void removeClassPath(org.jboss.virtual.VirtualFile... files)
          Remove classpath files.
 void removeMetaDataLocation(org.jboss.virtual.VirtualFile... locations)
          Remove metadata file locations.
 void setClassPath(List<org.jboss.virtual.VirtualFile> paths)
          Set the class path
 void setMetaDataLocations(List<org.jboss.virtual.VirtualFile> locations)
          Set the meta data locations
 void setMetaDataPath(List<String> paths)
          Set the meta data path relative to the root
 
Methods inherited from interface org.jboss.deployers.structure.spi.DeploymentContext
addChild, addComponent, addControllerContextName, cleanup, createClassLoader, deployed, getChildren, getClassLoader, getComparator, getComponents, getControllerContextName, getControllerContextNames, getDependencyInfo, getDeployment, getDeploymentUnit, getMetaData, getMutableMetaData, getMutableScope, getName, getParent, getProblem, getRelativeOrder, getRelativePath, getResourceClassLoader, getScope, getSimpleName, getState, isComponent, isDeployed, isTopLevel, removeChild, removeClassLoader, removeClassLoader, removeComponent, removeControllerContextName, setClassLoader, setComparator, setDeployment, setDeploymentUnit, setMutableScope, setParent, setProblem, setRelativeOrder, setRequiredStage, setScope, setState, visit
 
Methods inherited from interface org.jboss.deployers.spi.attachments.ManagedObjectsWithTransientAttachments
getTransientAttachments
 
Methods inherited from interface org.jboss.deployers.spi.attachments.ManagedObjectAttachments
getTransientManagedObjects
 
Methods inherited from interface org.jboss.deployers.spi.attachments.PredeterminedManagedObjectAttachments
getPredeterminedManagedObjects, setPredeterminedManagedObjects
 

Method Detail

getRoot

org.jboss.virtual.VirtualFile getRoot()
Get the root file

Returns:
the root

setMetaDataPath

void setMetaDataPath(List<String> paths)
Set the meta data path relative to the root

Parameters:
paths - the path

getMetaDataLocations

List<org.jboss.virtual.VirtualFile> getMetaDataLocations()
Get the meta data locations

Returns:
the meta data locations

setMetaDataLocations

void setMetaDataLocations(List<org.jboss.virtual.VirtualFile> locations)
Set the meta data locations

Parameters:
locations - the meta data location

getMetaDataFile

org.jboss.virtual.VirtualFile getMetaDataFile(String name)
Gets a metadata file

Parameters:
name - the name to exactly match
Returns:
the virtual file or null if not found
Throws:
IllegalArgumentException - for a null name

getMetaDataFiles

List<org.jboss.virtual.VirtualFile> getMetaDataFiles(String name,
                                                     String suffix)
Gets metadata files for this deployment

Parameters:
name - the name to exactly match
suffix - the suffix to partially match
Returns:
the virtual files that match
Throws:
IllegalArgumentException - if both the name and suffix are null

getMetaDataFiles

List<org.jboss.virtual.VirtualFile> getMetaDataFiles(org.jboss.virtual.VirtualFileFilter filter)
Gets the metadata files for this deployment unit

Parameters:
filter - the file filter
Returns:
the virtual files that match
Throws:
IllegalArgumentException - if both the name and suffix are null

prependMetaDataLocation

void prependMetaDataLocation(org.jboss.virtual.VirtualFile... locations)
Prepend metadata file locations.

Parameters:
locations - the locations

appendMetaDataLocation

void appendMetaDataLocation(org.jboss.virtual.VirtualFile... locations)
Append metadata file locations.

Parameters:
locations - the locations

removeMetaDataLocation

void removeMetaDataLocation(org.jboss.virtual.VirtualFile... locations)
Remove metadata file locations.

Parameters:
locations - the locations

getFile

org.jboss.virtual.VirtualFile getFile(String name)
Gets a file from this deployment

Parameters:
name - the name to exactly match
Returns:
the file or null if not found
Throws:
IllegalArgumentException - if both the name

getClassPath

List<org.jboss.virtual.VirtualFile> getClassPath()
Get the class path

Returns:
the class path

setClassPath

void setClassPath(List<org.jboss.virtual.VirtualFile> paths)
Set the class path

Parameters:
paths - the paths

prependClassPath

void prependClassPath(org.jboss.virtual.VirtualFile... files)
Prepend virtual files to the classpath

Parameters:
files - a virtual file

prependClassPath

void prependClassPath(List<org.jboss.virtual.VirtualFile> files)
Prepend virtual files to the classpath

Parameters:
files - a virtual file

appendClassPath

void appendClassPath(org.jboss.virtual.VirtualFile... files)
Append virtual files to the classpath

Parameters:
files - a virtual file

appendClassPath

void appendClassPath(List<org.jboss.virtual.VirtualFile> files)
Add virtual files to the classpath

Parameters:
files - a virtual file

removeClassPath

void removeClassPath(org.jboss.virtual.VirtualFile... files)
Remove classpath files.

Parameters:
files - the files

getTopLevel

VFSDeploymentContext getTopLevel()
Get the top level deployment context

Specified by:
getTopLevel in interface DeploymentContext
Returns:
the top level deployment context

getResourceLoader

VFSDeploymentResourceLoader getResourceLoader()
Get a resource loader

Specified by:
getResourceLoader in interface DeploymentContext
Returns:
the resource loader


Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.