Skip navigation links

org.eclipse.persistence.tools.dbws
Class XRPackager

java.lang.Object
org.eclipse.persistence.tools.dbws.XRPackager

All Implemented Interfaces:

DBWSPackager

Direct Known Subclasses:

ProviderPackager

public class XRPackager

extends java.lang.Object

implements DBWSPackager

PUBLIC: XRPackager implements the DBWSPackager interface. This packager is
responsible for generating the core X-R metadata files and is the root class from which all
all other packagers inherit.

By default, this packager does not use an archiver and writes out its files 'flat' to the stageDir:

 ${PACKAGER_ROOT}
    |   eclipselink-dbws.xml             -- fixed naming convention
    |   eclipselink-dbws-or.xml
    |   eclipselink-dbws-ox.xml
    |   eclipselink-dbws-schema.xsd
    |   eclipselink-dbws-sessions.xml    -- name can be overriden by <sessions-file> entry in eclipselink-dbws.xml
    |   swaref.xsd                       -- optional if attachements are enabled
 

Since:

EclipseLink 1.x

Author:

Mike Norman - michael.norman@oracle.com

Nested Class Summary

protected static class

XRPackager.NullOutputStream

Nested classes/interfaces inherited from interface org.eclipse.persistence.tools.dbws.DBWSPackager

DBWSPackager.Archiver, DBWSPackager.ArchiveUse

Field Summary

static XRPackager.NullOutputStream	__nullStream
protected java.lang.String[]	additionalArgs
protected DBWSPackager.Archiver	archiver
protected DBWSPackager.ArchiveUse	archiveUse
protected DBWSBuilder	builder
protected boolean	hasAttachments
protected java.lang.String	packagerLabel
protected java.lang.String	sessionsFileName
protected java.io.File	stageDir

Constructor Summary

	XRPackager()
protected	XRPackager(DBWSPackager.Archiver archiver, java.lang.String packagerLabel, DBWSPackager.ArchiveUse useJavaArchive)

Method Summary

DBWSPackager.Archiver	buildDefaultArchiver()
org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs	buildSessionsXML(java.io.OutputStream dbwsSessionsStream, DBWSBuilder builder)
void	closeOrStream(java.io.OutputStream orStream)
void	closeOxStream(java.io.OutputStream oxStream)
void	closeProviderClassStream(java.io.OutputStream classProviderStream)
void	closeProviderListenerClassStream(java.io.OutputStream classProviderListenerStream)
void	closeProviderListenerSourceStream(java.io.OutputStream sourceProviderListenerStream)
void	closeProviderSourceStream(java.io.OutputStream sourceProviderStream)
void	closeSchemaStream(java.io.OutputStream schemaStream)
void	closeServiceStream(java.io.OutputStream serviceStream)
void	closeSessionsStream(java.io.OutputStream sessionsStream)
protected void	closeStream(java.io.OutputStream outputStream)
void	closeSWARefStream(java.io.OutputStream swarefStream)
void	closeWebXmlStream(java.io.OutputStream webXmlStream)
void	closeWSDLStream(java.io.OutputStream wsdlStream)
void	end()
java.lang.String	getAdditionalUsage()
java.lang.String	getArchiveFilename()
DBWSPackager.Archiver	getArchiver()
java.lang.String	getArchiverLabel()
java.lang.String	getOrProjectPathPrefix()
java.io.OutputStream	getOrStream()
java.lang.String	getOxProjectPathPrefix()
java.io.OutputStream	getOxStream()
java.lang.String	getPackagerLabel()
java.io.OutputStream	getProviderClassStream()
java.io.OutputStream	getProviderListenerClassStream()
java.io.OutputStream	getProviderListenerSourceStream()
java.io.OutputStream	getProviderSourceStream()
java.io.OutputStream	getSchemaStream()
java.io.OutputStream	getServiceStream()
java.lang.String	getSessionsFileName()
java.io.OutputStream	getSessionsStream(java.lang.String sessionsFileName)
java.io.File	getStageDir()
java.io.OutputStream	getSWARefStream()
java.lang.String	getUsage()
java.io.OutputStream	getWebXmlStream()
java.lang.String	getWSDLPathPrefix()
java.io.OutputStream	getWSDLStream()
boolean	hasAttachments()
void	processAdditionalArgs()
void	processArchiveUse()
void	setAdditionalArgs(java.lang.String[] additionalArgs)
void	setArchiveFilename(java.lang.String archiveFilename)
void	setArchiver(DBWSPackager.Archiver archiver)
void	setArchiveUse(DBWSPackager.ArchiveUse packagerUse)
void	setDBWSBuilder(DBWSBuilder builder)
void	setHasAttachments(boolean hasAttachments)
void	setSessionsFileName(java.lang.String sessionsFileName)
void	setStageDir(java.io.File stageDir)
void	start()
void	writeProvider(java.io.OutputStream sourceProviderStream, java.io.OutputStream classProviderStream, java.io.OutputStream sourceProviderListenerStream, java.io.OutputStream classProviderListenerStream, DBWSBuilder builder)
void	writeWebXml(java.io.OutputStream webXmlStream, DBWSBuilder dbwsBuilder)

