Module org.eclipse.persistence.dbws.builder

Package 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 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	XRPackager.NullOutputStream

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

DBWSPackager.Archiver, DBWSPackager.ArchiveUse

Field Summary

Fields

Modifier and Type	Field	Description
static XRPackager.NullOutputStream	__nullStream
protected String[]	additionalArgs
protected static final String	ALL
protected DBWSPackager.Archiver	archiver
protected DBWSPackager.ArchiveUse	archiveUse
protected DBWSBuilder	builder
protected static final String	CONFIG
protected static final String	FINE
protected static final String	FINER
protected static final String	FINEST
protected boolean	hasAttachments
protected static final String	INFO
protected static final String	OFF
protected String	packagerLabel
protected String	sessionsFileName
protected static final String	SEVERE
protected File	stageDir
protected static final String	WARNING
protected static final String	XR_STR

Constructor Summary

Constructors

Modifier	Constructor	Description
	XRPackager()
protected	XRPackager(DBWSPackager.Archiver archiver, String packagerLabel, DBWSPackager.ArchiveUse useJavaArchive)

Method Summary

Modifier and Type	Method	Description
DBWSPackager.Archiver	buildDefaultArchiver()
SessionConfigs	buildSessionsXML(OutputStream dbwsSessionsStream, DBWSBuilder builder)
void	closeDeploymentDescriptorStream(OutputStream descriptorOutputStream)	Closes the given 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)
protected void	closeStream(OutputStream outputStream)
void	closeSWARefStream(OutputStream swarefStream)
void	closeWebXmlStream(OutputStream webXmlStream)
void	closeWSDLStream(OutputStream wsdlStream)
void	end()
String	getAdditionalUsage()
String	getArchiveFilename()
DBWSPackager.Archiver	getArchiver()
String	getArchiverLabel()
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	processAdditionalArgs()
void	processArchiveUse()
void	setAdditionalArgs(String[] additionalArgs)
void	setArchiveFilename(String archiveFilename)
void	setArchiver(DBWSPackager.Archiver archiver)
void	setArchiveUse(DBWSPackager.ArchiveUse packagerUse)
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 classProviderStream, OutputStream sourceProviderListenerStream, OutputStream classProviderListenerStream, DBWSBuilder builder)
void	writeWebXml(OutputStream webXmlStream, DBWSBuilder dbwsBuilder)

Methods inherited from class java.lang.Object

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

Field Details

__nullStream

public static XRPackager.NullOutputStream __nullStream

builder

protected DBWSBuilder builder

additionalArgs

protected String[] additionalArgs

stageDir

protected File stageDir

sessionsFileName

protected String sessionsFileName

hasAttachments

protected boolean hasAttachments

archiver

protected DBWSPackager.Archiver archiver

packagerLabel

protected String packagerLabel

archiveUse

protected DBWSPackager.ArchiveUse archiveUse

OFF

protected static final String OFF

See Also:

• Constant Field Values

SEVERE

protected static final String SEVERE

See Also:

• Constant Field Values

WARNING

protected static final String WARNING

See Also:

• Constant Field Values

INFO

protected static final String INFO

See Also:

• Constant Field Values

CONFIG

protected static final String CONFIG

See Also:

• Constant Field Values

FINE

protected static final String FINE

See Also:

• Constant Field Values

FINER

protected static final String FINER

See Also:

• Constant Field Values

FINEST

protected static final String FINEST

See Also:

• Constant Field Values

ALL

protected static final String ALL

See Also:

• Constant Field Values

XR_STR

protected static final String XR_STR

See Also:

• Constant Field Values

Constructor Details

XRPackager

public XRPackager()

XRPackager

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

Method Details

setDBWSBuilder

public void setDBWSBuilder(DBWSBuilder builder)

Specified by:

setDBWSBuilder in interface DBWSPackager

setAdditionalArgs

public void setAdditionalArgs(String[] additionalArgs)

Specified by:

setAdditionalArgs in interface DBWSPackager

processAdditionalArgs

public void processAdditionalArgs()

getStageDir

public File getStageDir()

Specified by:

getStageDir in interface DBWSPackager

setStageDir

public void setStageDir(File stageDir)

Specified by:

setStageDir in interface DBWSPackager

getSessionsFileName

public String getSessionsFileName()

Specified by:

getSessionsFileName in interface DBWSPackager

setSessionsFileName

