Module org.eclipse.persistence.dbws.builder

Package org.eclipse.persistence.tools.dbws

Interface DBWSPackager

All Known Implementing Classes:

EclipsePackager, GlassfishPackager, IDEPackager, JavasePackager, JBossPackager, JDevPackager, JSR109WebServicePackager, ProviderPackager, WarPackager, WeblogicPackager, WebSpherePackager, XRPackager

public interface DBWSPackager

This interface defines methods necessary for packaging generated artifacts for deployment to application servers, display in Java IDEs, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DBWSPackager.Archiver
static enum	DBWSPackager.ArchiveUse

Method Summary

Modifier and Type	Method	Description
SessionConfigs	buildSessionsXML(OutputStream dbwsSessionsStream, DBWSBuilder builder)
void	closeDeploymentDescriptorStream(OutputStream descriptorOutputStream)	Closes the provided OutputStream.
void	closeOrStream(OutputStream orStream)
void	closeOxStream(OutputStream oxStream)
void	closeProviderClassStream(OutputStream classProviderStream)
void	closeProviderListenerClassStream(OutputStream classProviderListenerStream)
void	closeProviderListenerSourceStream(OutputStream sourceProviderListenerStream)
void	closeProviderSourceStream(OutputStream sourceProviderStream)
void	closeSchemaStream(OutputStream schemaStream)
void	closeServiceStream(OutputStream serviceStream)
void	closeSessionsStream(OutputStream sessionsStream)
void	closeSWARefStream(OutputStream swarefStream)
void	closeWebXmlStream(OutputStream webXmlStream)
void	closeWSDLStream(OutputStream wsdlStream)
void	end()
String	getArchiveFilename()
String	getDeploymentDescriptorFileName()	Return the name of the deployment descriptor file - this will depend on the target application server.
OutputStream	getDeploymentDescriptorStream()	Return an OutputStream to the deployment descriptor.
String	getOrProjectPathPrefix()
OutputStream	getOrStream()
String	getOxProjectPathPrefix()
OutputStream	getOxStream()
String	getPackagerLabel()
OutputStream	getProviderClassStream()
OutputStream	getProviderListenerClassStream()
OutputStream	getProviderListenerSourceStream()
OutputStream	getProviderSourceStream()
OutputStream	getSchemaStream()
OutputStream	getServiceStream()
String	getSessionsFileName()
OutputStream	getSessionsStream(String sessionsFileName)
File	getStageDir()
OutputStream	getSWARefStream()
String	getUsage()
OutputStream	getWebXmlStream()
String	getWSDLPathPrefix()
OutputStream	getWSDLStream()
boolean	hasAttachments()
void	setAdditionalArgs(String[] additionalArgs)
void	setArchiveFilename(String archiveFilename)
void	setArchiveUse(DBWSPackager.ArchiveUse archiveUse)
void	setDBWSBuilder(DBWSBuilder builder)
void	setHasAttachments(boolean hasAttachments)
void	setSessionsFileName(String sessionsFileName)
void	setStageDir(File stageDir)
void	start()
void	writeDeploymentDescriptor(OutputStream descriptorOutputStream)	Write the deployment descriptor contents to the provided OutputStream.
void	writeProvider(OutputStream sourceProviderStream, OutputStream codeGenProviderStream, OutputStream sourceProviderListenerStream, OutputStream classProviderListenerStream, DBWSBuilder builder)
void	writeWebXml(OutputStream webXmlStream, DBWSBuilder dbwsBuilder)

Method Details

setDBWSBuilder

void setDBWSBuilder(DBWSBuilder builder)

setAdditionalArgs

void setAdditionalArgs(String[] additionalArgs)

getStageDir

File getStageDir()

setStageDir

void setStageDir(File stageDir)

getSessionsFileName

String getSessionsFileName()

setSessionsFileName

void setSessionsFileName(String sessionsFileName)

setHasAttachments

void setHasAttachments(boolean hasAttachments)

hasAttachments

boolean hasAttachments()

getPackagerLabel

String getPackagerLabel()

setArchiveFilename

void setArchiveFilename(String archiveFilename)

getArchiveFilename