Methods inherited from class java.lang.Object

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

Field Detail

__nullStream

public static XRPackager.NullOutputStream __nullStream

builder

protected DBWSBuilder builder

additionalArgs

protected java.lang.String[] additionalArgs

stageDir

protected java.io.File stageDir

sessionsFileName

protected java.lang.String sessionsFileName

hasAttachments

protected boolean hasAttachments

archiver

protected DBWSPackager.Archiver archiver

packagerLabel

protected java.lang.String packagerLabel

archiveUse

protected DBWSPackager.ArchiveUse archiveUse

Constructor Detail

XRPackager

public XRPackager()

XRPackager

protected XRPackager(DBWSPackager.Archiver archiver,
                     java.lang.String packagerLabel,
                     DBWSPackager.ArchiveUse useJavaArchive)

Method Detail

setDBWSBuilder

public void setDBWSBuilder(DBWSBuilder builder)

Specified by:

setDBWSBuilder in interface DBWSPackager

setAdditionalArgs

public void setAdditionalArgs(java.lang.String[] additionalArgs)

Specified by:

setAdditionalArgs in interface DBWSPackager

processAdditionalArgs

public void processAdditionalArgs()

getStageDir

public java.io.File getStageDir()

Specified by:

getStageDir in interface DBWSPackager

setStageDir

public void setStageDir(java.io.File stageDir)

Specified by:

setStageDir in interface DBWSPackager

getSessionsFileName

public java.lang.String getSessionsFileName()

Specified by:

getSessionsFileName in interface DBWSPackager

setSessionsFileName

public void setSessionsFileName(java.lang.String sessionsFileName)

Specified by:

setSessionsFileName in interface DBWSPackager

hasAttachments

public boolean hasAttachments()

Specified by:

hasAttachments in interface DBWSPackager

setHasAttachments

public void setHasAttachments(boolean hasAttachments)

Specified by:

setHasAttachments in interface DBWSPackager

getArchiver

public DBWSPackager.Archiver getArchiver()

setArchiver

public void setArchiver(DBWSPackager.Archiver archiver)

setArchiveUse

public void setArchiveUse(DBWSPackager.ArchiveUse packagerUse)

Specified by:

setArchiveUse in interface DBWSPackager

processArchiveUse

public void processArchiveUse()

buildDefaultArchiver

public DBWSPackager.Archiver buildDefaultArchiver()

getArchiveFilename

public java.lang.String getArchiveFilename()

Specified by:

getArchiveFilename in interface DBWSPackager

setArchiveFilename

public void setArchiveFilename(java.lang.String archiveFilename)

Specified by:

setArchiveFilename in interface DBWSPackager

getPackagerLabel

public java.lang.String getPackagerLabel()

Specified by:

getPackagerLabel in interface DBWSPackager

getArchiverLabel

public java.lang.String getArchiverLabel()

getUsage

public java.lang.String getUsage()

Specified by:

getUsage in interface DBWSPackager

getAdditionalUsage

public java.lang.String getAdditionalUsage()

start

public void start()

Specified by:

start in interface DBWSPackager

getSchemaStream

public java.io.OutputStream getSchemaStream()
                                     throws java.io.FileNotFoundException

Specified by:

getSchemaStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

closeSchemaStream

public void closeSchemaStream(java.io.OutputStream schemaStream)

Specified by:

closeSchemaStream in interface DBWSPackager

getSessionsStream

public java.io.OutputStream getSessionsStream(java.lang.String sessionsFileName)
                                       throws java.io.FileNotFoundException

Specified by:

getSessionsStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

buildSessionsXML

public org.eclipse.persistence.internal.sessions.factories.model.SessionConfigs buildSessionsXML(java.io.OutputStream dbwsSessionsStream,
                                                                                                 DBWSBuilder builder)

Specified by:

buildSessionsXML in interface DBWSPackager

closeSessionsStream

