org.jboss.jpa.javaee
Interface JavaEEModuleInformer


public interface JavaEEModuleInformer

Obtain information about a JavaEE module given a deployment unit. The informer should only use meta data to obtain the information being asked.

Version:
$Revision: $
Author:
Carlo de Wolf

Nested Class Summary
static class JavaEEModuleInformer.ModuleType
           
 
Method Summary
 String getApplicationName(org.jboss.deployers.structure.spi.DeploymentUnit deploymentUnit)
          Obtain the name of the JavaEE application this module is part of, for example 'foo.ear'.
 String getModulePath(org.jboss.deployers.structure.spi.DeploymentUnit deploymentUnit)
          Obtain the relative path of the deployment unit within the JavaEE application or base deployment directory.
 JavaEEModuleInformer.ModuleType getModuleType(org.jboss.deployers.structure.spi.DeploymentUnit deploymentUnit)
          Obtain the module type of the deployment unit.
 

Method Detail

getApplicationName

String getApplicationName(org.jboss.deployers.structure.spi.DeploymentUnit deploymentUnit)
Obtain the name of the JavaEE application this module is part of, for example 'foo.ear'. If the deployment unit is not part of a JavaEE application return null.

Parameters:
deployment - the deployment unit of the module, application or component
Returns:
the name of the JavaEE application or null if none

getModulePath

String getModulePath(org.jboss.deployers.structure.spi.DeploymentUnit deploymentUnit)
Obtain the relative path of the deployment unit within the JavaEE application or base deployment directory. The deployment unit is either a JavaEE module or a component of the JavaEE module. If the JavaEE module is part of a JavaEE application return the relative path within the JavaEE application otherwise it is considered a stand alone deployment and return the relative path within the base deployment directory. Note that the relative path includes the module name, for example 'lib/bar.jar'.

Parameters:
deployment - the deployment unit of the module or a component
Returns:
the relative path of the JavaEE module

getModuleType

JavaEEModuleInformer.ModuleType getModuleType(org.jboss.deployers.structure.spi.DeploymentUnit deploymentUnit)
Obtain the module type of the deployment unit. Based on the meta data available the informer will output the module type of the JavaEE module of which the deployment unit is part.

Parameters:
deploymentUnit - the deployment unit of the module or a component
Returns:
the JavaEE module type


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