String getArchiveFilename()

start

void start()

end

void end()

getSchemaStream

OutputStream getSchemaStream()
                      throws FileNotFoundException

Throws:

FileNotFoundException

closeSchemaStream

void closeSchemaStream(OutputStream schemaStream)

getSessionsStream

OutputStream getSessionsStream(String sessionsFileName)
                        throws FileNotFoundException

Throws:

FileNotFoundException

buildSessionsXML

SessionConfigs buildSessionsXML(OutputStream dbwsSessionsStream,
 DBWSBuilder builder)

closeSessionsStream

void closeSessionsStream(OutputStream sessionsStream)

getServiceStream

OutputStream getServiceStream()
                       throws FileNotFoundException

Throws:

FileNotFoundException

closeServiceStream

void closeServiceStream(OutputStream serviceStream)

getOrStream

OutputStream getOrStream()
                  throws FileNotFoundException

Throws:

FileNotFoundException

getOrProjectPathPrefix

String getOrProjectPathPrefix()

closeOrStream

void closeOrStream(OutputStream orStream)

getOxStream

OutputStream getOxStream()
                  throws FileNotFoundException

Throws:

FileNotFoundException

getOxProjectPathPrefix

String getOxProjectPathPrefix()

closeOxStream

void closeOxStream(OutputStream oxStream)

getWSDLStream

OutputStream getWSDLStream()
                    throws FileNotFoundException

Throws:

FileNotFoundException

getWSDLPathPrefix

String getWSDLPathPrefix()

closeWSDLStream

void closeWSDLStream(OutputStream wsdlStream)

getSWARefStream

OutputStream getSWARefStream()
                      throws FileNotFoundException

Throws:

FileNotFoundException

closeSWARefStream

void closeSWARefStream(OutputStream swarefStream)

getWebXmlStream

OutputStream getWebXmlStream()
                      throws FileNotFoundException

Throws:

FileNotFoundException

writeWebXml

void writeWebXml(OutputStream webXmlStream,
 DBWSBuilder dbwsBuilder)

closeWebXmlStream

void closeWebXmlStream(OutputStream webXmlStream)

getProviderSourceStream

OutputStream getProviderSourceStream()
                              throws FileNotFoundException

Throws:

FileNotFoundException

closeProviderSourceStream

void closeProviderSourceStream(OutputStream sourceProviderStream)

getProviderClassStream

OutputStream getProviderClassStream()
                             throws FileNotFoundException

Throws:

FileNotFoundException

closeProviderClassStream

void closeProviderClassStream(OutputStream classProviderStream)

getProviderListenerClassStream

OutputStream getProviderListenerClassStream()
                                     throws FileNotFoundException

Throws:

FileNotFoundException

closeProviderListenerClassStream

void closeProviderListenerClassStream(OutputStream classProviderListenerStream)

getProviderListenerSourceStream

OutputStream getProviderListenerSourceStream()
                                      throws FileNotFoundException

Throws:

FileNotFoundException

closeProviderListenerSourceStream

void closeProviderListenerSourceStream(OutputStream sourceProviderListenerStream)

writeProvider

void writeProvider(OutputStream sourceProviderStream,
 OutputStream codeGenProviderStream,
 OutputStream sourceProviderListenerStream,
 OutputStream classProviderListenerStream,
 DBWSBuilder builder)

writeDeploymentDescriptor

void writeDeploymentDescriptor(OutputStream descriptorOutputStream)

Write the deployment descriptor contents to the provided OutputStream.

getDeploymentDescriptorStream

OutputStream getDeploymentDescriptorStream()
                                    throws FileNotFoundException

Return an OutputStream to the deployment descriptor.

Throws:

FileNotFoundException

closeDeploymentDescriptorStream

void closeDeploymentDescriptorStream(OutputStream descriptorOutputStream)

Closes the provided OutputStream.

getDeploymentDescriptorFileName

String getDeploymentDescriptorFileName()

Return the name of the deployment descriptor file - this will depend on the target application server.

setArchiveUse

void setArchiveUse(DBWSPackager.ArchiveUse archiveUse)

getUsage

String getUsage()