public void closeSessionsStream(java.io.OutputStream sessionsStream)

Specified by:

closeSessionsStream in interface DBWSPackager

getServiceStream

public java.io.OutputStream getServiceStream()
                                      throws java.io.FileNotFoundException

Specified by:

getServiceStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

closeServiceStream

public void closeServiceStream(java.io.OutputStream serviceStream)

Specified by:

closeServiceStream in interface DBWSPackager

getOrStream

public java.io.OutputStream getOrStream()
                                 throws java.io.FileNotFoundException

Specified by:

getOrStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

getOrProjectPathPrefix

public java.lang.String getOrProjectPathPrefix()

Specified by:

getOrProjectPathPrefix in interface DBWSPackager

closeOrStream

public void closeOrStream(java.io.OutputStream orStream)

Specified by:

closeOrStream in interface DBWSPackager

getOxStream

public java.io.OutputStream getOxStream()
                                 throws java.io.FileNotFoundException

Specified by:

getOxStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

getOxProjectPathPrefix

public java.lang.String getOxProjectPathPrefix()

Specified by:

getOxProjectPathPrefix in interface DBWSPackager

closeOxStream

public void closeOxStream(java.io.OutputStream oxStream)

Specified by:

closeOxStream in interface DBWSPackager

getWSDLStream

public java.io.OutputStream getWSDLStream()
                                   throws java.io.FileNotFoundException

Specified by:

getWSDLStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

getWSDLPathPrefix

public java.lang.String getWSDLPathPrefix()

Specified by:

getWSDLPathPrefix in interface DBWSPackager

closeWSDLStream

public void closeWSDLStream(java.io.OutputStream wsdlStream)

Specified by:

closeWSDLStream in interface DBWSPackager

getSWARefStream

public java.io.OutputStream getSWARefStream()
                                     throws java.io.FileNotFoundException

Specified by:

getSWARefStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

closeSWARefStream

public void closeSWARefStream(java.io.OutputStream swarefStream)

Specified by:

closeSWARefStream in interface DBWSPackager

getWebXmlStream

public java.io.OutputStream getWebXmlStream()
                                     throws java.io.FileNotFoundException

Specified by:

getWebXmlStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

writeWebXml

public void writeWebXml(java.io.OutputStream webXmlStream,
                        DBWSBuilder dbwsBuilder)

Specified by:

writeWebXml in interface DBWSPackager

closeWebXmlStream

public void closeWebXmlStream(java.io.OutputStream webXmlStream)

Specified by:

closeWebXmlStream in interface DBWSPackager

getProviderSourceStream

public java.io.OutputStream getProviderSourceStream()
                                             throws java.io.FileNotFoundException

Specified by:

getProviderSourceStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

closeProviderSourceStream

public void closeProviderSourceStream(java.io.OutputStream sourceProviderStream)

Specified by:

closeProviderSourceStream in interface DBWSPackager

getProviderClassStream

public java.io.OutputStream getProviderClassStream()
                                            throws java.io.FileNotFoundException

Specified by:

getProviderClassStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

closeProviderClassStream

public void closeProviderClassStream(java.io.OutputStream classProviderStream)

Specified by:

closeProviderClassStream in interface DBWSPackager

getProviderListenerSourceStream

public java.io.OutputStream getProviderListenerSourceStream()
                                                     throws java.io.FileNotFoundException

Specified by:

getProviderListenerSourceStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

closeProviderListenerSourceStream

public void closeProviderListenerSourceStream(java.io.OutputStream sourceProviderListenerStream)

Specified by:

closeProviderListenerSourceStream in interface DBWSPackager

getProviderListenerClassStream

public java.io.OutputStream getProviderListenerClassStream()
                                                    throws java.io.FileNotFoundException

Specified by:

getProviderListenerClassStream in interface DBWSPackager

Throws:

java.io.FileNotFoundException

closeProviderListenerClassStream

public void closeProviderListenerClassStream(java.io.OutputStream classProviderListenerStream)

Specified by:

closeProviderListenerClassStream in interface DBWSPackager

writeProvider

public void writeProvider(java.io.OutputStream sourceProviderStream,
                          java.io.OutputStream classProviderStream,
                          java.io.OutputStream sourceProviderListenerStream,
                          java.io.OutputStream classProviderListenerStream,
                          DBWSBuilder builder)

Specified by:

writeProvider in interface DBWSPackager

closeStream

protected void closeStream(java.io.OutputStream outputStream)

end

public void end()

Specified by:

end in interface DBWSPackager

Skip navigation links