Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.6.0)

E13403-07

oracle.jdeveloper.deploy.ear
Class EarProfile

java.lang.Object
  extended by oracle.javatools.data.HashStructureAdapter
      extended by oracle.jdeveloper.deploy.dt.DeployElement
          extended by oracle.jdeveloper.deploy.dt.Profile
              extended by oracle.jdeveloper.deploy.jar.ArchiveProfile
                  extended by oracle.jdeveloper.deploy.j2ee.J2eeProfile
                      extended by oracle.jdeveloper.deploy.ear.EarProfile
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 EarProfile
extends J2eeProfile

Class representing an EAR deployment profile.


Field Summary
 
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
EarProfile()
           
EarProfile(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 getDefaultLibraryFileGroupName()
           
 java.lang.String getDefaultLibraryFileGroupTargetWithinJar()
           
 java.lang.String getDescription()
           
 java.net.URL getJarURL()
          Returns the URL that will be added to the class path of a project that depends on this profile.
 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)
           
protected  void initTempEar(java.net.URL jarURL)
           
 boolean isApplicationLevel()
           
 boolean isClasspathJar()
          Returns true if the deployed output of this profile can be used as a JAR file on a classpath.
 void setDescription(java.lang.String description)
           
 void setJarURL(java.net.URL jarURL)
           
 
Methods inherited from class oracle.jdeveloper.deploy.j2ee.J2eeProfile
getDefaultConnection, getDeployClientMaxHeapSize, getDeployPlanUrl, getEarURL, getEnterpriseAppName, getPlatform, getProperties, getProperty, 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, getSelectedProjectFiles, newDefaultArchiveProfile, newDefaultArchiveProfile, newDefaultArchiveProfile, resolvesLibrary, selectLibraryForDeployment, setArchiveOptions, setFileGroups, showCustomSummary, showDeployJarAction, showJarSummary
 
Methods inherited from class oracle.jdeveloper.deploy.dt.Profile
addDependency, addDependency, addDependency, copyTo, copyToImpl, equalsImpl, getDataContainer, 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
 
Methods inherited from interface oracle.jdeveloper.deploy.common.Interdependency
addDependency, getDependencies, removeDependency
 
Methods inherited from interface oracle.javatools.util.Copyable
copyTo
 

Constructor Detail

EarProfile

public EarProfile()

EarProfile

public EarProfile(HashStructure hash)
Method Detail

initArchiveProfile

protected void initArchiveProfile(java.lang.Class<? extends DataContainer> profileContainerClass)
Overrides:
initArchiveProfile in class ArchiveProfile

initTempEar

protected void initTempEar(java.net.URL jarURL)
Overrides:
initTempEar in class J2eeProfile

getJarURL

public java.net.URL getJarURL()
                       throws TransientMarker
Description copied from interface: JarPackaging
Returns the URL that will be added to the class path of a project that depends on this profile.

Specified by:
getJarURL in interface JarPackaging
Overrides:
getJarURL in class ArchiveProfile
Throws:
TransientMarker

setJarURL

public void setJarURL(java.net.URL jarURL)
Overrides:
setJarURL 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

getDefaultLibraryFileGroupName

public java.lang.String getDefaultLibraryFileGroupName()
Overrides:
getDefaultLibraryFileGroupName in class Profile

getDefaultLibraryFileGroupTargetWithinJar

public java.lang.String getDefaultLibraryFileGroupTargetWithinJar()
Overrides:
getDefaultLibraryFileGroupTargetWithinJar in class Profile

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

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

isApplicationLevel

public boolean isApplicationLevel()

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

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.6.0)

E13403-07

Copyright © 1997, 2011, Oracle. All rights reserved.