public void setSessionsFileName(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 String getArchiveFilename()

Specified by:

getArchiveFilename in interface DBWSPackager

setArchiveFilename

public void setArchiveFilename(String archiveFilename)

Specified by:

setArchiveFilename in interface DBWSPackager

getPackagerLabel

public String getPackagerLabel()

Specified by:

getPackagerLabel in interface DBWSPackager

getArchiverLabel

public String getArchiverLabel()

getUsage

public String getUsage()

Specified by:

getUsage in interface DBWSPackager

getAdditionalUsage

public String getAdditionalUsage()

start

public void start()

Specified by:

start in interface DBWSPackager

getSchemaStream

public OutputStream getSchemaStream()
                             throws FileNotFoundException

Specified by:

getSchemaStream in interface DBWSPackager

Throws:

FileNotFoundException

closeSchemaStream

public void closeSchemaStream(OutputStream schemaStream)

Specified by:

closeSchemaStream in interface DBWSPackager

getSessionsStream

public OutputStream getSessionsStream(String sessionsFileName)
                               throws FileNotFoundException

Specified by:

getSessionsStream in interface DBWSPackager

Throws:

FileNotFoundException

buildSessionsXML

public SessionConfigs buildSessionsXML(OutputStream dbwsSessionsStream,
 DBWSBuilder builder)

Specified by:

buildSessionsXML in interface DBWSPackager

closeSessionsStream

public void closeSessionsStream(OutputStream sessionsStream)

Specified by:

closeSessionsStream in interface DBWSPackager

getServiceStream

public OutputStream getServiceStream()
                              throws FileNotFoundException

Specified by:

getServiceStream in interface DBWSPackager

Throws:

FileNotFoundException

closeServiceStream

public void closeServiceStream(OutputStream serviceStream)

Specified by:

closeServiceStream in interface DBWSPackager

getOrStream

public OutputStream getOrStream()
                         throws FileNotFoundException

Specified by:

getOrStream in interface DBWSPackager

Throws:

FileNotFoundException

getOrProjectPathPrefix

public String getOrProjectPathPrefix()

Specified by:

getOrProjectPathPrefix in interface DBWSPackager

closeOrStream

public void closeOrStream(OutputStream orStream)

Specified by:

closeOrStream in interface DBWSPackager

getOxStream

public OutputStream getOxStream()
                         throws FileNotFoundException

Specified by:

getOxStream in interface DBWSPackager

Throws:

FileNotFoundException

getOxProjectPathPrefix

public String getOxProjectPathPrefix()

Specified by:

getOxProjectPathPrefix in interface DBWSPackager

closeOxStream

public void closeOxStream(OutputStream oxStream)

Specified by:

closeOxStream in interface DBWSPackager

getWSDLStream

public OutputStream getWSDLStream()
                           throws FileNotFoundException

Specified by:

getWSDLStream in interface DBWSPackager

Throws:

FileNotFoundException

getWSDLPathPrefix

public String getWSDLPathPrefix()

Specified by:

getWSDLPathPrefix in interface DBWSPackager

closeWSDLStream

public void closeWSDLStream(OutputStream wsdlStream)

Specified by:

closeWSDLStream in interface DBWSPackager

getSWARefStream

public OutputStream getSWARefStream()
                             throws FileNotFoundException

Specified by:

getSWARefStream in interface DBWSPackager

Throws:

FileNotFoundException

closeSWARefStream

public void closeSWARefStream(OutputStream swarefStream)

Specified by:

closeSWARefStream in interface DBWSPackager

getWebXmlStream

public OutputStream getWebXmlStream()
                             throws FileNotFoundException

Specified by:

getWebXmlStream in interface DBWSPackager

Throws:

FileNotFoundException

writeWebXml

public void writeWebXml(OutputStream webXmlStream,
 DBWSBuilder dbwsBuilder)

Specified by:

writeWebXml in interface DBWSPackager

closeWebXmlStream

public void closeWebXmlStream(OutputStream webXmlStream)

Specified by:

closeWebXmlStream in interface DBWSPackager

getProviderSourceStream

public OutputStream getProviderSourceStream()
                                     throws FileNotFoundException

Specified by:

getProviderSourceStream in interface DBWSPackager

Throws:

FileNotFoundException

closeProviderSourceStream

public void closeProviderSourceStream(OutputStream sourceProviderStream)

Specified by:

closeProviderSourceStream in interface DBWSPackager

getProviderClassStream

public OutputStream getProviderClassStream()
                                    throws FileNotFoundException

Specified by:

getProviderClassStream in interface DBWSPackager

Throws:

FileNotFoundException

closeProviderClassStream

public void closeProviderClassStream(OutputStream classProviderStream)

Specified by:

closeProviderClassStream in interface DBWSPackager

getProviderListenerSourceStream

public OutputStream getProviderListenerSourceStream()
                                             throws FileNotFoundException

Specified by:

getProviderListenerSourceStream in interface DBWSPackager

Throws:

FileNotFoundException

closeProviderListenerSourceStream

public void closeProviderListenerSourceStream(OutputStream sourceProviderListenerStream)

Specified by:

closeProviderListenerSourceStream in interface DBWSPackager

getProviderListenerClassStream

public OutputStream getProviderListenerClassStream()
                                            throws FileNotFoundException

Specified by:

getProviderListenerClassStream in interface DBWSPackager

Throws:

FileNotFoundException

closeProviderListenerClassStream

public void closeProviderListenerClassStream(OutputStream classProviderListenerStream)

Specified by:

closeProviderListenerClassStream in interface DBWSPackager

writeProvider

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

Specified by:

writeProvider in interface DBWSPackager

closeStream

protected void closeStream(OutputStream outputStream)

end

public void end()

Specified by:

end in interface DBWSPackager

writeDeploymentDescriptor

public void writeDeploymentDescriptor(OutputStream descriptorOutputStream)

Write the deployment descriptor contents to the provided OutputStream.

Specified by:

writeDeploymentDescriptor in interface DBWSPackager

getDeploymentDescriptorStream

public OutputStream getDeploymentDescriptorStream()
                                           throws FileNotFoundException

Return an OutputStream to the deployment descriptor. Deployment descriptor is optional, so return a null stream.

Specified by:

getDeploymentDescriptorStream in interface DBWSPackager

Throws:

FileNotFoundException

closeDeploymentDescriptorStream

public void closeDeploymentDescriptorStream(OutputStream descriptorOutputStream)

Closes the given OutputStream.

Specified by:

closeDeploymentDescriptorStream in interface DBWSPackager

getDeploymentDescriptorFileName

public String getDeploymentDescriptorFileName()

Return the name of the deployment descriptor file - this will depend on the target application server. Since the deployment descriptor is optional, return null.

Specified by:

getDeploymentDescriptorFileName in interface DBWSPackager