oracle.jdeveloper.deploy.war
Class WarProfile

java.lang.Object
  oracle.javatools.data.HashStructureAdapter
      oracle.jdeveloper.deploy.dt.DeployElement
          oracle.jdeveloper.deploy.dt.Profile
              oracle.jdeveloper.deploy.jar.ArchiveProfile
                  oracle.jdeveloper.deploy.j2ee.J2eeProfile
                      oracle.jdeveloper.deploy.war.WarProfile

All Implemented Interfaces:

Displayable, Element, SubDirtyable, Subject, Dirtyable, Copyable, oracle.jdeveloper.deploy.common.ConnectionDefault, oracle.jdeveloper.deploy.common.Interdependency, Deployable, J2eePackaging, JarPackaging, LinkedDirtyable, PlatformDeployable, oracle.jdevimpl.deploy.JeeDeployable

public class WarProfile
extends J2eeProfile

Data model representing a deployment profile for a J2EE web module.

Field Summary

static java.lang.String

WEB_FILES_GROUP

Fields inherited from class oracle.jdeveloper.deploy.j2ee.J2eeProfile

ACTION_DEPLOY_PREBUILT_TO_REMOTE, ACTION_DEPLOY_TO_EAR_FILE, ACTION_DEPLOY_TO_MOST_RECENT, ACTION_DEPLOY_TO_NEW_CONNECTION, ACTION_REDEPLOY

Fields inherited from class oracle.jdeveloper.deploy.jar.ArchiveProfile

ACTION_DEPLOY_TO_JAR_FILE, ACTION_PREVIEW, ACTION_SETTINGS_DIALOG

Fields inherited from class oracle.jdeveloper.deploy.dt.Profile

_dataContainer, _dependableContainer, PROFILE_CLASS_NAME, PROFILE_DEPENDENCIES, PROFILE_NAME

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Fields inherited from interface oracle.jdeveloper.deploy.j2ee.J2eePackaging

CLIENT_MODULE, CONNECTOR_MODULE, EJB_MODULE, J2EE_APPLICATION, METADATA_MODULE, NONE, OAR_MODULE, SAR_MODULE, WEB_MODULE

Constructor Summary

WarProfile()

WarProfile(HashStructure hash)

Method Summary

boolean	canPackage(Element element) This indicates if a profile has the ability to package the element within it's own module.
boolean	equals(java.lang.Object o) Equals support.
java.lang.String	getAppletArchiveName()
oracle.jdeveloper.deploy.common.SelectedArchives	getAppletArchives()
oracle.jdeveloper.deploy.common.SelectedProjectFiles	getAppletFiles()
java.lang.String	getAppletLocation()
java.lang.String	getContextRoot()
java.lang.String	getContextRoot(boolean forceSlash)
int	getPackagingType() Returns one of the constants: J2EE_APPLICATION, EJB_MODULE, WEB_MODULE, or CLIENT_MODULE.
protected void	initArchiveProfile(java.lang.Class<? extends DataContainer> profileContainerClass)
boolean	isAppletDeployedAsArchive()
boolean	isAppletDeployment()
boolean	isClasspathJar() Returns true if the deployed output of this profile can be used as a JAR file on a classpath.
void	migrateLegacyLibrariesToFileGroup(Project project) This method migrates all LibraryFileGroup instances contained within the profile whose internal name is "legacy-libraries" to a LibraryFileGroup.
void	setAppletArchiveName(java.lang.String archiveName)
void	setAppletArchives(oracle.jdeveloper.deploy.common.SelectedArchives appletArchives)
void	setAppletDeployedAsArchive(boolean isDeployedAsArchive)
void	setAppletDeployment(boolean isAppletDeployment)
void	setAppletFiles(oracle.jdeveloper.deploy.common.SelectedProjectFiles appletFiles)
void	setAppletLocation(java.lang.String appletLocation)
void	setContextRoot(java.lang.String contextRoot)

Methods inherited from class oracle.jdeveloper.deploy.j2ee.J2eeProfile

getDefaultConnection, getDeployClientMaxHeapSize, getDeployPlanUrl, getEarURL, getEnterpriseAppName, getPlatform, getProperties, getProperty, initTempEar, initTransientProfile, isTransientProfile, putProperty, removeProperty, setDefaultConnection, setDeployClientMaxHeapSize, setDeployPlanUrl, setEarURL, setEnterpriseAppName, setPlatform, setProperties, setTransientProfile

Methods inherited from class oracle.jdeveloper.deploy.jar.ArchiveProfile

addFileGroup, findLibraryFileGroup, findLibraryFileGroups, findPackagingFileGroup, findProjectFileGroup, getArchiveOptions, getCustomSummary, getFileGroups, getJarURL, getSelectedProjectFiles, newDefaultArchiveProfile, newDefaultArchiveProfile, newDefaultArchiveProfile, resolvesLibrary, selectLibraryForDeployment, setArchiveOptions, setFileGroups, setJarURL, showCustomSummary, showDeployJarAction, showJarSummary

