weblogic.wsee.tools.anttasks

Class JwsModule

java.lang.Object

weblogic.wsee.tools.anttasks.JwsModule

Direct Known Subclasses:

MultipleJwsModule, SingleJwsModule

public abstract class JwsModule
extends java.lang.Object

This class represents a JwsModule that can be built. NOTE: this class is only public to allow Ant to introspect it.

Excluded in public API Reference.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JwsModule.Descriptor

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.List<weblogic.wsee.tools.jws.build.Jws>	callbackJwsFiles
private org.apache.tools.ant.types.ZipFileSet	catalogFS
private java.util.List<ClientGenFacadeTask>	clients
private weblogic.wsee.tools.jws.build.JwsCompiler	compiler
private weblogic.wsee.tools.jws.context.JwsBuildContext	ctx
private java.lang.String	defaultContextPath
private java.util.List<JwsModule.Descriptor>	descriptors
private boolean	explode
private java.util.List<org.apache.tools.ant.types.FileSet>	fileSets
private java.lang.String	name
private JwscTask	owningTask
private TempDirManager	tempDirs

Constructor Summary

Constructors

Constructor and Description
JwsModule(JwscTask owningTask, weblogic.wsee.tools.jws.context.JwsBuildContext ctx)

Method Summary

Modifier and Type	Method and Description
void	addFileSet(org.apache.tools.ant.types.FileSet fileSet)
private void	addToEar(EarFile earFile, java.lang.String moduleName)
void	addZipFileSet(org.apache.tools.ant.types.ZipFileSet fileSet)
(package private) void	build(EarFile earFile)
private weblogic.wsee.tools.jws.decl.WebServiceDecl	buildAndValidate(weblogic.wsee.tools.jws.build.Jws jws, java.lang.String defaultContextPath)
private void	cleanup()
private void	compile()
private void	copy(org.apache.tools.ant.types.ZipFileSet zipFileSet, java.io.File outputDir)
private void	copyWsdl(java.io.File dir)
ClientGenFacadeTask	createClientGen()
JwsModule.Descriptor	createDescriptor()
private void	doPackage(EarFile earFile)
private boolean	generate(EarFile earFile)
private java.util.List<weblogic.wsee.tools.jws.build.Jws>	generateClients()
(package private) weblogic.wsee.tools.jws.context.JwsBuildContext	getBuildContext()
private java.lang.String	getCallbackContextPath() The callback context path is the context path for the first port in the first web service.
(package private) java.lang.String	getFileName() Return the file name to use for this module.
(package private) java.util.List<org.apache.tools.ant.types.FileSet>	getFileSets()
(package private) abstract java.util.Collection<weblogic.wsee.tools.jws.build.Jws>	getJwsFiles()
(package private) java.lang.String	getName()
(package private) java.io.File	getOutputDir()
(package private) org.apache.tools.ant.types.Path	getSourcepath() Return the sourcepath for this module.
(package private) JwscTask	getTask()
(package private) java.util.List<weblogic.wsee.tools.jws.decl.WebServiceDecl>	getWebServices()
private void	initialize()
(package private) boolean	isEjb()
abstract boolean	isEjbWsInWar()
(package private) boolean	isExplode()
(package private) boolean	isGenerateDescriptors()
(package private) boolean	isGenerateWsdl()
(package private) boolean	isWsdlOnly()
private void	loadWebServices(java.util.Collection<weblogic.wsee.tools.jws.build.Jws> jwsFiles, java.lang.String defaultContextPath)
private void	log(weblogic.wsee.tools.logging.EventLevel level, java.lang.String message)
(package private) abstract void	reset() Reset the module after execution.
void	resetContextwithNewClasspath()
void	setContextPath(java.lang.String contextPath)
private void	setDefaultSrcDirOnJwses(java.util.Collection<weblogic.wsee.tools.jws.build.Jws> jwsList)
void	setExplode(boolean explode)
void	setGenerateDescriptors(boolean generateDescriptors)
void	setGenerateWsdl(boolean generateWsdl)
void	setName(java.lang.String name)
void	setTypeSystemName(java.lang.String typeSystemName)
void	setWsdlOnly(boolean wsdlOnly)
private void	validate()
private void	validateFileSets()
(package private) abstract void	validateImpl()
(package private) abstract void	validateModuleType()
private void	validateOptions()

Methods inherited from class java.lang.Object

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

Field Detail

owningTask

private final JwscTask owningTask

ctx

private weblogic.wsee.tools.jws.context.JwsBuildContext ctx

compiler

private weblogic.wsee.tools.jws.build.JwsCompiler compiler

name

private java.lang.String name

defaultContextPath

private java.lang.String defaultContextPath

explode

private boolean explode

fileSets

private java.util.List<org.apache.tools.ant.types.FileSet> fileSets

callbackJwsFiles

java.util.List<weblogic.wsee.tools.jws.build.Jws> callbackJwsFiles

clients

private java.util.List<ClientGenFacadeTask> clients

descriptors

