WebBundleDescriptor (Deployment Object Library 3.1.2.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.enterprise.deployment
Class WebBundleDescriptor

java.lang.Object
  java.util.Observable
      com.sun.enterprise.deployment.DynamicAttributesDescriptor
          com.sun.enterprise.deployment.Descriptor
              com.sun.enterprise.deployment.RootDeploymentDescriptor
                  com.sun.enterprise.deployment.BundleDescriptor
                      com.sun.enterprise.deployment.WebBundleDescriptor

All Implemented Interfaces:: JndiNameEnvironment, Roles, EjbReferenceContainer, MessageDestinationReferenceContainer, ResourceEnvReferenceContainer, ResourceReferenceContainer, ServiceReferenceContainer, WritableJndiNameEnvironment, java.io.Serializable

Direct Known Subclasses:: WebFragmentDescriptor

public class WebBundleDescriptor
extends BundleDescriptor
implements WritableJndiNameEnvironment, ResourceReferenceContainer, ResourceEnvReferenceContainer, EjbReferenceContainer, MessageDestinationReferenceContainer, ServiceReferenceContainer
extends BundleDescriptor
implements WritableJndiNameEnvironment, ResourceReferenceContainer, ResourceEnvReferenceContainer, EjbReferenceContainer, MessageDestinationReferenceContainer, ServiceReferenceContainer

I am an object that represents all the deployment information about a web app [{0}]lication.

Author:: Danny Coward
See Also:: Serialized Form

Field Summary
`static EventTypes<WebBundleDescriptor>`	`AFTER_SERVLET_CONTEXT_INITIALIZED_EVENT`
`protected boolean`	`conflictDataSourceDefinition`
`protected boolean`	`conflictEjbReference`
`protected boolean`	`conflictEntityManagerFactoryReference`
`protected boolean`	`conflictEntityManagerReference`
`protected boolean`	`conflictEnvironmentEntry`
`protected boolean`	`conflictJmsDestinationReference`
`protected boolean`	`conflictLoginConfig`
`protected boolean`	`conflictMessageDestinationReference`
`protected boolean`	`conflictResourceReference`
`protected boolean`	`conflictServiceReference`

Fields inherited from class com.sun.enterprise.deployment.RootDeploymentDescriptor
`classLoader, extensions, moduleDescriptor, moduleID`

Fields inherited from class com.sun.enterprise.deployment.Descriptor
`DESCRIPTION_CHANGED, DESCRIPTOR_CHANGED, docType, LARGE_ICON_CHANGED, NAME_CHANGED, SMALL_ICON_CHANGED`

Constructor Summary
`WebBundleDescriptor()` Constrct an empty web app [{0}].

Method Summary
`protected EjbReference`	`_getEjbReference(java.lang.String name)`
`protected EntityManagerFactoryReferenceDescriptor`	`_getEntityManagerFactoryReferenceByName(java.lang.String name)`
`protected EntityManagerReferenceDescriptor`	`_getEntityManagerReferenceByName(java.lang.String name)`
`protected EnvironmentProperty`	`_getEnvironmentPropertyByName(java.lang.String name)`
`protected JmsDestinationReferenceDescriptor`	`_getJmsDestinationReferenceByName(java.lang.String name)`
`protected MessageDestinationReferenceDescriptor`	`_getMessageDestinationReferenceByName(java.lang.String name)`
`protected ResourceReferenceDescriptor`	`_getResourceReferenceByName(java.lang.String name)`
`protected ServiceReferenceDescriptor`	`_getServiceReferenceByName(java.lang.String name)`
`void`	`addAppListenerDescriptor(AppListenerDescriptor ref)`
`void`	`addAppListenerDescriptor(AppListenerDescriptorImpl ref)`
`void`	`addContextParameter(ContextParameter contextParameter)` Adds a new context parameter to my list.
`void`	`addContextParameter(EnvironmentProperty contextParameter)` Adds a new context parameter to my list.
`void`	`addDataSourceDefinitionDescriptor(DataSourceDefinitionDescriptor reference)` Adds the specified data-source-definition to the receiver.
`void`	`addDefaultWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)`
`void`	`addEjbReferenceDescriptor(EjbReference ejbReference)` Adds a new reference to an ejb.
`void`	`addEjbReferenceDescriptor(EjbReferenceDescriptor ejbReferenceDescriptor)` Adds a new reference to an ejb.
`void`	`addEntityManagerFactoryReferenceDescriptor(EntityManagerFactoryReferenceDescriptor reference)`
`void`	`addEntityManagerReferenceDescriptor(EntityManagerReferenceDescriptor reference)`
`void`	`addEnvironmentEntry(EnvironmentEntry environmentEntry)` Adds this given environment property to my list.
`void`	`addEnvironmentProperty(EnvironmentProperty environmentProperty)` Adds this given environment property to my list.
`void`	`addErrorPageDescriptor(ErrorPageDescriptor errorPageDescriptor)` Adds a new error page to my list.
`void`	`addJmsDestinationReferenceDescriptor(JmsDestinationReferenceDescriptor jmsDestReference)` adds a JMS destination reference to the bundle
`void`	`addJndiNameEnvironment(JndiNameEnvironment env)`
`void`	`addLocaleEncodingMappingListDescriptor(LocaleEncodingMappingListDescriptor lemDesc)`
`void`	`addMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor messageDestRef)` Adds the specified message destination reference to the receiver.
`void`	`addMimeMapping(MimeMapping mimeMapping)`
`void`	`addMimeMapping(MimeMappingDescriptor mimeMapping)` add the given mime mapping to my list.
`void`	`addOrderedLib(java.lang.String libName)`
`void`	`addPostConstructDescriptor(LifecycleCallbackDescriptor postConstructDesc)` Adds the specified post-construct descriptor to the receiver.
`void`	`addPreDestroyDescriptor(LifecycleCallbackDescriptor preDestroyDesc)` Adds the specified pre-destroy descriptor to the receiver.
`void`	`addResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference)` adds a new reference to a resource.
`void`	`addSecurityConstraint(SecurityConstraint securityConstraint)` Add a new security constraint.
`void`	`addSecurityConstraint(SecurityConstraintImpl securityConstraint)` Add a new security constraint.
`void`	`addSecurityRole(SecurityRole securityRole)` Add a new abstrct role to me.
`void`	`addSecurityRole(SecurityRoleDescriptor securityRole)` Add a new abstrct role to me.
`void`	`addServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef)` Adds the specified service reference to the receiver.
`void`	`addServletFilter(ServletFilter ref)` Adds a servlet filter to this web component.
`void`	`addServletFilter(ServletFilterDescriptor ref)`
`void`	`addServletFilterMapping(ServletFilterMapping ref)` Adds a servlet filter mapping to this web component.
`void`	`addServletFilterMapping(ServletFilterMappingDescriptor ref)` Adds a servlet filter mapping to this web component.
`void`	`addWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)` This method will merge the contents of webComponents.
`void`	`addWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)` Adds a new Web Component Descriptor to me.
`void`	`addWelcomeFile(java.lang.String fileUri)` Adds a new welcome file to my list.
`protected void`	`combineDataSourceDefinitionDescriptors(JndiNameEnvironment env)`
`protected void`	`combineEjbReferenceDescriptors(JndiNameEnvironment env)`
`protected void`	`combineEntityManagerFactoryReferenceDescriptors(JndiNameEnvironment env)`
`protected void`	`combineEntityManagerReferenceDescriptors(JndiNameEnvironment env)`
`protected void`	`combineEnvironmentEntries(JndiNameEnvironment env)`
`protected void`	`combineJmsDestinationReferenceDescriptors(JndiNameEnvironment env)`
`protected void`	`combineLoginConfiguration(WebBundleDescriptor webBundleDescriptor)`
`protected void`	`combineMessageDestinationReferenceDescriptors(JndiNameEnvironment env)`
`protected void`	`combinePostConstructDescriptors(WebBundleDescriptor webBundleDescriptor)`
`protected void`	`combinePreDestroyDescriptors(WebBundleDescriptor webBundleDescriptor)`
`protected void`	`combineResourceReferenceDescriptors(JndiNameEnvironment env)`
`protected void`	`combineSecurityConstraints(java.util.Set<SecurityConstraint> firstScSet, java.util.Set<SecurityConstraint> secondScSet)`
`protected void`	`combineServiceReferenceDescriptors(JndiNameEnvironment env)`
`protected void`	`combineServletFilterMappings(WebBundleDescriptor webBundleDescriptor)`
`protected void`	`combineServletFilters(WebBundleDescriptor webBundleDescriptor)`
`protected WebComponentDescriptor`	`combineWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)` This method combines descriptor except urlPattern and add to current bundle descriptor if necessary.
`java.util.Collection<? extends PersistenceUnitDescriptor>`	`findReferencedPUs()` This method returns all the persistence units that are referenced by this module.
`AbsoluteOrderingDescriptor`	`getAbsoluteOrderingDescriptor()`
`java.util.Vector<AppListenerDescriptor>`	`getAppListenerDescriptors()`
`java.util.Enumeration<ContextParameter>`	`getContextParameters()`
`java.util.Set<ContextParameter>`	`getContextParametersSet()`
`java.lang.String`	`getContextRoot()` return the name of my context root
`protected DataSourceDefinitionDescriptor`	`getDataSourceDefinitionDescriptor(java.lang.String name)`
`java.util.Set<DataSourceDefinitionDescriptor>`	`getDataSourceDefinitionDescriptors()` Return a set of data-source-definition descriptors.
`java.lang.String`	`getDefaultSpecVersion()`
`java.lang.String`	`getDeploymentDescriptorDir()`
`EjbReference`	`getEjbReference(java.lang.String name)` Looks up an ejb reference with the given name.
`EjbReferenceDescriptor`	`getEjbReferenceByName(java.lang.String name)`
`java.util.Set<EjbReference>`	`getEjbReferenceDescriptors()` Returns the Set of my references to Enterprise Beans.
`java.util.Enumeration<EjbReference>`	`getEjbReferences()` Returns the enumeration of my references to Enterprise Beans.
`EntityManagerFactoryReferenceDescriptor`	`getEntityManagerFactoryReferenceByName(java.lang.String name)` Return the entity manager factory reference descriptor corresponding to the given name.
`java.util.Set<EntityManagerFactoryReferenceDescriptor>`	`getEntityManagerFactoryReferenceDescriptors()` Return a set of entity manager factory reference descriptors.
`EntityManagerReferenceDescriptor`	`getEntityManagerReferenceByName(java.lang.String name)` Return the entity manager factory reference descriptor corresponding to the given name.
`java.util.Set<EntityManagerReferenceDescriptor>`	`getEntityManagerReferenceDescriptors()` Return a set of entity manager reference descriptors.
`java.util.Enumeration<EnvironmentEntry>`	`getEnvironmentEntries()` Return my set of environment properties.
`java.util.Set<EnvironmentEntry>`	`getEnvironmentEntrySet()`
`java.util.Set<EnvironmentEntry>`	`getEnvironmentProperties()` Return my set of environment properties.
`EnvironmentProperty`	`getEnvironmentPropertyByName(java.lang.String name)` Returns the environment property object searching on the supplied key.
`ErrorPageDescriptor`	`getErrorPageDescriptorBySignifier(java.lang.String signifier)` Search my error pages for one with thei given signifier or null if there isn't one.
`java.util.Enumeration<ErrorPageDescriptor>`	`getErrorPageDescriptors()` Returns an enumeration of the error pages I have.
`java.util.List<InjectionCapable>`	`getInjectableResourcesByClass(java.lang.String className)`
`protected java.util.List<InjectionCapable>`	`getInjectableResourcesByClass(java.lang.String className, JndiNameEnvironment jndiNameEnv)` Define implementation of getInjectableResourceByClass here so it isn't replicated across appclient, web, ejb descriptors.
`InjectionInfo`	`getInjectionInfoByClass(java.lang.Class clazz)`
`java.util.Map<java.lang.String,java.lang.String>`	`getJarNameToWebFragmentNameMap()` This method return an unmodifiable version of jarName2WebFragNameMap.
`JmsDestinationReferenceDescriptor`	`getJmsDestinationReferenceByName(java.lang.String name)` Return the JMS destination reference descriptor corresponding to the given name.
`java.util.Set<JmsDestinationReferenceDescriptor>`	`getJmsDestinationReferenceDescriptors()` Return a set of JMS destination reference descriptors.
`JspConfigDescriptor`	`getJspConfigDescriptor()`
`java.util.Set<WebComponentDescriptor>`	`getJspDescriptors()`
`LocaleEncodingMappingListDescriptor`	`getLocaleEncodingMappingListDescriptor()`
`LoginConfiguration`	`getLoginConfiguration()` Return the information about how I should log in.
`MessageDestinationReferenceDescriptor`	`getMessageDestinationReferenceByName(java.lang.String name)` Looks up an message destination reference with the given name.
`java.util.Set<MessageDestinationReferenceDescriptor>`	`getMessageDestinationReferenceDescriptors()` Return a set of message destination reference descriptors.
`java.util.Enumeration<MimeMapping>`	`getMimeMappings()`
`XModuleType`	`getModuleType()`
`java.util.Collection`	`getNamedDescriptors()` Return the set of named descriptors that I have.
`java.util.Vector<NamedReferencePair>`	`getNamedReferencePairs()` Return the saet of NamedReferencePairs that I have.
`java.util.List<java.lang.String>`	`getOrderedLibs()`
`LifecycleCallbackDescriptor`	`getPostConstructDescriptorByClass(java.lang.String className)` Return the post-construct descriptor corresponding to the given name.
`java.util.Set<LifecycleCallbackDescriptor>`	`getPostConstructDescriptors()` Return a set of post-construct descriptors.
`LifecycleCallbackDescriptor`	`getPreDestroyDescriptorByClass(java.lang.String className)` Return the pre-destroy descriptor corresponding to the given name.
`java.util.Set<LifecycleCallbackDescriptor>`	`getPreDestroyDescriptors()` Return a set of pre-destroy descriptors.
`ResourceReferenceDescriptor`	`getResourceReferenceByName(java.lang.String name)` Looks up a reference to a resource by its name (getName()).
`java.util.Set<ResourceReferenceDescriptor>`	`getResourceReferenceDescriptors()` Return a set of resource reference descriptors.
`java.util.Enumeration<ResourceReferenceDescriptor>`	`getResourceReferences()` Return an enumeration of references to resources that I have.
`java.util.Enumeration<SecurityConstraint>`	`getSecurityConstraints()` My list of security constraints.
`java.util.Collection<SecurityConstraint>`	`getSecurityConstraintsForUrlPattern(java.lang.String urlPattern)`
`java.util.Set<SecurityConstraint>`	`getSecurityConstraintsSet()`
`SecurityRoleReference`	`getSecurityRoleReferenceByName(java.lang.String compName, java.lang.String roleName)` Return all the references by a given component (by name) to the given rolename.
`java.util.Enumeration<SecurityRoleDescriptor>`	`getSecurityRoles()` Returns an Enumeration of my SecurityRole objects.
`ServiceReferenceDescriptor`	`getServiceReferenceByName(java.lang.String name)` Looks up an service reference with the given name.
`java.util.Set<ServiceReferenceDescriptor>`	`getServiceReferenceDescriptors()` Return a set of service reference descriptors.
`java.util.Set<WebComponentDescriptor>`	`getServletDescriptors()`
`java.util.Vector`	`getServletFilterDescriptors()`
`java.util.Vector<ServletFilterMapping>`	`getServletFilterMappingDescriptors()` Return a Vector of servlet filter mappings that I have.
`java.util.Vector<ServletFilterMapping>`	`getServletFilterMappings()` Return a Vector of servlet filters that I have.
`java.util.Vector<ServletFilter>`	`getServletFilters()`
`SessionConfig`	`getSessionConfig()`
`SunWebApp`	`getSunDescriptor()` This returns the extra web sun specific info not in the RI DID.
`WebComponentDescriptor`	`getWebComponentByCanonicalName(java.lang.String name)` Search for a web component that I have by name.
`WebComponentDescriptor[]`	`getWebComponentByImplName(java.lang.String name)`
`WebComponentDescriptor`	`getWebComponentByName(java.lang.String name)` Search for a web component that I have by name.
`java.util.Set<WebComponentDescriptor>`	`getWebComponentDescriptors()` Return the Set of Web COmponent Descriptors (JSP or JavaServlets) in me.
`java.util.Enumeration<java.lang.String>`	`getWelcomeFiles()` Return an enumeration of the welcome files I have..
`java.util.Set<java.lang.String>`	`getWelcomeFilesSet()`
`boolean`	`hasExtensionProperty(java.lang.String key)` Determine if an extension property has been set.
`boolean`	`hasServiceReferenceDescriptors()` WEB SERVICES REF APIS
`boolean`	`hasWebServiceClients()`
`java.lang.Boolean`	`isDistributable()` Return true if this web app [{0}] can be distributed across different processes.
`boolean`	`isEmpty()` Return true if this root deployment descriptor does not describe anything
`void`	`moveAppListenerDescriptor(AppListenerDescriptor ref, int relPos)`
`void`	`moveServletFilterMapping(ServletFilterMapping ref, int relPos)` * Moves the given servlet filter mapping to a new relative location in * the list
`protected void`	`moveVectorItem(java.util.Vector list, java.lang.Object ref, int rpos)` Moves the given object to a new relative location in the specified list
`void`	`print(java.lang.StringBuffer toStringBuffer)` Return a formatted version as a String.
`void`	`printCommon(java.lang.StringBuffer toStringBuffer)`
`void`	`putJarNameWebFragmentNamePair(java.lang.String jarName, java.lang.String webFragName)`
`void`	`removeAppListenerDescriptor(AppListenerDescriptor ref)`
`void`	`removeContextParameter(ContextParameter contextParameter)` Removes the given context parameter from my list.
`void`	`removeDataSourceDefinitionDescriptor(DataSourceDefinitionDescriptor reference)` Removes the specified data-source-definition from the receiver.
`void`	`removeEjbReferenceDescriptor(EjbReference ejbReferenceDescriptor)` Removes the specificed ejb reference from the receiver.
`void`	`removeEjbReferenceDescriptor(EjbReferenceDescriptor ejbReferenceDescriptor)` Removes a reference to an ejb.
`void`	`removeEnvironmentEntry(EnvironmentEntry environmentEntry)` Removes this given environment property from my list.
`void`	`removeEnvironmentProperty(EnvironmentProperty environmentProperty)` Removes this given environment property from my list.
`void`	`removeErrorPageDescriptor(ErrorPageDescriptor errorPageDescriptor)` Removes the given error page from my list.
`void`	`removeJmsDestinationReferenceDescriptor(JmsDestinationReferenceDescriptor jmsDestReference)` removes a existing JMS destination reference from the bundle
`void`	`removeMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor msgDestRef)` Removes the specified message destination reference from the receiver.
`void`	`removeMimeMapping(MimeMapping mimeMapping)` Removes the given mime mapping from my list.
`void`	`removeResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference)` removes a reference to a resource.
`void`	`removeSecurityConstraint(SecurityConstraint securityConstraint)` Remove the given security constraint.
`void`	`removeServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef)` Removes the specified service reference from the receiver.
`void`	`removeServletFilter(ServletFilter ref)` Removes the given servlet filter from this web component.
`void`	`removeServletFilterMapping(ServletFilterMapping ref)` Removes the given servlet filter mapping from this web component.
`protected boolean`	`removeVectorItem(java.util.Vector<? extends java.lang.Object> list, java.lang.Object ref)` remove a specific object from the given list (does not rely on 'equals')
`void`	`removeWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)` Remove the given web component from me.
`void`	`removeWelcomeFile(java.lang.String fileUri)` Removes a welcome file from my list.
`void`	`setAbsoluteOrderingDescriptor(AbsoluteOrderingDescriptor absOrdering)`
`void`	`setAppListeners(java.util.Collection<? extends AppListenerDescriptor> c)`
`void`	`setContextRoot(java.lang.String contextRoot)` Set the name of my context root.
`void`	`setDistributable(java.lang.Boolean isDistributable)` Sets whether this web app [{0}] can be distributed across different processes.
`void`	`setExtensionProperty(java.lang.String key, java.lang.String value)` This property can be used to indicate special processing.
`void`	`setJspConfigDescriptor(JspConfigDescriptor jspC)`
`void`	`setLocaleEncodingMappingListDescriptor(LocaleEncodingMappingListDescriptor lemDesc)`
`void`	`setLoginConfiguration(LoginConfiguration loginConfiguration)` Specifies the information about how I should log in.
`void`	`setLoginConfiguration(LoginConfigurationImpl loginConfiguration)`
`void`	`setMimeMappings(java.util.Set<MimeMapping> mimeMappings)` Sets the Set of Mime Mappings for this web application.
`void`	`setSessionConfig(SessionConfig sessionConfig)`
`void`	`setSessionConfig(SessionConfigDescriptor sessionConfigDesc)` DeploymentDescriptorNode.addNodeDescriptor(node) need this.
`void`	`setSunDescriptor(SunWebApp webApp)` This sets the extra web sun specific info not in the RI DID.
`void`	`setWelcomeFiles(java.util.Set<java.lang.String> welcomeFiles)` Sets the collection of my welcome files.
`void`	`visit(DescriptorVisitor aVisitor)` visitor API implementation
`void`	`visit(WebBundleVisitor aVisitor)` visitor API implementation

Methods inherited from class com.sun.enterprise.deployment.BundleDescriptor
addEntityManagerFactory, addManagedBean, addMessageDestination, addRole, addRole, findDefaultPU, findReferencedPU, findReferencedPUsViaPCRefs, findReferencedPUsViaPURefs, findReferencedPUViaEMFRef, findReferencedPUViaEMRef, getApplication, getClassLoader, getCompatibility, getEntityManagerFactories, getEntityManagerFactory, getInjectableResources, getInjectionInfoByClass, getKeepState, getManagedBeanByBeanClass, getManagedBeans, getMessageDestinationByName, getMessageDestinations, getModuleID, getModuleName, getNamedDescriptorsFrom, getNamedReferencePairsFrom, getPostConstructDescriptorByClass, getPreDestroyDescriptorByClass, getRoles, getUniqueFriendlyId, getVisiblePUs, getWebServiceEndpointByName, getWebServices, getWsdlDir, hasManagedBeanByBeanClass, hasMessageDestinationByName, hasWebServices, isApplication, isPackagedAsSingleModule, isPolicyModified, isStandalone, removeMessageDestination, removeRole, setApplication, setCompatibility, setKeepState, setPolicyModified

Methods inherited from class com.sun.enterprise.deployment.BundleDescriptor

addEntityManagerFactory, addManagedBean, addMessageDestination, addRole, addRole, findDefaultPU, findReferencedPU, findReferencedPUsViaPCRefs, findReferencedPUsViaPURefs, findReferencedPUViaEMFRef, findReferencedPUViaEMRef, getApplication, getClassLoader, getCompatibility, getEntityManagerFactories, getEntityManagerFactory, getInjectableResources, getInjectionInfoByClass, getKeepState, getManagedBeanByBeanClass, getManagedBeans, getMessageDestinationByName, getMessageDestinations, getModuleID, getModuleName, getNamedDescriptorsFrom, getNamedReferencePairsFrom, getPostConstructDescriptorByClass, getPreDestroyDescriptorByClass, getRoles, getUniqueFriendlyId, getVisiblePUs, getWebServiceEndpointByName, getWebServices, getWsdlDir, hasManagedBeanByBeanClass, hasMessageDestinationByName, hasWebServices, isApplication, isPackagedAsSingleModule, isPolicyModified, isStandalone, removeMessageDestination, removeRole, setApplication, setCompatibility, setKeepState, setPolicyModified

Methods inherited from class com.sun.enterprise.deployment.RootDeploymentDescriptor
`addExtensionDescriptor, getDisplayName, getExtensionsDescriptors, getExtensionsDescriptors, getExtensionsDescriptors, getMainDescriptor, getModuleDescriptor, getName, getSchemaLocation, getSpecVersion, isDDWithNoAnnotationAllowed, isExtensionDescriptor, isFullAttribute, isFullFlag, setClassLoader, setDisplayName, setFullAttribute, setFullFlag, setModuleDescriptor, setModuleID, setName, setSchemaLocation, setSpecVersion`

Methods inherited from class com.sun.enterprise.deployment.RootDeploymentDescriptor

addExtensionDescriptor, getDisplayName, getExtensionsDescriptors, getExtensionsDescriptors, getExtensionsDescriptors, getMainDescriptor, getModuleDescriptor, getName, getSchemaLocation, getSpecVersion, isDDWithNoAnnotationAllowed, isExtensionDescriptor, isFullAttribute, isFullFlag, setClassLoader, setDisplayName, setFullAttribute, setFullFlag, setModuleDescriptor, setModuleID, setName, setSchemaLocation, setSpecVersion

Methods inherited from class com.sun.enterprise.deployment.Descriptor
addDeploymentExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, getDocType, getLargeIconUri, getLocalizedDescription, getLocalizedDescriptions, getLocalizedDisplayName, getLocalizedDisplayNames, getLocalizedLargeIconUri, getLocalizedLargeIconUris, getLocalizedSmallIconUri, getLocalizedSmallIconUris, getPrefixMapping, getSmallIconUri, isBoundsChecking, setBoundsChecking, setDescription, setLargeIconUri, setLocalizedDescription, setLocalizedDisplayName, setLocalizedLargeIconUri, setLocalizedSmallIconUri, setSmallIconUri

Methods inherited from class com.sun.enterprise.deployment.Descriptor

addDeploymentExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, getDocType, getLargeIconUri, getLocalizedDescription, getLocalizedDescriptions, getLocalizedDisplayName, getLocalizedDisplayNames, getLocalizedLargeIconUri, getLocalizedLargeIconUris, getLocalizedSmallIconUri, getLocalizedSmallIconUris, getPrefixMapping, getSmallIconUri, isBoundsChecking, setBoundsChecking, setDescription, setLargeIconUri, setLocalizedDescription, setLocalizedDisplayName, setLocalizedLargeIconUri, setLocalizedSmallIconUri, setSmallIconUri

Methods inherited from class com.sun.enterprise.deployment.DynamicAttributesDescriptor
`addExtraAttribute, getExtraAttribute, getExtraAttributes, removeExtraAttribute, toString`

Methods inherited from class java.util.Observable
`addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

AFTER_SERVLET_CONTEXT_INITIALIZED_EVENT

public static final EventTypes<WebBundleDescriptor> AFTER_SERVLET_CONTEXT_INITIALIZED_EVENT

conflictLoginConfig

protected boolean conflictLoginConfig

conflictDataSourceDefinition

protected boolean conflictDataSourceDefinition

conflictEnvironmentEntry

protected boolean conflictEnvironmentEntry

conflictEjbReference

protected boolean conflictEjbReference

conflictServiceReference

protected boolean conflictServiceReference

conflictResourceReference

protected boolean conflictResourceReference

conflictJmsDestinationReference

protected boolean conflictJmsDestinationReference

conflictMessageDestinationReference

protected boolean conflictMessageDestinationReference

conflictEntityManagerReference

protected boolean conflictEntityManagerReference

conflictEntityManagerFactoryReference

protected boolean conflictEntityManagerFactoryReference

Constructor Detail

WebBundleDescriptor

public WebBundleDescriptor()

Constrct an empty web app [{0}].

Method Detail

addWebBundleDescriptor

public void addWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)

This method will merge the contents of webComponents.

Parameters:: webBundleDescriptor -

addDefaultWebBundleDescriptor

public void addDefaultWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)

addJndiNameEnvironment

public void addJndiNameEnvironment(JndiNameEnvironment env)

isEmpty

public boolean isEmpty()

Description copied from class: RootDeploymentDescriptor

Return true if this root deployment descriptor does not describe anything

Specified by:: isEmpty in class RootDeploymentDescriptor

Returns:: true if this root descriptor is empty

getDefaultSpecVersion

public java.lang.String getDefaultSpecVersion()

Specified by:: getDefaultSpecVersion in class RootDeploymentDescriptor

Returns:: the default version of the deployment descriptor loaded by this descriptor

getNamedDescriptors

public java.util.Collection getNamedDescriptors()

Return the set of named descriptors that I have.

getNamedReferencePairs

public java.util.Vector<NamedReferencePair> getNamedReferencePairs()

Return the saet of NamedReferencePairs that I have.

getContextRoot

public java.lang.String getContextRoot()

return the name of my context root

setContextRoot

public void setContextRoot(java.lang.String contextRoot)

Set the name of my context root.

getWebComponentDescriptors

public java.util.Set<WebComponentDescriptor> getWebComponentDescriptors()

Return the Set of Web COmponent Descriptors (JSP or JavaServlets) in me.

addWebComponentDescriptor

public void addWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)

Adds a new Web Component Descriptor to me.

Parameters:: webComponentDescriptor -

combineWebComponentDescriptor

protected WebComponentDescriptor combineWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)

This method combines descriptor except urlPattern and add to current bundle descriptor if necessary. It returns the web component descriptor in the current bundle descriptor.

Parameters:: webComponentDescriptor - the new descriptor
Returns:: web component descriptor in current bundle

removeWebComponentDescriptor

public void removeWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)

Remove the given web component from me.

getSessionConfig

public SessionConfig getSessionConfig()

setSessionConfig

public void setSessionConfig(SessionConfig sessionConfig)

setSessionConfig

public void setSessionConfig(SessionConfigDescriptor sessionConfigDesc)

DeploymentDescriptorNode.addNodeDescriptor(node) need this.

hasServiceReferenceDescriptors

public boolean hasServiceReferenceDescriptors()

WEB SERVICES REF APIS

getServiceReferenceDescriptors

public java.util.Set<ServiceReferenceDescriptor> getServiceReferenceDescriptors()

Description copied from interface: JndiNameEnvironment

Return a set of service reference descriptors.

Specified by:: getServiceReferenceDescriptors in interface JndiNameEnvironment
Specified by:: getServiceReferenceDescriptors in interface ServiceReferenceContainer
Specified by:: getServiceReferenceDescriptors in class BundleDescriptor

Returns:: a set of service-ref from this bundle or an empty set if none

addServiceReferenceDescriptor

public void addServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef)

Description copied from interface: WritableJndiNameEnvironment

Adds the specified service reference to the receiver.

Specified by:: addServiceReferenceDescriptor in interface ServiceReferenceContainer
Specified by:: addServiceReferenceDescriptor in interface WritableJndiNameEnvironment

removeServiceReferenceDescriptor

public void removeServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef)

Description copied from interface: WritableJndiNameEnvironment

Removes the specified service reference from the receiver.

Specified by:: removeServiceReferenceDescriptor in interface ServiceReferenceContainer
Specified by:: removeServiceReferenceDescriptor in interface WritableJndiNameEnvironment

getServiceReferenceByName

public ServiceReferenceDescriptor getServiceReferenceByName(java.lang.String name)

Looks up an service reference with the given name. Throws an IllegalArgumentException if it is not found.

Specified by:: getServiceReferenceByName in interface JndiNameEnvironment
Specified by:: getServiceReferenceByName in interface ServiceReferenceContainer

Returns:: ServiceReferenceDescriptor object

_getServiceReferenceByName

protected ServiceReferenceDescriptor _getServiceReferenceByName(java.lang.String name)

combineServiceReferenceDescriptors

protected void combineServiceReferenceDescriptors(JndiNameEnvironment env)

getJmsDestinationReferenceDescriptors

public java.util.Set<JmsDestinationReferenceDescriptor> getJmsDestinationReferenceDescriptors()

Description copied from interface: JndiNameEnvironment

Return a set of JMS destination reference descriptors.

Specified by:: getJmsDestinationReferenceDescriptors in interface JndiNameEnvironment
Specified by:: getJmsDestinationReferenceDescriptors in interface ResourceEnvReferenceContainer

Returns:: the set of JMS destination references this ejb declares.

addJmsDestinationReferenceDescriptor

public void addJmsDestinationReferenceDescriptor(JmsDestinationReferenceDescriptor jmsDestReference)

adds a JMS destination reference to the bundle

Specified by:: addJmsDestinationReferenceDescriptor in interface ResourceEnvReferenceContainer
Specified by:: addJmsDestinationReferenceDescriptor in interface WritableJndiNameEnvironment

removeJmsDestinationReferenceDescriptor

public void removeJmsDestinationReferenceDescriptor(JmsDestinationReferenceDescriptor jmsDestReference)

removes a existing JMS destination reference from the bundle

Specified by:: removeJmsDestinationReferenceDescriptor in interface WritableJndiNameEnvironment

getJmsDestinationReferenceByName

public JmsDestinationReferenceDescriptor getJmsDestinationReferenceByName(java.lang.String name)

Description copied from interface: JndiNameEnvironment

Return the JMS destination reference descriptor corresponding to the given name.

Specified by:: getJmsDestinationReferenceByName in interface JndiNameEnvironment
Specified by:: getJmsDestinationReferenceByName in interface ResourceEnvReferenceContainer

Returns:: a JMS destination reference by the same name or throw an IllegalArgumentException.

_getJmsDestinationReferenceByName

protected JmsDestinationReferenceDescriptor _getJmsDestinationReferenceByName(java.lang.String name)

combineJmsDestinationReferenceDescriptors

protected void combineJmsDestinationReferenceDescriptors(JndiNameEnvironment env)

getDataSourceDefinitionDescriptors

public java.util.Set<DataSourceDefinitionDescriptor> getDataSourceDefinitionDescriptors()

Description copied from interface: JndiNameEnvironment

Return a set of data-source-definition descriptors.

Specified by:: getDataSourceDefinitionDescriptors in interface JndiNameEnvironment

Returns:: java.util.Set of data-source-definition objects

getDataSourceDefinitionDescriptor

protected DataSourceDefinitionDescriptor getDataSourceDefinitionDescriptor(java.lang.String name)

addDataSourceDefinitionDescriptor

public void addDataSourceDefinitionDescriptor(DataSourceDefinitionDescriptor reference)

Description copied from interface: WritableJndiNameEnvironment

Adds the specified data-source-definition to the receiver.

Specified by:: addDataSourceDefinitionDescriptor in interface WritableJndiNameEnvironment

Parameters:: reference - DataSourceDefinitionDescriptor to add.

removeDataSourceDefinitionDescriptor

public void removeDataSourceDefinitionDescriptor(DataSourceDefinitionDescriptor reference)

Description copied from interface: WritableJndiNameEnvironment

Removes the specified data-source-definition from the receiver.

Specified by:: removeDataSourceDefinitionDescriptor in interface WritableJndiNameEnvironment

Parameters:: reference - DataSourceDefinitionDescriptor to remove.

combineDataSourceDefinitionDescriptors

protected void combineDataSourceDefinitionDescriptors(JndiNameEnvironment env)

setMimeMappings

public void setMimeMappings(java.util.Set<MimeMapping> mimeMappings)

Sets the Set of Mime Mappings for this web application.

getMimeMappings

public java.util.Enumeration<MimeMapping> getMimeMappings()

addMimeMapping

public void addMimeMapping(MimeMapping mimeMapping)

addMimeMapping

public void addMimeMapping(MimeMappingDescriptor mimeMapping)

add the given mime mapping to my list.

addLocaleEncodingMappingListDescriptor

public void addLocaleEncodingMappingListDescriptor(LocaleEncodingMappingListDescriptor lemDesc)

getLocaleEncodingMappingListDescriptor

public LocaleEncodingMappingListDescriptor getLocaleEncodingMappingListDescriptor()

setLocaleEncodingMappingListDescriptor

public void setLocaleEncodingMappingListDescriptor(LocaleEncodingMappingListDescriptor lemDesc)

removeMimeMapping

public void removeMimeMapping(MimeMapping mimeMapping)

Removes the given mime mapping from my list.

getWelcomeFiles

public java.util.Enumeration<java.lang.String> getWelcomeFiles()

Return an enumeration of the welcome files I have..

getWelcomeFilesSet

public java.util.Set<java.lang.String> getWelcomeFilesSet()

addWelcomeFile

public void addWelcomeFile(java.lang.String fileUri)

Adds a new welcome file to my list.

removeWelcomeFile

public void removeWelcomeFile(java.lang.String fileUri)

Removes a welcome file from my list.

setWelcomeFiles

public void setWelcomeFiles(java.util.Set<java.lang.String> welcomeFiles)

Sets the collection of my welcome files.

getErrorPageDescriptors

public java.util.Enumeration<ErrorPageDescriptor> getErrorPageDescriptors()

Returns an enumeration of the error pages I have.

addErrorPageDescriptor

public void addErrorPageDescriptor(ErrorPageDescriptor errorPageDescriptor)

Adds a new error page to my list.

removeErrorPageDescriptor

public void removeErrorPageDescriptor(ErrorPageDescriptor errorPageDescriptor)

Removes the given error page from my list.

getErrorPageDescriptorBySignifier

public ErrorPageDescriptor getErrorPageDescriptorBySignifier(java.lang.String signifier)

Search my error pages for one with thei given signifier or null if there isn't one.

getContextParametersSet

public java.util.Set<ContextParameter> getContextParametersSet()

Returns:: the Set of my Context Parameters.

getContextParameters

public java.util.Enumeration<ContextParameter> getContextParameters()

Returns:: my Context Parameters in an enumeration.

addContextParameter

public void addContextParameter(ContextParameter contextParameter)

Adds a new context parameter to my list.

addContextParameter

public void addContextParameter(EnvironmentProperty contextParameter)

Adds a new context parameter to my list.

removeContextParameter

public void removeContextParameter(ContextParameter contextParameter)

Removes the given context parameter from my list.

isDistributable

public java.lang.Boolean isDistributable()

Return true if this web app [{0}] can be distributed across different processes.

setDistributable

public void setDistributable(java.lang.Boolean isDistributable)

Sets whether this web app [{0}] can be distributed across different processes.

getEjbReferences

public java.util.Enumeration<EjbReference> getEjbReferences()

Returns the enumeration of my references to Enterprise Beans.

getEjbReferenceDescriptors

public java.util.Set<EjbReference> getEjbReferenceDescriptors()

Returns the Set of my references to Enterprise Beans.

Specified by:: getEjbReferenceDescriptors in interface JndiNameEnvironment
Specified by:: getEjbReferenceDescriptors in interface EjbReferenceContainer

Returns:: java.util.Set of EjbReferenceDescriptor objects

getEjbReferenceByName

public EjbReferenceDescriptor getEjbReferenceByName(java.lang.String name)

Returns:: an Enterprise Bean with the matching name or throw.

getEjbReference

public EjbReference getEjbReference(java.lang.String name)

Description copied from interface: EjbReferenceContainer

Looks up an ejb reference with the given name. Throws an IllegalArgumentException if it is not found.

Specified by:: getEjbReference in interface EjbReferenceContainer

_getEjbReference

protected EjbReference _getEjbReference(java.lang.String name)

getResourceReferenceByName

public ResourceReferenceDescriptor getResourceReferenceByName(java.lang.String name)

Description copied from interface: ResourceReferenceContainer

Looks up a reference to a resource by its name (getName()). Throws an IllegalArgumentException if no such descriptor is found.

Specified by:: getResourceReferenceByName in interface ResourceReferenceContainer

Returns:: a reource reference with the matching name or throw.

_getResourceReferenceByName

protected ResourceReferenceDescriptor _getResourceReferenceByName(java.lang.String name)

getResourceReferenceDescriptors

public java.util.Set<ResourceReferenceDescriptor> getResourceReferenceDescriptors()

Description copied from interface: JndiNameEnvironment

Return a set of resource reference descriptors.

Specified by:: getResourceReferenceDescriptors in interface JndiNameEnvironment
Specified by:: getResourceReferenceDescriptors in interface ResourceReferenceContainer

Returns:: java.util.Set of ResourceReferenceDescriptor objects

getEntityManagerFactoryReferenceDescriptors

public java.util.Set<EntityManagerFactoryReferenceDescriptor> getEntityManagerFactoryReferenceDescriptors()

Description copied from interface: JndiNameEnvironment

Return a set of entity manager factory reference descriptors.

Specified by:: getEntityManagerFactoryReferenceDescriptors in interface JndiNameEnvironment

getEntityManagerFactoryReferenceByName

public EntityManagerFactoryReferenceDescriptor getEntityManagerFactoryReferenceByName(java.lang.String name)

Return the entity manager factory reference descriptor corresponding to the given name.

Specified by:: getEntityManagerFactoryReferenceByName in interface JndiNameEnvironment

_getEntityManagerFactoryReferenceByName

protected EntityManagerFactoryReferenceDescriptor _getEntityManagerFactoryReferenceByName(java.lang.String name)

addEntityManagerFactoryReferenceDescriptor

public void addEntityManagerFactoryReferenceDescriptor(EntityManagerFactoryReferenceDescriptor reference)

Specified by:: addEntityManagerFactoryReferenceDescriptor in interface WritableJndiNameEnvironment

combineEntityManagerFactoryReferenceDescriptors

protected void combineEntityManagerFactoryReferenceDescriptors(JndiNameEnvironment env)

getEntityManagerReferenceDescriptors

public java.util.Set<EntityManagerReferenceDescriptor> getEntityManagerReferenceDescriptors()

Description copied from interface: JndiNameEnvironment

Return a set of entity manager reference descriptors.

Specified by:: getEntityManagerReferenceDescriptors in interface JndiNameEnvironment

getEntityManagerReferenceByName

public EntityManagerReferenceDescriptor getEntityManagerReferenceByName(java.lang.String name)

Return the entity manager factory reference descriptor corresponding to the given name.

Specified by:: getEntityManagerReferenceByName in interface JndiNameEnvironment

_getEntityManagerReferenceByName

protected EntityManagerReferenceDescriptor _getEntityManagerReferenceByName(java.lang.String name)

addEntityManagerReferenceDescriptor

public void addEntityManagerReferenceDescriptor(EntityManagerReferenceDescriptor reference)

Specified by:: addEntityManagerReferenceDescriptor in interface WritableJndiNameEnvironment

combineEntityManagerReferenceDescriptors

protected void combineEntityManagerReferenceDescriptors(JndiNameEnvironment env)

findReferencedPUs

public java.util.Collection<? extends PersistenceUnitDescriptor> findReferencedPUs()

This method returns all the persistence units that are referenced by this module. Depending on the type of component, a PU can be referenced by one of the four following ways: , @PersistenceContext, and @PersistenceUnit Only EjbBundleDescriptor, ApplicationClientDescriptor and WebBundleDescriptor have useful implementation of this method.

Overrides:: findReferencedPUs in class BundleDescriptor

Returns:: persistence units that are referenced by this module

getEnvironmentProperties

public java.util.Set<EnvironmentEntry> getEnvironmentProperties()

Return my set of environment properties.

Specified by:: getEnvironmentProperties in interface JndiNameEnvironment

Returns:: java.util.Set of EnvironmentProperty objects

addEjbReferenceDescriptor

public void addEjbReferenceDescriptor(EjbReference ejbReference)

Adds a new reference to an ejb.

Specified by:: addEjbReferenceDescriptor in interface EjbReferenceContainer
Specified by:: addEjbReferenceDescriptor in interface WritableJndiNameEnvironment

Parameters:: ejbReference - the EjbReferenceDescriptor to add.

addEjbReferenceDescriptor

public void addEjbReferenceDescriptor(EjbReferenceDescriptor ejbReferenceDescriptor)

Adds a new reference to an ejb.

removeEjbReferenceDescriptor

public void removeEjbReferenceDescriptor(EjbReferenceDescriptor ejbReferenceDescriptor)

Removes a reference to an ejb.

removeEjbReferenceDescriptor

public void removeEjbReferenceDescriptor(EjbReference ejbReferenceDescriptor)

Description copied from interface: WritableJndiNameEnvironment

Removes the specificed ejb reference from the receiver.

Specified by:: removeEjbReferenceDescriptor in interface WritableJndiNameEnvironment

Parameters:: ejbReferenceDescriptor - the EjbReferenceDescriptor to remove.

combineEjbReferenceDescriptors

protected void combineEjbReferenceDescriptors(JndiNameEnvironment env)

getResourceReferences

public java.util.Enumeration<ResourceReferenceDescriptor> getResourceReferences()

Return an enumeration of references to resources that I have.

addResourceReferenceDescriptor

public void addResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference)

adds a new reference to a resource.

Specified by:: addResourceReferenceDescriptor in interface ResourceReferenceContainer
Specified by:: addResourceReferenceDescriptor in interface WritableJndiNameEnvironment

Parameters:: resourceReference - the ResourceReferenceDescriptor to add.

removeResourceReferenceDescriptor

public void removeResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference)

removes a reference to a resource.

Specified by:: removeResourceReferenceDescriptor in interface WritableJndiNameEnvironment

Parameters:: resourceReference - the ResourceReferenceDescriptor to remove.

combineResourceReferenceDescriptors

protected void combineResourceReferenceDescriptors(JndiNameEnvironment env)

getMessageDestinationReferenceDescriptors

public java.util.Set<MessageDestinationReferenceDescriptor> getMessageDestinationReferenceDescriptors()

Description copied from interface: JndiNameEnvironment

Return a set of message destination reference descriptors.

Specified by:: getMessageDestinationReferenceDescriptors in interface JndiNameEnvironment
Specified by:: getMessageDestinationReferenceDescriptors in interface MessageDestinationReferenceContainer

Returns:: java.util.Set of MessageDestinationReferenceDescriptor objects

addMessageDestinationReferenceDescriptor

public void addMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor messageDestRef)

Description copied from interface: WritableJndiNameEnvironment

Adds the specified message destination reference to the receiver.

Specified by:: addMessageDestinationReferenceDescriptor in interface MessageDestinationReferenceContainer
Specified by:: addMessageDestinationReferenceDescriptor in interface WritableJndiNameEnvironment

removeMessageDestinationReferenceDescriptor

public void removeMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor msgDestRef)

Description copied from interface: WritableJndiNameEnvironment

Removes the specified message destination reference from the receiver.

Specified by:: removeMessageDestinationReferenceDescriptor in interface MessageDestinationReferenceContainer
Specified by:: removeMessageDestinationReferenceDescriptor in interface WritableJndiNameEnvironment

getMessageDestinationReferenceByName

public MessageDestinationReferenceDescriptor getMessageDestinationReferenceByName(java.lang.String name)

Looks up an message destination reference with the given name. Throws an IllegalArgumentException if it is not found.

Specified by:: getMessageDestinationReferenceByName in interface JndiNameEnvironment
Specified by:: getMessageDestinationReferenceByName in interface MessageDestinationReferenceContainer

Returns:: MessageDestinationReferenceDescriptor object

_getMessageDestinationReferenceByName

protected MessageDestinationReferenceDescriptor _getMessageDestinationReferenceByName(java.lang.String name)

combineMessageDestinationReferenceDescriptors

protected void combineMessageDestinationReferenceDescriptors(JndiNameEnvironment env)

getPostConstructDescriptors

public java.util.Set<LifecycleCallbackDescriptor> getPostConstructDescriptors()

Description copied from interface: JndiNameEnvironment

Return a set of post-construct descriptors.

Specified by:: getPostConstructDescriptors in interface JndiNameEnvironment

Returns:: java.util.Set of LifecycleCallbackDescriptor post-construct objects

addPostConstructDescriptor

public void addPostConstructDescriptor(LifecycleCallbackDescriptor postConstructDesc)

Description copied from interface: WritableJndiNameEnvironment

Adds the specified post-construct descriptor to the receiver.

Specified by:: addPostConstructDescriptor in interface WritableJndiNameEnvironment

getPostConstructDescriptorByClass

public LifecycleCallbackDescriptor getPostConstructDescriptorByClass(java.lang.String className)

Description copied from interface: JndiNameEnvironment

Return the post-construct descriptor corresponding to the given name.

Specified by:: getPostConstructDescriptorByClass in interface JndiNameEnvironment

Returns:: LifecycleCallbackDescriptor post-construct object

combinePostConstructDescriptors

protected void combinePostConstructDescriptors(WebBundleDescriptor webBundleDescriptor)

getPreDestroyDescriptors

public java.util.Set<LifecycleCallbackDescriptor> getPreDestroyDescriptors()

Description copied from interface: JndiNameEnvironment

Return a set of pre-destroy descriptors.

Specified by:: getPreDestroyDescriptors in interface JndiNameEnvironment

Returns:: java.util.Set of LifecycleCallbackDescriptor pre-destroy objects

addPreDestroyDescriptor

public void addPreDestroyDescriptor(LifecycleCallbackDescriptor preDestroyDesc)

Description copied from interface: WritableJndiNameEnvironment

Adds the specified pre-destroy descriptor to the receiver.

Specified by:: addPreDestroyDescriptor in interface WritableJndiNameEnvironment

getPreDestroyDescriptorByClass

public LifecycleCallbackDescriptor getPreDestroyDescriptorByClass(java.lang.String className)

Description copied from interface: JndiNameEnvironment

Return the pre-destroy descriptor corresponding to the given name.

Specified by:: getPreDestroyDescriptorByClass in interface JndiNameEnvironment

Returns:: LifecycleCallbackDescriptor pre-destroy object

combinePreDestroyDescriptors

protected void combinePreDestroyDescriptors(WebBundleDescriptor webBundleDescriptor)

getInjectableResourcesByClass

protected java.util.List<InjectionCapable> getInjectableResourcesByClass(java.lang.String className,
                                                                         JndiNameEnvironment jndiNameEnv)

Description copied from class: BundleDescriptor

Define implementation of getInjectableResourceByClass here so it isn't replicated across appclient, web, ejb descriptors.

Overrides:: getInjectableResourcesByClass in class BundleDescriptor

getInjectableResourcesByClass

public java.util.List<InjectionCapable> getInjectableResourcesByClass(java.lang.String className)

Specified by:: getInjectableResourcesByClass in interface JndiNameEnvironment

getInjectionInfoByClass

public InjectionInfo getInjectionInfoByClass(java.lang.Class clazz)

Specified by:: getInjectionInfoByClass in interface JndiNameEnvironment

getSecurityRoles

public java.util.Enumeration<SecurityRoleDescriptor> getSecurityRoles()

Returns an Enumeration of my SecurityRole objects.

addSecurityRole

public void addSecurityRole(SecurityRole securityRole)

Add a new abstrct role to me.

addSecurityRole

public void addSecurityRole(SecurityRoleDescriptor securityRole)

Add a new abstrct role to me.

getSecurityRoleReferenceByName

public SecurityRoleReference getSecurityRoleReferenceByName(java.lang.String compName,
                                                            java.lang.String roleName)

Return all the references by a given component (by name) to the given rolename.

combineSecurityConstraints

protected void combineSecurityConstraints(java.util.Set<SecurityConstraint> firstScSet,
                                          java.util.Set<SecurityConstraint> secondScSet)

getSecurityConstraintsSet

public java.util.Set<SecurityConstraint> getSecurityConstraintsSet()

getSecurityConstraints

public java.util.Enumeration<SecurityConstraint> getSecurityConstraints()

My list of security constraints.

getSecurityConstraintsForUrlPattern

public java.util.Collection<SecurityConstraint> getSecurityConstraintsForUrlPattern(java.lang.String urlPattern)

addSecurityConstraint

public void addSecurityConstraint(SecurityConstraint securityConstraint)

Add a new security constraint.

addSecurityConstraint

public void addSecurityConstraint(SecurityConstraintImpl securityConstraint)

Add a new security constraint.

removeSecurityConstraint

public void removeSecurityConstraint(SecurityConstraint securityConstraint)

Remove the given security constraint.

getJspConfigDescriptor

public JspConfigDescriptor getJspConfigDescriptor()

setJspConfigDescriptor

public void setJspConfigDescriptor(JspConfigDescriptor jspC)

getServletDescriptors

public java.util.Set<WebComponentDescriptor> getServletDescriptors()

getJspDescriptors

public java.util.Set<WebComponentDescriptor> getJspDescriptors()

Returns:: my Set of jsps.

getEnvironmentEntrySet

public java.util.Set<EnvironmentEntry> getEnvironmentEntrySet()

getEnvironmentEntries

public java.util.Enumeration<EnvironmentEntry> getEnvironmentEntries()

Return my set of environment properties.

addEnvironmentEntry

public void addEnvironmentEntry(EnvironmentEntry environmentEntry)

Adds this given environment property to my list.

_getEnvironmentPropertyByName

protected EnvironmentProperty _getEnvironmentPropertyByName(java.lang.String name)

getEnvironmentPropertyByName

public EnvironmentProperty getEnvironmentPropertyByName(java.lang.String name)

Returns the environment property object searching on the supplied key. throws an illegal argument exception if no such environment property exists.

Specified by:: getEnvironmentPropertyByName in interface JndiNameEnvironment

Returns:: EnvironmentProperty descriptor

removeEnvironmentProperty

public void removeEnvironmentProperty(EnvironmentProperty environmentProperty)

Removes this given environment property from my list.

Specified by:: removeEnvironmentProperty in interface WritableJndiNameEnvironment

Parameters:: environmentProperty - the EnvironmentProperty to remove.

addEnvironmentProperty

public void addEnvironmentProperty(EnvironmentProperty environmentProperty)

Adds this given environment property to my list.

Specified by:: addEnvironmentProperty in interface WritableJndiNameEnvironment

Parameters:: environmentProperty - the EnvironmentProperty to add.

removeEnvironmentEntry

public void removeEnvironmentEntry(EnvironmentEntry environmentEntry)

Removes this given environment property from my list.

combineEnvironmentEntries

protected void combineEnvironmentEntries(JndiNameEnvironment env)

getLoginConfiguration

public LoginConfiguration getLoginConfiguration()

Return the information about how I should log in.

setLoginConfiguration

public void setLoginConfiguration(LoginConfiguration loginConfiguration)

Specifies the information about how I should log in.

setLoginConfiguration

public void setLoginConfiguration(LoginConfigurationImpl loginConfiguration)

combineLoginConfiguration

protected void combineLoginConfiguration(WebBundleDescriptor webBundleDescriptor)

getWebComponentByName

public WebComponentDescriptor getWebComponentByName(java.lang.String name)

Search for a web component that I have by name.

getWebComponentByCanonicalName

public WebComponentDescriptor getWebComponentByCanonicalName(java.lang.String name)

Search for a web component that I have by name.

getWebComponentByImplName

public WebComponentDescriptor[] getWebComponentByImplName(java.lang.String name)

Returns:: a set of web component descriptor of given impl name.

getServletFilters

public java.util.Vector<ServletFilter> getServletFilters()

Returns:: a Vector of servlet filters that I have.

getServletFilterDescriptors

public java.util.Vector getServletFilterDescriptors()

Returns:: a Vector of servlet filters that I have.

addServletFilter

public void addServletFilter(ServletFilter ref)

Adds a servlet filter to this web component.

addServletFilter

public void addServletFilter(ServletFilterDescriptor ref)

removeServletFilter

public void removeServletFilter(ServletFilter ref)

Removes the given servlet filter from this web component.

combineServletFilters

protected void combineServletFilters(WebBundleDescriptor webBundleDescriptor)

getServletFilterMappings

public java.util.Vector<ServletFilterMapping> getServletFilterMappings()

Return a Vector of servlet filters that I have.

getServletFilterMappingDescriptors

public java.util.Vector<ServletFilterMapping> getServletFilterMappingDescriptors()

Return a Vector of servlet filter mappings that I have.

addServletFilterMapping

public void addServletFilterMapping(ServletFilterMapping ref)

Adds a servlet filter mapping to this web component.

addServletFilterMapping

public void addServletFilterMapping(ServletFilterMappingDescriptor ref)

Adds a servlet filter mapping to this web component.

removeServletFilterMapping

public void removeServletFilterMapping(ServletFilterMapping ref)

Removes the given servlet filter mapping from this web component.

moveServletFilterMapping

public void moveServletFilterMapping(ServletFilterMapping ref,
                                     int relPos)

* Moves the given servlet filter mapping to a new relative location in * the list

combineServletFilterMappings

protected void combineServletFilterMappings(WebBundleDescriptor webBundleDescriptor)

getAppListenerDescriptors

public java.util.Vector<AppListenerDescriptor> getAppListenerDescriptors()

setAppListeners

public void setAppListeners(java.util.Collection<? extends AppListenerDescriptor> c)

addAppListenerDescriptor

public void addAppListenerDescriptor(AppListenerDescriptor ref)

addAppListenerDescriptor

public void addAppListenerDescriptor(AppListenerDescriptorImpl ref)

removeAppListenerDescriptor

public void removeAppListenerDescriptor(AppListenerDescriptor ref)

moveAppListenerDescriptor

public void moveAppListenerDescriptor(AppListenerDescriptor ref,
                                      int relPos)

getAbsoluteOrderingDescriptor

public AbsoluteOrderingDescriptor getAbsoluteOrderingDescriptor()

setAbsoluteOrderingDescriptor

public void setAbsoluteOrderingDescriptor(AbsoluteOrderingDescriptor absOrdering)

hasWebServiceClients

public boolean hasWebServiceClients()

Overrides:: hasWebServiceClients in class BundleDescriptor

Returns:: true if this bundle descriptor defines web service clients

removeVectorItem

protected boolean removeVectorItem(java.util.Vector<? extends java.lang.Object> list,
                                   java.lang.Object ref)

remove a specific object from the given list (does not rely on 'equals')

moveVectorItem

protected void moveVectorItem(java.util.Vector list,
                              java.lang.Object ref,
                              int rpos)

Moves the given object to a new relative location in the specified list

visit

public void visit(DescriptorVisitor aVisitor)

visitor API implementation

Overrides:: visit in class Descriptor

Parameters:: aVisitor - the visitor implementation

visit

public void visit(WebBundleVisitor aVisitor)

visitor API implementation

putJarNameWebFragmentNamePair

public void putJarNameWebFragmentNamePair(java.lang.String jarName,
                                          java.lang.String webFragName)

getJarNameToWebFragmentNameMap

public java.util.Map<java.lang.String,java.lang.String> getJarNameToWebFragmentNameMap()

This method return an unmodifiable version of jarName2WebFragNameMap.

Returns:: unmodifiable version of jarName2WebFragNameMap

getOrderedLibs

public java.util.List<java.lang.String> getOrderedLibs()

addOrderedLib

public void addOrderedLib(java.lang.String libName)

print

public void print(java.lang.StringBuffer toStringBuffer)

Return a formatted version as a String.

Overrides:: print in class BundleDescriptor

printCommon

public void printCommon(java.lang.StringBuffer toStringBuffer)

getModuleType

public XModuleType getModuleType()

Specified by:: getModuleType in class BundleDescriptor

Returns:: the module type for this bundle descriptor

getDeploymentDescriptorDir

public java.lang.String getDeploymentDescriptorDir()

Overrides:: getDeploymentDescriptorDir in class BundleDescriptor

Returns:: the deployment descriptor directory location inside the archive file

getSunDescriptor

public SunWebApp getSunDescriptor()

This returns the extra web sun specific info not in the RI DID.

Returns:: object representation of web deployment descriptor

setSunDescriptor

public void setSunDescriptor(SunWebApp webApp)

This sets the extra web sun specific info not in the RI DID.

Parameters:: webApp - SunWebApp object representation of web deployment descriptor

setExtensionProperty

public void setExtensionProperty(java.lang.String key,
                                 java.lang.String value)

This property can be used to indicate special processing. For example, a Deployer may set this property.

hasExtensionProperty

public boolean hasExtensionProperty(java.lang.String key)

Determine if an extension property has been set.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sun.enterprise.deployment Class WebBundleDescriptor

AFTER_SERVLET_CONTEXT_INITIALIZED_EVENT

conflictLoginConfig

conflictDataSourceDefinition

conflictEnvironmentEntry

conflictEjbReference

conflictServiceReference

conflictResourceReference

conflictJmsDestinationReference

conflictMessageDestinationReference

conflictEntityManagerReference

conflictEntityManagerFactoryReference

WebBundleDescriptor

addWebBundleDescriptor

addDefaultWebBundleDescriptor

addJndiNameEnvironment

isEmpty

getDefaultSpecVersion

getNamedDescriptors

getNamedReferencePairs

getContextRoot

setContextRoot

getWebComponentDescriptors

addWebComponentDescriptor

combineWebComponentDescriptor

removeWebComponentDescriptor

getSessionConfig

setSessionConfig

setSessionConfig

hasServiceReferenceDescriptors

getServiceReferenceDescriptors

addServiceReferenceDescriptor

removeServiceReferenceDescriptor

getServiceReferenceByName

_getServiceReferenceByName

combineServiceReferenceDescriptors

getJmsDestinationReferenceDescriptors

addJmsDestinationReferenceDescriptor

removeJmsDestinationReferenceDescriptor

getJmsDestinationReferenceByName

_getJmsDestinationReferenceByName

combineJmsDestinationReferenceDescriptors

getDataSourceDefinitionDescriptors

getDataSourceDefinitionDescriptor

addDataSourceDefinitionDescriptor

removeDataSourceDefinitionDescriptor

combineDataSourceDefinitionDescriptors

setMimeMappings

getMimeMappings

addMimeMapping

addMimeMapping

addLocaleEncodingMappingListDescriptor

getLocaleEncodingMappingListDescriptor

setLocaleEncodingMappingListDescriptor

removeMimeMapping

getWelcomeFiles

getWelcomeFilesSet

addWelcomeFile

removeWelcomeFile

setWelcomeFiles

getErrorPageDescriptors

addErrorPageDescriptor

removeErrorPageDescriptor

getErrorPageDescriptorBySignifier

getContextParametersSet

getContextParameters

addContextParameter

addContextParameter

removeContextParameter

isDistributable

setDistributable

getEjbReferences

getEjbReferenceDescriptors

getEjbReferenceByName

getEjbReference

_getEjbReference

getResourceReferenceByName

_getResourceReferenceByName

getResourceReferenceDescriptors

getEntityManagerFactoryReferenceDescriptors

com.sun.enterprise.deployment
Class WebBundleDescriptor