Methods inherited from class oracle.jdeveloper.deploy.dt.Profile

addDependency, addDependency, addDependency, copyTo, copyToImpl, equalsImpl, getDataContainer, getDefaultLibraryFileGroupName, getDefaultLibraryFileGroupTargetWithinJar, getDependencies, getHashStructure, getLibraryDependencies, getName, getParentProfileName, getProfileClass, getProfileNameFromRef, getShortLabel, getUnSelectedLibraryDependencies, isContainedProfile, migrate, removeDependency, removeDependency, resolveProfileDependencies, setContainedProfile, setDataContainer, setLibraryDependencies, setName, setProfileClass, setUnSelectedLibraryDependencies

Methods inherited from class oracle.jdeveloper.deploy.dt.DeployElement

attach, detach, getAttributes, getChildren, getData, getIcon, getLongLabel, getToolTipText, isDirty, linkContainingDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyable, linkEmbeddedDirtyables, markDirty, mayHaveChildren, notifyObservers, setOwner, toString, unlinkContainingDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyable, unlinkEmbeddedDirtyables

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyToImpl, equalsImpl, findOrCreate, forcedCopyTo, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jdeveloper.deploy.j2ee.J2eePackaging

setArchiveOptions

Methods inherited from interface oracle.jdeveloper.deploy.jar.JarPackaging

getArchiveOptions, getFileGroups, getJarURL

Methods inherited from interface oracle.jdeveloper.deploy.common.Interdependency

addDependency, getDependencies, removeDependency

Methods inherited from interface oracle.javatools.util.Copyable

copyTo

Field Detail

WEB_FILES_GROUP

public static final java.lang.String WEB_FILES_GROUP

See Also:

Constant Field Values

Constructor Detail

WarProfile

public WarProfile()

WarProfile

public WarProfile(HashStructure hash)

Method Detail

initArchiveProfile

protected void initArchiveProfile(java.lang.Class<? extends DataContainer> profileContainerClass)

Overrides:

initArchiveProfile in class ArchiveProfile

canPackage

public boolean canPackage(Element element)

This indicates if a profile has the ability to package the element within it's own module. For example, an EarProfile can package a WarProfile but a WarProfile cannot package another War Profile. This method will be overridden in the WarProfile and EarProfile at minimum. This method is used by the DependentLibrary resolvedBy criteria.

Overrides:

canPackage in class ArchiveProfile

getPackagingType

public final int getPackagingType()

Description copied from interface: J2eePackaging

Returns one of the constants: J2EE_APPLICATION, EJB_MODULE, WEB_MODULE, or CLIENT_MODULE.

Specified by:

getPackagingType in interface J2eePackaging

Overrides:

getPackagingType in class J2eeProfile

getContextRoot

public java.lang.String getContextRoot()

getContextRoot

public java.lang.String getContextRoot(boolean forceSlash)

setContextRoot

public void setContextRoot(java.lang.String contextRoot)

isAppletDeployment

public boolean isAppletDeployment()

setAppletDeployment

public void setAppletDeployment(boolean isAppletDeployment)

getAppletLocation

public java.lang.String getAppletLocation()

setAppletLocation

public void setAppletLocation(java.lang.String appletLocation)

isAppletDeployedAsArchive

public boolean isAppletDeployedAsArchive()

setAppletDeployedAsArchive

public void setAppletDeployedAsArchive(boolean isDeployedAsArchive)

getAppletArchiveName

public java.lang.String getAppletArchiveName()

setAppletArchiveName

public void setAppletArchiveName(java.lang.String archiveName)

getAppletFiles

public oracle.jdeveloper.deploy.common.SelectedProjectFiles getAppletFiles()

setAppletFiles

public void setAppletFiles(oracle.jdeveloper.deploy.common.SelectedProjectFiles appletFiles)

getAppletArchives

public oracle.jdeveloper.deploy.common.SelectedArchives getAppletArchives()

setAppletArchives

public void setAppletArchives(oracle.jdeveloper.deploy.common.SelectedArchives appletArchives)

isClasspathJar

public boolean isClasspathJar()

Description copied from class: ArchiveProfile

Returns true if the deployed output of this profile can be used as a JAR file on a classpath. Specialized JARs like WAR and EAR files are examples of JAR files that cannot be used directly on a classpath.

Overrides:

isClasspathJar in class ArchiveProfile

migrateLegacyLibrariesToFileGroup

public void migrateLegacyLibrariesToFileGroup(Project project)

This method migrates all LibraryFileGroup instances contained within the profile whose internal name is "legacy-libraries" to a LibraryFileGroup.

Because this migration can result in the loss of some profile properties, this migration is not performed automatically. Callers of this method have the responsibility of alerting the user of this migration step and giving the user a chance to cancel the operation.

equals

public boolean equals(java.lang.Object o)

Description copied from class: HashStructureAdapter

Equals support. As long as the subclass stores all data in the HashStructureAdapter._hash, this base equals implementation should be sufficient and not need to be overridden.

Overrides:

equals in class Profile