private java.util.List<JwsModule.Descriptor> descriptors

tempDirs

private final TempDirManager tempDirs

catalogFS

private org.apache.tools.ant.types.ZipFileSet catalogFS

Constructor Detail

JwsModule

JwsModule(JwscTask owningTask,
          weblogic.wsee.tools.jws.context.JwsBuildContext ctx)

Method Detail

resetContextwithNewClasspath

public void resetContextwithNewClasspath()

isEjbWsInWar

public abstract boolean isEjbWsInWar()

addFileSet

public void addFileSet(org.apache.tools.ant.types.FileSet fileSet)

addZipFileSet

public void addZipFileSet(org.apache.tools.ant.types.ZipFileSet fileSet)

getFileSets

java.util.List<org.apache.tools.ant.types.FileSet> getFileSets()

setName

public void setName(java.lang.String name)

getName

java.lang.String getName()

getFileName

java.lang.String getFileName()

Return the file name to use for this module. For exploded modules, this will be a directory name. For non-exploded modules (ie. archives), this will be the archive name.

Returns:

the module's file name

setContextPath

public void setContextPath(java.lang.String contextPath)

setExplode

public void setExplode(boolean explode)

isExplode

boolean isExplode()

setWsdlOnly

public void setWsdlOnly(boolean wsdlOnly)

setTypeSystemName

public void setTypeSystemName(java.lang.String typeSystemName)

isWsdlOnly

boolean isWsdlOnly()

setGenerateWsdl

public void setGenerateWsdl(boolean generateWsdl)

isGenerateWsdl

boolean isGenerateWsdl()

setGenerateDescriptors

public void setGenerateDescriptors(boolean generateDescriptors)

isGenerateDescriptors

boolean isGenerateDescriptors()

createClientGen

public ClientGenFacadeTask createClientGen()

createDescriptor

public JwsModule.Descriptor createDescriptor()

getJwsFiles

abstract java.util.Collection<weblogic.wsee.tools.jws.build.Jws> getJwsFiles()

getOutputDir

java.io.File getOutputDir()

getTask

JwscTask getTask()

isEjb

boolean isEjb()

getWebServices

java.util.List<weblogic.wsee.tools.jws.decl.WebServiceDecl> getWebServices()

getBuildContext

weblogic.wsee.tools.jws.context.JwsBuildContext getBuildContext()

getSourcepath

org.apache.tools.ant.types.Path getSourcepath()

Return the sourcepath for this module. This will be the concatenation of:

• the owning tasks source path
• any temporary directories created
• the output directory
• the directory for each file set

Returns:

the module's sourcepath

build

void build(EarFile earFile)
    throws java.io.IOException,
           WsBuildException

Throws:

java.io.IOException

WsBuildException

validate

private void validate()

validateFileSets

private void validateFileSets()

validateImpl

abstract void validateImpl()

validateModuleType

abstract void validateModuleType()

validateOptions

private void validateOptions()

initialize

private void initialize()
                 throws java.io.IOException

Throws:

java.io.IOException

cleanup

private void cleanup()

reset

abstract void reset()

Reset the module after execution.

generate

private boolean generate(EarFile earFile)
                  throws java.io.IOException,
                         WsBuildException

Throws:

java.io.IOException

WsBuildException

compile

private void compile()
              throws java.io.IOException

Throws:

java.io.IOException

doPackage

private void doPackage(EarFile earFile)
                throws WsBuildException,
                       java.io.IOException

Throws:

WsBuildException

java.io.IOException

copyWsdl

private void copyWsdl(java.io.File dir)

copy

private void copy(org.apache.tools.ant.types.ZipFileSet zipFileSet,
                  java.io.File outputDir)

addToEar

private void addToEar(EarFile earFile,
                      java.lang.String moduleName)
               throws java.io.IOException

Throws:

java.io.IOException

generateClients

private java.util.List<weblogic.wsee.tools.jws.build.Jws> generateClients()
                                                                   throws java.io.IOException

Throws:

java.io.IOException

getCallbackContextPath

private java.lang.String getCallbackContextPath()

The callback context path is the context path for the first port in the first web service. Since callbacks can only be used in web apps, all ports in all web services must be the same.

loadWebServices

private void loadWebServices(java.util.Collection<weblogic.wsee.tools.jws.build.Jws> jwsFiles,
                             java.lang.String defaultContextPath)
                      throws java.io.IOException,
                             WsBuildException

Throws:

java.io.IOException

WsBuildException

buildAndValidate

private weblogic.wsee.tools.jws.decl.WebServiceDecl buildAndValidate(weblogic.wsee.tools.jws.build.Jws jws,
                                                                     java.lang.String defaultContextPath)
                                                              throws WsBuildException

Throws:

WsBuildException

setDefaultSrcDirOnJwses

private void setDefaultSrcDirOnJwses(java.util.Collection<weblogic.wsee.tools.jws.build.Jws> jwsList)

log

private void log(weblogic.wsee.tools.logging.EventLevel level,
                 java.lang.String message)