|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DeploymentUnit
DeploymentUnit.
A deployment unit represents a single unit that deployers work with.
Method Summary | ||
---|---|---|
DeploymentUnit |
addComponent(String name)
Add a component |
|
void |
addControllerContextName(Object name)
Add controller context name. |
|
void |
addIDependOn(org.jboss.dependency.spi.DependencyItem dependency)
Add a dependency |
|
boolean |
createClassLoader(ClassLoaderFactory factory)
Create the classloader |
|
|
getAllMetaData(Class<T> type)
Get all the metadata for the expected type |
|
List<DeploymentUnit> |
getChildren()
Get the children |
|
ClassLoader |
getClassLoader()
Gets the classloader for this deployment unit |
|
DeploymentUnit |
getComponent(String name)
Get component. |
|
List<DeploymentUnit> |
getComponents()
Get the components |
|
Object |
getControllerContextName()
Get underlying controller context name. |
|
Set<Object> |
getControllerContextNames()
Get the controller context names. |
|
org.jboss.dependency.spi.DependencyInfo |
getDependencyInfo()
Get the dependency info |
|
MainDeployer |
getMainDeployer()
Get the main deployer |
|
org.jboss.metadata.spi.MetaData |
getMetaData()
Get the metadata for this deployment unit |
|
org.jboss.metadata.spi.MutableMetaData |
getMutableMetaData()
Get the mutable metadata for this deployment unit |
|
org.jboss.metadata.spi.scope.ScopeKey |
getMutableScope()
Get the mutable scope |
|
String |
getName()
Get the deployment units name |
|
DeploymentUnit |
getParent()
Get the parent deployment unit |
|
String |
getRelativePath()
Get the path of this deployment relative to the top of the deployment vfs path ------------------- relative path deploy/some.ear "" deploy/some.ear/x.ejb "/x.ejb" deploy/some.ear/y.sar "/y.sar" deploy/some.ear/y.sar/z.rar "/y.sar/z.rar" |
|
ClassLoader |
getResourceClassLoader()
Get a resource classloader |
|
DeploymentResourceLoader |
getResourceLoader()
Get a resource loader |
|
org.jboss.metadata.spi.scope.ScopeKey |
getScope()
Get the scope |
|
String |
getSimpleName()
Get the simple vfs name of the deployment unit. |
|
DeploymentUnit |
getTopLevel()
Get the top leve deployment unit |
|
MutableAttachments |
getTransientManagedObjects()
Get the transient managed objects |
|
boolean |
isComponent()
Whether this unit is a component |
|
boolean |
isTopLevel()
Whether this unit is a top level deployment |
|
void |
removeClassLoader(ClassLoaderFactory factory)
Remove the classloader |
|
boolean |
removeComponent(String name)
Remove a component |
|
void |
removeControllerContextName(Object name)
Remove controller context name. |
|
void |
removeIDependOn(org.jboss.dependency.spi.DependencyItem dependency)
Remove a dependency |
|
void |
setMutableScope(org.jboss.metadata.spi.scope.ScopeKey key)
Set the mutable scope |
|
void |
setRequiredStage(DeploymentStage stage)
Set the required stage. |
|
void |
setScope(org.jboss.metadata.spi.scope.ScopeKey key)
Set the scope |
|
void |
visit(DeploymentUnitVisitor visitor)
Visit the unit and the children |
Methods inherited from interface org.jboss.deployers.spi.attachments.MutableAttachments |
---|
addAttachment, addAttachment, addAttachment, clear, clearChangeCount, getChangeCount, removeAttachment, removeAttachment, removeAttachment, setAttachments |
Methods inherited from interface org.jboss.deployers.spi.attachments.Attachments |
---|
getAttachment, getAttachment, getAttachment, getAttachments, hasAttachments, isAttachmentPresent, isAttachmentPresent, isAttachmentPresent |
Method Detail |
---|
String getName()
String getSimpleName()
String getRelativePath()
org.jboss.metadata.spi.scope.ScopeKey getScope()
void setScope(org.jboss.metadata.spi.scope.ScopeKey key)
key
- the scope keyorg.jboss.metadata.spi.scope.ScopeKey getMutableScope()
void setMutableScope(org.jboss.metadata.spi.scope.ScopeKey key)
key
- the mutable scope keyorg.jboss.metadata.spi.MetaData getMetaData()
org.jboss.metadata.spi.MutableMetaData getMutableMetaData()
ClassLoader getClassLoader()
boolean createClassLoader(ClassLoaderFactory factory) throws DeploymentException
factory
- the classloader factory
IllegalArgumentException
- for a null factory
DeploymentException
- for any errorvoid removeClassLoader(ClassLoaderFactory factory)
factory
- the original factory used to create the classloader<T> Set<? extends T> getAllMetaData(Class<T> type)
T
- the type to gettype
- the type
IllegalArgumentException
- if the type is nullMutableAttachments getTransientManagedObjects()
boolean isTopLevel()
DeploymentUnit getTopLevel()
DeploymentUnit getParent()
List<DeploymentUnit> getChildren()
List<DeploymentUnit> getComponents()
boolean isComponent()
DeploymentUnit addComponent(String name)
name
- the name
IllegalArgumentException
- for a null nameDeploymentUnit getComponent(String name)
name
- the name
boolean removeComponent(String name)
name
- the name
IllegalArgumentException
- for a null nameDeploymentResourceLoader getResourceLoader()
ClassLoader getResourceClassLoader()
void visit(DeploymentUnitVisitor visitor) throws DeploymentException
visitor
- the visitor
DeploymentException
- for any error in the visitor
IllegalArgumentException
- for a null visitorMainDeployer getMainDeployer()
Object getControllerContextName()
void setRequiredStage(DeploymentStage stage)
stage
- the required stageorg.jboss.dependency.spi.DependencyInfo getDependencyInfo()
void addIDependOn(org.jboss.dependency.spi.DependencyItem dependency)
dependency
- the dependency to addvoid removeIDependOn(org.jboss.dependency.spi.DependencyItem dependency)
dependency
- the dependency to removeSet<Object> getControllerContextNames()
void addControllerContextName(Object name)
name
- the controller context namevoid removeControllerContextName(Object name)
name
- the controller context name
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |