Class WebBundleDescriptorImpl
- java.lang.Object
-
- java.util.Observable
-
- org.glassfish.deployment.common.DynamicAttributesDescriptor
-
- org.glassfish.deployment.common.Descriptor
-
- org.glassfish.deployment.common.RootDeploymentDescriptor
-
- com.sun.enterprise.deployment.BundleDescriptor
-
- com.sun.enterprise.deployment.CommonResourceBundleDescriptor
-
- com.sun.enterprise.deployment.WebBundleDescriptor
-
- org.glassfish.web.deployment.descriptor.WebBundleDescriptorImpl
-
- All Implemented Interfaces:
JndiNameEnvironment,Roles,EjbReferenceContainer,MessageDestinationReferenceContainer,ResourceEnvReferenceContainer,ResourceReferenceContainer,ServiceReferenceContainer,WritableJndiNameEnvironment,Serializable
- Direct Known Subclasses:
WebFragmentDescriptor
public class WebBundleDescriptorImpl extends WebBundleDescriptor
The concrete implementation of abstract super class com.sun.enterprise.deployment.WebBundleDescriptor. TODO WebBundleDescriptor could be changed from abstract class to an interface in the future, with this class as its implementation.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.sun.enterprise.deployment.WebBundleDescriptor
AFTER_SERVLET_CONTEXT_INITIALIZED_EVENT, conflictAdminObjectDefinition, conflictConnectionFactoryDefinition, conflictDataSourceDefinition, conflictEjbReference, conflictEntityManagerFactoryReference, conflictEntityManagerReference, conflictEnvironmentEntry, conflictJMSConnectionFactoryDefinition, conflictJMSDestinationDefinition, conflictLoginConfig, conflictMailSessionDefinition, conflictMessageDestinationReference, conflictResourceEnvReference, conflictResourceReference, conflictServiceReference
-
Fields inherited from class com.sun.enterprise.deployment.BundleDescriptor
rootNodes
-
Fields inherited from class org.glassfish.deployment.common.RootDeploymentDescriptor
classLoader, deplLogger, extensions, moduleDescriptor, moduleID
-
Fields inherited from class org.glassfish.deployment.common.Descriptor
DESCRIPTION_CHANGED, DESCRIPTOR_CHANGED, docType, LARGE_ICON_CHANGED, NAME_CHANGED, SMALL_ICON_CHANGED
-
-
Constructor Summary
Constructors Constructor Description WebBundleDescriptorImpl()Construct an empty web app [{0}].
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected EjbReference_getEjbReference(String name)protected EntityManagerFactoryReferenceDescriptor_getEntityManagerFactoryReferenceByName(String name)protected EntityManagerReferenceDescriptor_getEntityManagerReferenceByName(String name)protected EnvironmentProperty_getEnvironmentPropertyByName(String name)protected MessageDestinationReferenceDescriptor_getMessageDestinationReferenceByName(String name)protected ResourceEnvReferenceDescriptor_getResourceEnvReferenceByName(String name)protected ResourceReferenceDescriptor_getResourceReferenceByName(String name)protected ServiceReferenceDescriptor_getServiceReferenceByName(String name)voidaddAppListenerDescriptor(AppListenerDescriptor ref)voidaddAppListenerDescriptor(AppListenerDescriptorImpl ref)voidaddAppListenerDescriptorToFirst(AppListenerDescriptor ref)voidaddContextParameter(EnvironmentProperty contextParameter)Adds a new context parameter to my list.voidaddContextParameter(ContextParameter contextParameter)Adds a new context parameter to my list.voidaddDefaultWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)voidaddEjbReferenceDescriptor(EjbReferenceDescriptor ejbReferenceDescriptor)Adds a new reference to an ejb.voidaddEjbReferenceDescriptor(EjbReference ejbReference)Adds a new reference to an ejb.voidaddEntityManagerFactoryReferenceDescriptor(EntityManagerFactoryReferenceDescriptor reference)voidaddEntityManagerReferenceDescriptor(EntityManagerReferenceDescriptor reference)voidaddEnvironmentEntry(EnvironmentEntry environmentEntry)Adds this given environment property to my list.voidaddEnvironmentProperty(EnvironmentProperty environmentProperty)Adds this given environment property to my list.voidaddErrorPageDescriptor(ErrorPageDescriptor errorPageDescriptor)Adds a new error page to my list.voidaddJndiNameEnvironment(JndiNameEnvironment env)voidaddLocaleEncodingMappingDescriptor(LocaleEncodingMappingDescriptor lemDesc)voidaddMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor messageDestRef)Adds the specified message destination reference to the receiver.StringaddMimeMapping(MimeMapping mimeMapping)StringaddMimeMapping(MimeMappingDescriptor mimeMapping)add the given mime mapping to my list.voidaddOrderedLib(String libName)voidaddPostConstructDescriptor(LifecycleCallbackDescriptor postConstructDesc)Adds the specified post-construct descriptor to the receiver.voidaddPreDestroyDescriptor(LifecycleCallbackDescriptor preDestroyDesc)Adds the specified pre-destroy descriptor to the receiver.voidaddResourceEnvReferenceDescriptor(ResourceEnvReferenceDescriptor resourceEnvRefReference)adds a resource environment reference to the bundlevoidaddResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference)adds a new reference to a resource.voidaddSecurityConstraint(SecurityConstraint securityConstraint)Add a new security constraint.voidaddSecurityConstraint(SecurityConstraintImpl securityConstraint)Add a new security constraint.voidaddSecurityRole(SecurityRoleDescriptor securityRole)Add a new abstract role to me.voidaddSecurityRole(SecurityRole securityRole)Add a new abstract role to me.voidaddServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef)Adds the specified service reference to the receiver.voidaddServletFilter(ServletFilter ref)Adds a servlet filter to this web component.voidaddServletFilter(ServletFilterDescriptor ref)voidaddServletFilterMapping(ServletFilterMapping ref)Adds a servlet filter mapping to this web component.voidaddServletFilterMapping(ServletFilterMappingDescriptor ref)Adds a servlet filter mapping to this web component.voidaddWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)This method will merge the contents of webComponents.voidaddWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)Adds a new Web Component Descriptor to me.voidaddWelcomeFile(String fileUri)Adds a new welcome file to my list.protected voidcombineEjbReferenceDescriptors(JndiNameEnvironment env)protected voidcombineEntityManagerFactoryReferenceDescriptors(JndiNameEnvironment env)protected voidcombineEntityManagerReferenceDescriptors(JndiNameEnvironment env)protected voidcombineEnvironmentEntries(JndiNameEnvironment env)protected voidcombineInjectionTargets(EnvironmentProperty env1, EnvironmentProperty env2)This method will copy the injection targets from env2 to env1.protected voidcombineLoginConfiguration(WebBundleDescriptor webBundleDescriptor)protected voidcombineMessageDestinationReferenceDescriptors(JndiNameEnvironment env)protected voidcombineMimeMappings(Set<MimeMapping> mimeMappings)protected voidcombinePostConstructDescriptors(WebBundleDescriptor webBundleDescriptor)protected voidcombinePreDestroyDescriptors(WebBundleDescriptor webBundleDescriptor)protected voidcombineResourceDescriptors(JndiNameEnvironment env, JavaEEResourceType javaEEResourceType)protected voidcombineResourceEnvReferenceDescriptors(JndiNameEnvironment env)protected voidcombineResourceReferenceDescriptors(JndiNameEnvironment env)protected voidcombineSecurityConstraints(Set<SecurityConstraint> firstScSet, Set<SecurityConstraint> secondScSet)protected voidcombineServiceReferenceDescriptors(JndiNameEnvironment env)protected voidcombineServletFilterMappings(WebBundleDescriptor webBundleDescriptor)protected voidcombineServletFilters(WebBundleDescriptor webBundleDescriptor)protected WebComponentDescriptorcombineWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)This method combines descriptor except urlPattern and add to current bundle descriptor if necessary.WebBundleDescriptorcreateWebBundleDescriptor()Collection<? extends PersistenceUnitDescriptor>findReferencedPUs()This method returns all the persistence units that are referenced by this module.AbsoluteOrderingDescriptorgetAbsoluteOrderingDescriptor()StringgetAppContextId()Vector<AppListenerDescriptor>getAppListenerDescriptors()Vector<AppListenerDescriptor>getAppListeners()ComponentVisitorgetBundleVisitor()Set<String>getConflictedMimeMappingExtensions()Enumeration<ContextParameter>getContextParameters()Set<ContextParameter>getContextParametersSet()StringgetContextRoot()return the name of my context rootStringgetDefaultSpecVersion()StringgetDeploymentDescriptorDir()EjbReferencegetEjbReference(String name)Looks up an ejb reference with the given name.EjbReferenceDescriptorgetEjbReferenceByName(String name)Set<EjbReference>getEjbReferenceDescriptors()Returns the Set of my references to Enterprise Beans.Enumeration<EjbReference>getEjbReferences()Returns the enumeration of my references to Enterprise Beans.EntityManagerFactoryReferenceDescriptorgetEntityManagerFactoryReferenceByName(String name)Return the entity manager factory reference descriptor corresponding to the given name.Set<EntityManagerFactoryReferenceDescriptor>getEntityManagerFactoryReferenceDescriptors()Return a set of entity manager factory reference descriptors.EntityManagerReferenceDescriptorgetEntityManagerReferenceByName(String name)Return the entity manager factory reference descriptor corresponding to the given name.Set<EntityManagerReferenceDescriptor>getEntityManagerReferenceDescriptors()Return a set of entity manager reference descriptors.Enumeration<EnvironmentEntry>getEnvironmentEntries()Return my set of environment properties.Set<EnvironmentEntry>getEnvironmentEntrySet()Set<EnvironmentEntry>getEnvironmentProperties()Return my set of environment properties.EnvironmentPropertygetEnvironmentPropertyByName(String name)Returns the environment property object searching on the supplied key.ErrorPageDescriptorgetErrorPageDescriptorBySignifier(String signifier)Search my error pages for one with thei given signifier or null if there isn't one.Enumeration<ErrorPageDescriptor>getErrorPageDescriptors()Returns an enumeration of the error pages I have.Set<ErrorPageDescriptor>getErrorPageDescriptorsSet()List<InjectionCapable>getInjectableResourcesByClass(String className)protected List<InjectionCapable>getInjectableResourcesByClass(String className, JndiNameEnvironment jndiNameEnv)Define implementation of getInjectableResourceByClass here so it isn't replicated across appclient, web, ejb descriptors.InjectionInfogetInjectionInfoByClass(Class clazz)Map<String,String>getJarNameToWebFragmentNameMap()This method return an unmodifiable version of jarName2WebFragNameMap.JspConfigDescriptorImplgetJspConfigDescriptor()Set<WebComponentDescriptor>getJspDescriptors()LocaleEncodingMappingListDescriptorgetLocaleEncodingMappingListDescriptor()LoginConfigurationgetLoginConfiguration()Return the information about how I should log in.MessageDestinationReferenceDescriptorgetMessageDestinationReferenceByName(String name)Looks up an message destination reference with the given name.Set<MessageDestinationReferenceDescriptor>getMessageDestinationReferenceDescriptors()Return a set of message destination reference descriptors.Enumeration<MimeMapping>getMimeMappings()Set<MimeMapping>getMimeMappingsSet()ArchiveTypegetModuleType()CollectiongetNamedDescriptors()Return the set of named descriptors that I have.Vector<NamedReferencePair>getNamedReferencePairs()Return the state of NamedReferencePairs that I have.List<String>getOrderedLibs()LifecycleCallbackDescriptorgetPostConstructDescriptorByClass(String className)Return the post-construct descriptor corresponding to the given name.Set<LifecycleCallbackDescriptor>getPostConstructDescriptors()Return a set of post-construct descriptors.LifecycleCallbackDescriptorgetPreDestroyDescriptorByClass(String className)Return the pre-destroy descriptor corresponding to the given name.Set<LifecycleCallbackDescriptor>getPreDestroyDescriptors()Return a set of pre-destroy descriptors.StringgetRequestCharacterEncoding()return the request encodingResourceEnvReferenceDescriptorgetResourceEnvReferenceByName(String name)Return the resource environment reference descriptor corresponding to the given name.Set<ResourceEnvReferenceDescriptor>getResourceEnvReferenceDescriptors()Return a set of resource environment reference descriptors.ResourceReferenceDescriptorgetResourceReferenceByName(String name)Looks up a reference to a resource by its name (getName()).Set<ResourceReferenceDescriptor>getResourceReferenceDescriptors()Return a set of resource reference descriptors.Enumeration<ResourceReferenceDescriptor>getResourceReferences()Return an enumeration of references to resources that I have.StringgetResponseCharacterEncoding()return the response encodingEnumeration<SecurityConstraint>getSecurityConstraints()My list of security constraints.Collection<SecurityConstraint>getSecurityConstraintsForUrlPattern(String urlPattern)Set<SecurityConstraint>getSecurityConstraintsSet()SecurityRoleReferencegetSecurityRoleReferenceByName(String compName, String roleName)Return all the references by a given component (by name) to the given rolename.Enumeration<SecurityRoleDescriptor>getSecurityRoles()Returns an Enumeration of my SecurityRole objects.ServiceReferenceDescriptorgetServiceReferenceByName(String name)Looks up an service reference with the given name.Set<ServiceReferenceDescriptor>getServiceReferenceDescriptors()Return a set of service reference descriptors.Set<WebComponentDescriptor>getServletDescriptors()Vector<ServletFilter>getServletFilterDescriptors()Vector<ServletFilterMapping>getServletFilterMappingDescriptors()Return a Vector of servlet filter mappings that I have.Vector<ServletFilterMapping>getServletFilterMappings()Return a Vector of servlet filters that I have.Vector<ServletFilter>getServletFilters()booleangetServletInitializersEnabled()intgetServletReloadCheckSecs()SessionConfiggetSessionConfig()SunWebAppgetSunDescriptor()This returns the extra web sun specific info not in the RI DID.DescriptorVisitorgetTracerVisitor()Map<String,String>getUrlPatternToServletNameMap()This method is used by WebComponentDescriptor only.WebComponentDescriptorgetWebComponentByCanonicalName(String name)Search for a web component that I have by name.WebComponentDescriptor[]getWebComponentByImplName(String name)WebComponentDescriptorgetWebComponentByName(String name)Search for a web component that I have by name.Set<WebComponentDescriptor>getWebComponentDescriptors()Return the Set of Web Component Descriptors (JSP or JavaServlets) in me.Enumeration<String>getWelcomeFiles()Return an enumeration of the welcome files I have..Set<String>getWelcomeFilesSet()booleanhasExtensionProperty(String key)Determine if an extension property has been set.booleanhasServiceReferenceDescriptors()WEB SERVICES REF APISbooleanhasWebServiceClients()booleanisDenyUncoveredHttpMethods()booleanisDistributable()Return true if this web app [{0}] can be distributed across different processes.booleanisEmpty()Return true if this root deployment descriptor does not describe anythingprotected booleanisExists()booleanisJaxrsRolesAllowedEnabled()booleanisShowArchivedRealPathEnabled()voidmoveAppListenerDescriptor(AppListenerDescriptor ref, int relPos)voidmoveServletFilterMapping(ServletFilterMapping ref, int relPos)* Moves the given servlet filter mapping to a new relative location in * the listprotected voidmoveVectorItem(Vector list, Object ref, int rpos)Moves the given object to a new relative location in the specified listvoidprint(StringBuilder toStringBuilder)Return a formatted version as a String.voidprintCommon(StringBuilder toStringBuilder)voidputJarNameWebFragmentNamePair(String jarName, String webFragName)voidremoveAppListenerDescriptor(AppListenerDescriptor ref)voidremoveContextParameter(ContextParameter contextParameter)Removes the given context parameter from my list.voidremoveEjbReferenceDescriptor(EjbReferenceDescriptor ejbReferenceDescriptor)Removes a reference to an ejb.voidremoveEjbReferenceDescriptor(EjbReference ejbReferenceDescriptor)Removes the specificed ejb reference from the receiver.voidremoveEnvironmentEntry(EnvironmentEntry environmentEntry)Removes this given environment property from my list.voidremoveEnvironmentProperty(EnvironmentProperty environmentProperty)Removes this given environment property from my list.voidremoveErrorPageDescriptor(ErrorPageDescriptor errorPageDescriptor)Removes the given error page from my list.voidremoveMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor msgDestRef)Removes the specified message destination reference from the receiver.voidremoveMimeMapping(MimeMapping mimeMapping)Removes the given mime mapping from my list.voidremoveResourceEnvReferenceDescriptor(ResourceEnvReferenceDescriptor resourceEnvRefReference)removes a existing resource environment reference from the bundlevoidremoveResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference)removes a reference to a resource.voidremoveSecurityConstraint(SecurityConstraint securityConstraint)Remove the given security constraint.voidremoveServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef)Removes the specified service reference from the receiver.voidremoveServletFilter(ServletFilter ref)Removes the given servlet filter from this web component.voidremoveServletFilterMapping(ServletFilterMapping ref)Removes the given servlet filter mapping from this web component.protected booleanremoveVectorItem(Vector<? extends Object> list, Object ref)remove a specific object from the given list (does not rely on 'equals')voidremoveWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)Remove the given web component from me.voidremoveWelcomeFile(String fileUri)Removes a welcome file from my list.voidresetUrlPatternToServletNameMap()voidsetAbsoluteOrderingDescriptor(AbsoluteOrderingDescriptor absOrdering)voidsetAppContextId(String appContextId)voidsetAppListeners(Collection<? extends AppListenerDescriptor> c)voidsetContextRoot(String contextRoot)Set the name of my context root.voidsetDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)voidsetDistributable(boolean distributable)Sets whether this web app [{0}] can be distributed across different processes.voidsetExtensionProperty(String key, String value)This property can be used to indicate special processing.voidsetJaxrsRolesAllowedEnabled(boolean jaxrsRolesAllowedEnabled)voidsetJspConfigDescriptor(JspConfigDescriptorImpl jspC)voidsetLocaleEncodingMappingListDescriptor(LocaleEncodingMappingListDescriptor lemListDesc)voidsetLoginConfiguration(LoginConfiguration loginConfiguration)Specifies the information about how I should log in.voidsetLoginConfiguration(LoginConfigurationImpl loginConfiguration)voidsetMimeMappings(Set<MimeMapping> mimeMappings)Sets the Set of Mime Mappings for this web application.voidsetRequestCharacterEncoding(String requestCharacterEncoding)Set the request encodingvoidsetResponseCharacterEncoding(String responseCharacterEncoding)Set the response encodingvoidsetServletInitializersEnabled(boolean tf)voidsetServletReloadCheckSecs(int secs)voidsetSessionConfig(SessionConfig sessionConfig)voidsetSessionConfig(SessionConfigDescriptor sessionConfigDesc)DeploymentDescriptorNode.addNodeDescriptor(node) need this.voidsetShowArchivedRealPathEnabled(boolean enabled)voidsetSunDescriptor(SunWebApp webApp)This sets the extra web sun specific info not in the RI DID.voidsetWelcomeFiles(Set<String> welcomeFiles)Sets the collection of my welcome files.voidvisit(ComponentVisitor aVisitor)visitor API implementationvoidvisit(DescriptorVisitor aVisitor)visitor API implementation-
Methods inherited from class com.sun.enterprise.deployment.WebBundleDescriptor
isConflictAdminObjectDefinition, isConflictConnectionFactoryDefinition, isConflictDataSourceDefinition, isConflictEjbReference, isConflictEntityManagerFactoryReference, isConflictEntityManagerReference, isConflictEnvironmentEntry, isConflictJMSConnectionFactoryDefinition, isConflictJMSDestinationDefinition, isConflictLoginConfig, isConflictMailSessionDefinition, isConflictMessageDestinationReference, isConflictResourceEnvReference, isConflictResourceReference, isConflictServiceReference
-
Methods inherited from class com.sun.enterprise.deployment.CommonResourceBundleDescriptor
addResourceDescriptor, getAllResourcesDescriptors, getAllResourcesDescriptors, getResourceDescriptor, getResourceDescriptors, removeResourceDescriptor
-
Methods inherited from class com.sun.enterprise.deployment.BundleDescriptor
addBundleDescriptor, addEntityManagerFactory, addManagedBean, addMessageDestination, addRole, addRole, addRootNode, findDefaultPU, findReferencedPU, findReferencedPUsViaPCRefs, findReferencedPUsViaPURefs, findReferencedPUViaEMFRef, findReferencedPUViaEMRef, getApplication, getClassLoader, getCompatibility, getEntityManagerFactories, getEntityManagerFactory, getInjectableResources, getInjectionInfoByClass, getKeepState, getManagedBeanByBeanClass, getManagedBeans, getMessageDestinationByName, getMessageDestinations, getModuleID, getModuleName, getNamedDescriptorsFrom, getNamedReferencePairsFrom, getPostConstructDescriptorByClass, getPreDestroyDescriptorByClass, getRawModuleID, getRoles, getRootNode, getUniqueFriendlyId, getVisiblePUs, getWebServiceEndpointByName, getWebServices, getWsdlDir, hasManagedBeanByBeanClass, hasMessageDestinationByName, hasWebServices, isApplication, isDDWithNoAnnotationAllowed, isDefaultGroupPrincipalMapping, isFullAttribute, isFullFlag, isPackagedAsSingleModule, isPolicyModified, isStandalone, removeMessageDestination, removeRole, setApplication, setCompatibility, setDefaultGroupPrincipalMapping, setFullAttribute, setFullFlag, setKeepState, setPolicyModified
-
Methods inherited from class org.glassfish.deployment.common.RootDeploymentDescriptor
addExtensionDescriptor, getDisplayName, getExtensionsDescriptors, getExtensionsDescriptors, getExtensionsDescriptors, getMainDescriptor, getModuleDescriptor, getName, getSchemaLocation, getSpecVersion, isExtensionDescriptor, setClassLoader, setDisplayName, setModuleDescriptor, setModuleID, setName, setSchemaLocation, setSpecVersion
-
Methods inherited from class org.glassfish.deployment.common.Descriptor
addDescriptorExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, getDescriptorExtension, getDescriptorExtensions, 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 org.glassfish.deployment.common.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
-
Methods inherited from interface com.sun.enterprise.deployment.JndiNameEnvironment
getAllResourcesDescriptors, getAllResourcesDescriptors, getResourceDescriptors
-
Methods inherited from interface com.sun.enterprise.deployment.WritableJndiNameEnvironment
addResourceDescriptor, removeResourceDescriptor
-
-
-
-
Method Detail
-
createWebBundleDescriptor
public WebBundleDescriptor createWebBundleDescriptor()
-
isExists
protected boolean isExists()
-
addWebBundleDescriptor
public void addWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)
This method will merge the contents of webComponents.- Specified by:
addWebBundleDescriptorin classWebBundleDescriptor- Parameters:
webBundleDescriptor-
-
addDefaultWebBundleDescriptor
public void addDefaultWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)
- Specified by:
addDefaultWebBundleDescriptorin classWebBundleDescriptor
-
addJndiNameEnvironment
public void addJndiNameEnvironment(JndiNameEnvironment env)
- Specified by:
addJndiNameEnvironmentin classWebBundleDescriptor
-
isEmpty
public boolean isEmpty()
Description copied from class:RootDeploymentDescriptorReturn true if this root deployment descriptor does not describe anything- Specified by:
isEmptyin classWebBundleDescriptor- Returns:
- true if this root descriptor is empty
-
getDefaultSpecVersion
public String getDefaultSpecVersion()
- Specified by:
getDefaultSpecVersionin classWebBundleDescriptor- Returns:
- the default version of the deployment descriptor loaded by this descriptor
-
getNamedDescriptors
public Collection getNamedDescriptors()
Return the set of named descriptors that I have.- Specified by:
getNamedDescriptorsin classWebBundleDescriptor- Returns:
-
getNamedReferencePairs
public Vector<NamedReferencePair> getNamedReferencePairs()
Return the state of NamedReferencePairs that I have.- Specified by:
getNamedReferencePairsin classWebBundleDescriptor- Returns:
-
getContextRoot
public String getContextRoot()
return the name of my context root- Specified by:
getContextRootin classWebBundleDescriptor- Returns:
-
setContextRoot
public void setContextRoot(String contextRoot)
Set the name of my context root.- Specified by:
setContextRootin classWebBundleDescriptor
-
getRequestCharacterEncoding
public String getRequestCharacterEncoding()
return the request encoding- Specified by:
getRequestCharacterEncodingin classWebBundleDescriptor
-
setRequestCharacterEncoding
public void setRequestCharacterEncoding(String requestCharacterEncoding)
Set the request encoding- Specified by:
setRequestCharacterEncodingin classWebBundleDescriptor
-
getResponseCharacterEncoding
public String getResponseCharacterEncoding()
return the response encoding- Specified by:
getResponseCharacterEncodingin classWebBundleDescriptor
-
setResponseCharacterEncoding
public void setResponseCharacterEncoding(String responseCharacterEncoding)
Set the response encoding- Specified by:
setResponseCharacterEncodingin classWebBundleDescriptor
-
getWebComponentDescriptors
public Set<WebComponentDescriptor> getWebComponentDescriptors()
Return the Set of Web Component Descriptors (JSP or JavaServlets) in me.- Specified by:
getWebComponentDescriptorsin classWebBundleDescriptor- Returns:
-
addWebComponentDescriptor
public void addWebComponentDescriptor(WebComponentDescriptor webComponentDescriptor)
Adds a new Web Component Descriptor to me.- Specified by:
addWebComponentDescriptorin classWebBundleDescriptor- 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.- Specified by:
combineWebComponentDescriptorin classWebBundleDescriptor- 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.- Specified by:
removeWebComponentDescriptorin classWebBundleDescriptor- Parameters:
webComponentDescriptor-
-
getSessionConfig
public SessionConfig getSessionConfig()
- Specified by:
getSessionConfigin classWebBundleDescriptor
-
setSessionConfig
public void setSessionConfig(SessionConfig sessionConfig)
- Specified by:
setSessionConfigin classWebBundleDescriptor
-
setSessionConfig
public void setSessionConfig(SessionConfigDescriptor sessionConfigDesc)
DeploymentDescriptorNode.addNodeDescriptor(node) need this.- Parameters:
sessionConfigDesc-
-
hasServiceReferenceDescriptors
public boolean hasServiceReferenceDescriptors()
WEB SERVICES REF APIS- Specified by:
hasServiceReferenceDescriptorsin classWebBundleDescriptor- Returns:
-
getServiceReferenceDescriptors
public Set<ServiceReferenceDescriptor> getServiceReferenceDescriptors()
Description copied from interface:JndiNameEnvironmentReturn a set of service reference descriptors.- Specified by:
getServiceReferenceDescriptorsin interfaceJndiNameEnvironment- Specified by:
getServiceReferenceDescriptorsin interfaceServiceReferenceContainer- Specified by:
getServiceReferenceDescriptorsin classWebBundleDescriptor- Returns:
- java.util.Set of ServiceReferenceDescriptor objects
-
addServiceReferenceDescriptor
public void addServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef)
Description copied from interface:WritableJndiNameEnvironmentAdds the specified service reference to the receiver.- Specified by:
addServiceReferenceDescriptorin interfaceServiceReferenceContainer- Specified by:
addServiceReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
addServiceReferenceDescriptorin classWebBundleDescriptor- Parameters:
serviceRef- the ServiceReferenceDescriptor to add.
-
removeServiceReferenceDescriptor
public void removeServiceReferenceDescriptor(ServiceReferenceDescriptor serviceRef)
Description copied from interface:WritableJndiNameEnvironmentRemoves the specified service reference from the receiver.- Specified by:
removeServiceReferenceDescriptorin interfaceServiceReferenceContainer- Specified by:
removeServiceReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
removeServiceReferenceDescriptorin classWebBundleDescriptor- Parameters:
serviceRef- the ServiceReferenceDescriptor to remove.
-
getServiceReferenceByName
public ServiceReferenceDescriptor getServiceReferenceByName(String name)
Looks up an service reference with the given name. Throws an IllegalArgumentException if it is not found.- Specified by:
getServiceReferenceByNamein interfaceJndiNameEnvironment- Specified by:
getServiceReferenceByNamein interfaceServiceReferenceContainer- Specified by:
getServiceReferenceByNamein classWebBundleDescriptor- Parameters:
name-- Returns:
-
_getServiceReferenceByName
protected ServiceReferenceDescriptor _getServiceReferenceByName(String name)
- Specified by:
_getServiceReferenceByNamein classWebBundleDescriptor
-
combineServiceReferenceDescriptors
protected void combineServiceReferenceDescriptors(JndiNameEnvironment env)
- Specified by:
combineServiceReferenceDescriptorsin classWebBundleDescriptor
-
getResourceEnvReferenceDescriptors
public Set<ResourceEnvReferenceDescriptor> getResourceEnvReferenceDescriptors()
Description copied from interface:JndiNameEnvironmentReturn a set of resource environment reference descriptors.- Specified by:
getResourceEnvReferenceDescriptorsin interfaceJndiNameEnvironment- Specified by:
getResourceEnvReferenceDescriptorsin interfaceResourceEnvReferenceContainer- Specified by:
getResourceEnvReferenceDescriptorsin classWebBundleDescriptor- Returns:
- the set of resource environment references this ejb declares.
-
addResourceEnvReferenceDescriptor
public void addResourceEnvReferenceDescriptor(ResourceEnvReferenceDescriptor resourceEnvRefReference)
adds a resource environment reference to the bundle- Specified by:
addResourceEnvReferenceDescriptorin interfaceResourceEnvReferenceContainer- Specified by:
addResourceEnvReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
addResourceEnvReferenceDescriptorin classWebBundleDescriptor- Parameters:
resourceEnvRefReference-
-
removeResourceEnvReferenceDescriptor
public void removeResourceEnvReferenceDescriptor(ResourceEnvReferenceDescriptor resourceEnvRefReference)
removes a existing resource environment reference from the bundle- Specified by:
removeResourceEnvReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
removeResourceEnvReferenceDescriptorin classWebBundleDescriptor- Parameters:
resourceEnvRefReference-
-
getResourceEnvReferenceByName
public ResourceEnvReferenceDescriptor getResourceEnvReferenceByName(String name)
Description copied from interface:JndiNameEnvironmentReturn the resource environment reference descriptor corresponding to the given name.- Specified by:
getResourceEnvReferenceByNamein interfaceJndiNameEnvironment- Specified by:
getResourceEnvReferenceByNamein interfaceResourceEnvReferenceContainer- Specified by:
getResourceEnvReferenceByNamein classWebBundleDescriptor- Parameters:
name-- Returns:
- a resource environment reference by the same name or throw an IllegalArgumentException.
-
_getResourceEnvReferenceByName
protected ResourceEnvReferenceDescriptor _getResourceEnvReferenceByName(String name)
- Specified by:
_getResourceEnvReferenceByNamein classWebBundleDescriptor
-
combineResourceEnvReferenceDescriptors
protected void combineResourceEnvReferenceDescriptors(JndiNameEnvironment env)
- Specified by:
combineResourceEnvReferenceDescriptorsin classWebBundleDescriptor
-
getMimeMappingsSet
public Set<MimeMapping> getMimeMappingsSet()
- Specified by:
getMimeMappingsSetin classWebBundleDescriptor
-
setMimeMappings
public void setMimeMappings(Set<MimeMapping> mimeMappings)
Sets the Set of Mime Mappings for this web application.- Specified by:
setMimeMappingsin classWebBundleDescriptor- Parameters:
mimeMappings-
-
getMimeMappings
public Enumeration<MimeMapping> getMimeMappings()
- Specified by:
getMimeMappingsin classWebBundleDescriptor- Returns:
-
addMimeMapping
public String addMimeMapping(MimeMapping mimeMapping)
- Specified by:
addMimeMappingin classWebBundleDescriptor- Parameters:
mimeMapping- the given mime mapping to my list if the given MimeType is not added return the result MimeType of the MimeMapping in the resulting set of MimeMapping- Returns:
-
addMimeMapping
public String addMimeMapping(MimeMappingDescriptor mimeMapping)
add the given mime mapping to my list.- Parameters:
mimeMapping-- Returns:
-
combineMimeMappings
protected void combineMimeMappings(Set<MimeMapping> mimeMappings)
-
getConflictedMimeMappingExtensions
public Set<String> getConflictedMimeMappingExtensions()
- Specified by:
getConflictedMimeMappingExtensionsin classWebBundleDescriptor
-
getLocaleEncodingMappingListDescriptor
public LocaleEncodingMappingListDescriptor getLocaleEncodingMappingListDescriptor()
- Specified by:
getLocaleEncodingMappingListDescriptorin classWebBundleDescriptor
-
setLocaleEncodingMappingListDescriptor
public void setLocaleEncodingMappingListDescriptor(LocaleEncodingMappingListDescriptor lemListDesc)
- Specified by:
setLocaleEncodingMappingListDescriptorin classWebBundleDescriptor
-
addLocaleEncodingMappingDescriptor
public void addLocaleEncodingMappingDescriptor(LocaleEncodingMappingDescriptor lemDesc)
-
removeMimeMapping
public void removeMimeMapping(MimeMapping mimeMapping)
Removes the given mime mapping from my list.- Specified by:
removeMimeMappingin classWebBundleDescriptor- Parameters:
mimeMapping-
-
getWelcomeFiles
public Enumeration<String> getWelcomeFiles()
Return an enumeration of the welcome files I have..- Specified by:
getWelcomeFilesin classWebBundleDescriptor- Returns:
-
getWelcomeFilesSet
public Set<String> getWelcomeFilesSet()
- Specified by:
getWelcomeFilesSetin classWebBundleDescriptor
-
addWelcomeFile
public void addWelcomeFile(String fileUri)
Adds a new welcome file to my list.- Specified by:
addWelcomeFilein classWebBundleDescriptor- Parameters:
fileUri-
-
removeWelcomeFile
public void removeWelcomeFile(String fileUri)
Removes a welcome file from my list.- Specified by:
removeWelcomeFilein classWebBundleDescriptor- Parameters:
fileUri-
-
setWelcomeFiles
public void setWelcomeFiles(Set<String> welcomeFiles)
Sets the collection of my welcome files.- Specified by:
setWelcomeFilesin classWebBundleDescriptor- Parameters:
welcomeFiles-
-
getErrorPageDescriptorsSet
public Set<ErrorPageDescriptor> getErrorPageDescriptorsSet()
-
getErrorPageDescriptors
public Enumeration<ErrorPageDescriptor> getErrorPageDescriptors()
Returns an enumeration of the error pages I have.- Returns:
-
addErrorPageDescriptor
public void addErrorPageDescriptor(ErrorPageDescriptor errorPageDescriptor)
Adds a new error page to my list.- Parameters:
errorPageDescriptor-
-
removeErrorPageDescriptor
public void removeErrorPageDescriptor(ErrorPageDescriptor errorPageDescriptor)
Removes the given error page from my list.- Parameters:
errorPageDescriptor-
-
getErrorPageDescriptorBySignifier
public ErrorPageDescriptor getErrorPageDescriptorBySignifier(String signifier)
Search my error pages for one with thei given signifier or null if there isn't one.- Parameters:
signifier-- Returns:
-
getContextParametersSet
public Set<ContextParameter> getContextParametersSet()
- Specified by:
getContextParametersSetin classWebBundleDescriptor- Returns:
- the Set of my Context Parameters.
-
getContextParameters
public Enumeration<ContextParameter> getContextParameters()
- Specified by:
getContextParametersin classWebBundleDescriptor- Returns:
- my Context Parameters in an enumeration.
-
addContextParameter
public void addContextParameter(ContextParameter contextParameter)
Adds a new context parameter to my list.- Specified by:
addContextParameterin classWebBundleDescriptor- Parameters:
contextParameter-
-
addContextParameter
public void addContextParameter(EnvironmentProperty contextParameter)
Adds a new context parameter to my list.- Specified by:
addContextParameterin classWebBundleDescriptor- Parameters:
contextParameter-
-
removeContextParameter
public void removeContextParameter(ContextParameter contextParameter)
Removes the given context parameter from my list.- Specified by:
removeContextParameterin classWebBundleDescriptor- Parameters:
contextParameter-
-
isDistributable
public boolean isDistributable()
Return true if this web app [{0}] can be distributed across different processes.- Specified by:
isDistributablein classWebBundleDescriptor- Returns:
-
setDistributable
public void setDistributable(boolean distributable)
Sets whether this web app [{0}] can be distributed across different processes.- Specified by:
setDistributablein classWebBundleDescriptor- Parameters:
distributable-
-
getEjbReferences
public Enumeration<EjbReference> getEjbReferences()
Returns the enumeration of my references to Enterprise Beans.- Specified by:
getEjbReferencesin classWebBundleDescriptor- Returns:
-
getEjbReferenceDescriptors
public Set<EjbReference> getEjbReferenceDescriptors()
Returns the Set of my references to Enterprise Beans.- Specified by:
getEjbReferenceDescriptorsin interfaceEjbReferenceContainer- Specified by:
getEjbReferenceDescriptorsin interfaceJndiNameEnvironment- Specified by:
getEjbReferenceDescriptorsin classWebBundleDescriptor- Returns:
-
getEjbReferenceByName
public EjbReferenceDescriptor getEjbReferenceByName(String name)
- Specified by:
getEjbReferenceByNamein classWebBundleDescriptor- Parameters:
name-- Returns:
- an Enterprise Bean with the matching name or throw.
-
getEjbReference
public EjbReference getEjbReference(String name)
Description copied from interface:EjbReferenceContainerLooks up an ejb reference with the given name. Throws an IllegalArgumentException if it is not found.- Specified by:
getEjbReferencein interfaceEjbReferenceContainer- Specified by:
getEjbReferencein classWebBundleDescriptor
-
_getEjbReference
protected EjbReference _getEjbReference(String name)
- Specified by:
_getEjbReferencein classWebBundleDescriptor
-
getResourceReferenceByName
public ResourceReferenceDescriptor getResourceReferenceByName(String name)
Description copied from interface:ResourceReferenceContainerLooks up a reference to a resource by its name (getName()). Throws an IllegalArgumentException if no such descriptor is found.- Specified by:
getResourceReferenceByNamein interfaceResourceReferenceContainer- Specified by:
getResourceReferenceByNamein classWebBundleDescriptor- Parameters:
name-- Returns:
- a resource reference with the matching name or throw.
-
_getResourceReferenceByName
protected ResourceReferenceDescriptor _getResourceReferenceByName(String name)
- Specified by:
_getResourceReferenceByNamein classWebBundleDescriptor
-
getResourceReferenceDescriptors
public Set<ResourceReferenceDescriptor> getResourceReferenceDescriptors()
Description copied from interface:JndiNameEnvironmentReturn a set of resource reference descriptors.- Specified by:
getResourceReferenceDescriptorsin interfaceJndiNameEnvironment- Specified by:
getResourceReferenceDescriptorsin interfaceResourceReferenceContainer- Specified by:
getResourceReferenceDescriptorsin classWebBundleDescriptor- Returns:
-
getEntityManagerFactoryReferenceDescriptors
public Set<EntityManagerFactoryReferenceDescriptor> getEntityManagerFactoryReferenceDescriptors()
Description copied from interface:JndiNameEnvironmentReturn a set of entity manager factory reference descriptors.- Specified by:
getEntityManagerFactoryReferenceDescriptorsin interfaceJndiNameEnvironment- Specified by:
getEntityManagerFactoryReferenceDescriptorsin classWebBundleDescriptor
-
getEntityManagerFactoryReferenceByName
public EntityManagerFactoryReferenceDescriptor getEntityManagerFactoryReferenceByName(String name)
Return the entity manager factory reference descriptor corresponding to the given name.- Specified by:
getEntityManagerFactoryReferenceByNamein interfaceJndiNameEnvironment- Specified by:
getEntityManagerFactoryReferenceByNamein classWebBundleDescriptor- Parameters:
name-- Returns:
-
_getEntityManagerFactoryReferenceByName
protected EntityManagerFactoryReferenceDescriptor _getEntityManagerFactoryReferenceByName(String name)
- Specified by:
_getEntityManagerFactoryReferenceByNamein classWebBundleDescriptor
-
addEntityManagerFactoryReferenceDescriptor
public void addEntityManagerFactoryReferenceDescriptor(EntityManagerFactoryReferenceDescriptor reference)
- Specified by:
addEntityManagerFactoryReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
addEntityManagerFactoryReferenceDescriptorin classWebBundleDescriptor
-
combineEntityManagerFactoryReferenceDescriptors
protected void combineEntityManagerFactoryReferenceDescriptors(JndiNameEnvironment env)
- Specified by:
combineEntityManagerFactoryReferenceDescriptorsin classWebBundleDescriptor
-
getEntityManagerReferenceDescriptors
public Set<EntityManagerReferenceDescriptor> getEntityManagerReferenceDescriptors()
Description copied from interface:JndiNameEnvironmentReturn a set of entity manager reference descriptors.- Specified by:
getEntityManagerReferenceDescriptorsin interfaceJndiNameEnvironment- Specified by:
getEntityManagerReferenceDescriptorsin classWebBundleDescriptor
-
getEntityManagerReferenceByName
public EntityManagerReferenceDescriptor getEntityManagerReferenceByName(String name)
Return the entity manager factory reference descriptor corresponding to the given name.- Specified by:
getEntityManagerReferenceByNamein interfaceJndiNameEnvironment- Specified by:
getEntityManagerReferenceByNamein classWebBundleDescriptor- Parameters:
name-- Returns:
-
_getEntityManagerReferenceByName
protected EntityManagerReferenceDescriptor _getEntityManagerReferenceByName(String name)
- Specified by:
_getEntityManagerReferenceByNamein classWebBundleDescriptor
-
addEntityManagerReferenceDescriptor
public void addEntityManagerReferenceDescriptor(EntityManagerReferenceDescriptor reference)
- Specified by:
addEntityManagerReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
addEntityManagerReferenceDescriptorin classWebBundleDescriptor
-
combineEntityManagerReferenceDescriptors
protected void combineEntityManagerReferenceDescriptors(JndiNameEnvironment env)
- Specified by:
combineEntityManagerReferenceDescriptorsin classWebBundleDescriptor
-
findReferencedPUs
public 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. - Specified by:
findReferencedPUsin classWebBundleDescriptor- Returns:
- persistence units that are referenced by this module
-
getEnvironmentProperties
public Set<EnvironmentEntry> getEnvironmentProperties()
Return my set of environment properties.- Specified by:
getEnvironmentPropertiesin interfaceJndiNameEnvironment- Specified by:
getEnvironmentPropertiesin classWebBundleDescriptor- Returns:
-
addEjbReferenceDescriptor
public void addEjbReferenceDescriptor(EjbReference ejbReference)
Adds a new reference to an ejb.- Specified by:
addEjbReferenceDescriptorin interfaceEjbReferenceContainer- Specified by:
addEjbReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
addEjbReferenceDescriptorin classWebBundleDescriptor- Parameters:
ejbReference-
-
addEjbReferenceDescriptor
public void addEjbReferenceDescriptor(EjbReferenceDescriptor ejbReferenceDescriptor)
Adds a new reference to an ejb.- Specified by:
addEjbReferenceDescriptorin classWebBundleDescriptor- Parameters:
ejbReferenceDescriptor-
-
removeEjbReferenceDescriptor
public void removeEjbReferenceDescriptor(EjbReferenceDescriptor ejbReferenceDescriptor)
Removes a reference to an ejb.- Specified by:
removeEjbReferenceDescriptorin classWebBundleDescriptor- Parameters:
ejbReferenceDescriptor-
-
removeEjbReferenceDescriptor
public void removeEjbReferenceDescriptor(EjbReference ejbReferenceDescriptor)
Description copied from interface:WritableJndiNameEnvironmentRemoves the specificed ejb reference from the receiver.- Specified by:
removeEjbReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
removeEjbReferenceDescriptorin classWebBundleDescriptor- Parameters:
ejbReferenceDescriptor- the EjbReferenceDescriptor to remove.
-
combineEjbReferenceDescriptors
protected void combineEjbReferenceDescriptors(JndiNameEnvironment env)
- Specified by:
combineEjbReferenceDescriptorsin classWebBundleDescriptor
-
getResourceReferences
public Enumeration<ResourceReferenceDescriptor> getResourceReferences()
Return an enumeration of references to resources that I have.- Specified by:
getResourceReferencesin classWebBundleDescriptor- Returns:
-
addResourceReferenceDescriptor
public void addResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference)
adds a new reference to a resource.- Specified by:
addResourceReferenceDescriptorin interfaceResourceReferenceContainer- Specified by:
addResourceReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
addResourceReferenceDescriptorin classWebBundleDescriptor- Parameters:
resourceReference-
-
removeResourceReferenceDescriptor
public void removeResourceReferenceDescriptor(ResourceReferenceDescriptor resourceReference)
removes a reference to a resource.- Specified by:
removeResourceReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
removeResourceReferenceDescriptorin classWebBundleDescriptor- Parameters:
resourceReference-
-
combineResourceReferenceDescriptors
protected void combineResourceReferenceDescriptors(JndiNameEnvironment env)
- Specified by:
combineResourceReferenceDescriptorsin classWebBundleDescriptor- Parameters:
env-
-
getMessageDestinationReferenceDescriptors
public Set<MessageDestinationReferenceDescriptor> getMessageDestinationReferenceDescriptors()
Description copied from interface:JndiNameEnvironmentReturn a set of message destination reference descriptors.- Specified by:
getMessageDestinationReferenceDescriptorsin interfaceJndiNameEnvironment- Specified by:
getMessageDestinationReferenceDescriptorsin interfaceMessageDestinationReferenceContainer- Specified by:
getMessageDestinationReferenceDescriptorsin classWebBundleDescriptor- Returns:
- java.util.Set of MessageDestinationReferenceDescriptor objects
-
addMessageDestinationReferenceDescriptor
public void addMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor messageDestRef)
Description copied from interface:WritableJndiNameEnvironmentAdds the specified message destination reference to the receiver.- Specified by:
addMessageDestinationReferenceDescriptorin interfaceMessageDestinationReferenceContainer- Specified by:
addMessageDestinationReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
addMessageDestinationReferenceDescriptorin classWebBundleDescriptor- Parameters:
messageDestRef- the MessageDestinationReferenceDescriptor to add.
-
removeMessageDestinationReferenceDescriptor
public void removeMessageDestinationReferenceDescriptor(MessageDestinationReferenceDescriptor msgDestRef)
Description copied from interface:WritableJndiNameEnvironmentRemoves the specified message destination reference from the receiver.- Specified by:
removeMessageDestinationReferenceDescriptorin interfaceMessageDestinationReferenceContainer- Specified by:
removeMessageDestinationReferenceDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
removeMessageDestinationReferenceDescriptorin classWebBundleDescriptor- Parameters:
msgDestRef- MessageDestinationReferenceDescriptor to remove.
-
getMessageDestinationReferenceByName
public MessageDestinationReferenceDescriptor getMessageDestinationReferenceByName(String name)
Looks up an message destination reference with the given name. Throws an IllegalArgumentException if it is not found.- Specified by:
getMessageDestinationReferenceByNamein interfaceJndiNameEnvironment- Specified by:
getMessageDestinationReferenceByNamein interfaceMessageDestinationReferenceContainer- Specified by:
getMessageDestinationReferenceByNamein classWebBundleDescriptor- Parameters:
name-- Returns:
-
_getMessageDestinationReferenceByName
protected MessageDestinationReferenceDescriptor _getMessageDestinationReferenceByName(String name)
- Specified by:
_getMessageDestinationReferenceByNamein classWebBundleDescriptor
-
combineMessageDestinationReferenceDescriptors
protected void combineMessageDestinationReferenceDescriptors(JndiNameEnvironment env)
- Specified by:
combineMessageDestinationReferenceDescriptorsin classWebBundleDescriptor
-
getPostConstructDescriptors
public Set<LifecycleCallbackDescriptor> getPostConstructDescriptors()
Description copied from interface:JndiNameEnvironmentReturn a set of post-construct descriptors.- Specified by:
getPostConstructDescriptorsin interfaceJndiNameEnvironment- Specified by:
getPostConstructDescriptorsin classWebBundleDescriptor- Returns:
- java.util.Set of LifecycleCallbackDescriptor post-construct objects
-
addPostConstructDescriptor
public void addPostConstructDescriptor(LifecycleCallbackDescriptor postConstructDesc)
Description copied from interface:WritableJndiNameEnvironmentAdds the specified post-construct descriptor to the receiver.- Specified by:
addPostConstructDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
addPostConstructDescriptorin classWebBundleDescriptor- Parameters:
postConstructDesc- the post-construct LifecycleCallbackDescriptor to add.
-
getPostConstructDescriptorByClass
public LifecycleCallbackDescriptor getPostConstructDescriptorByClass(String className)
Description copied from interface:JndiNameEnvironmentReturn the post-construct descriptor corresponding to the given name.- Specified by:
getPostConstructDescriptorByClassin interfaceJndiNameEnvironment- Specified by:
getPostConstructDescriptorByClassin classWebBundleDescriptor- Returns:
- LifecycleCallbackDescriptor post-construct object
-
combinePostConstructDescriptors
protected void combinePostConstructDescriptors(WebBundleDescriptor webBundleDescriptor)
- Specified by:
combinePostConstructDescriptorsin classWebBundleDescriptor- Parameters:
webBundleDescriptor-
-
getPreDestroyDescriptors
public Set<LifecycleCallbackDescriptor> getPreDestroyDescriptors()
Description copied from interface:JndiNameEnvironmentReturn a set of pre-destroy descriptors.- Specified by:
getPreDestroyDescriptorsin interfaceJndiNameEnvironment- Specified by:
getPreDestroyDescriptorsin classWebBundleDescriptor- Returns:
- java.util.Set of LifecycleCallbackDescriptor pre-destroy objects
-
addPreDestroyDescriptor
public void addPreDestroyDescriptor(LifecycleCallbackDescriptor preDestroyDesc)
Description copied from interface:WritableJndiNameEnvironmentAdds the specified pre-destroy descriptor to the receiver.- Specified by:
addPreDestroyDescriptorin interfaceWritableJndiNameEnvironment- Specified by:
addPreDestroyDescriptorin classWebBundleDescriptor- Parameters:
preDestroyDesc- the pre-destroy LifecycleCallbackDescriptor to add.
-
getPreDestroyDescriptorByClass
public LifecycleCallbackDescriptor getPreDestroyDescriptorByClass(String className)
Description copied from interface:JndiNameEnvironmentReturn the pre-destroy descriptor corresponding to the given name.- Specified by:
getPreDestroyDescriptorByClassin interfaceJndiNameEnvironment- Specified by:
getPreDestroyDescriptorByClassin classWebBundleDescriptor- Returns:
- LifecycleCallbackDescriptor pre-destroy object
-
combinePreDestroyDescriptors
protected void combinePreDestroyDescriptors(WebBundleDescriptor webBundleDescriptor)
- Specified by:
combinePreDestroyDescriptorsin classWebBundleDescriptor
-
getInjectableResourcesByClass
protected List<InjectionCapable> getInjectableResourcesByClass(String className, JndiNameEnvironment jndiNameEnv)
Description copied from class:BundleDescriptorDefine implementation of getInjectableResourceByClass here so it isn't replicated across appclient, web, ejb descriptors.- Specified by:
getInjectableResourcesByClassin classWebBundleDescriptor
-
getInjectableResourcesByClass
public List<InjectionCapable> getInjectableResourcesByClass(String className)
- Specified by:
getInjectableResourcesByClassin interfaceJndiNameEnvironment- Specified by:
getInjectableResourcesByClassin classWebBundleDescriptor
-
getInjectionInfoByClass
public InjectionInfo getInjectionInfoByClass(Class clazz)
- Specified by:
getInjectionInfoByClassin interfaceJndiNameEnvironment- Specified by:
getInjectionInfoByClassin classWebBundleDescriptor
-
getSecurityRoles
public Enumeration<SecurityRoleDescriptor> getSecurityRoles()
Returns an Enumeration of my SecurityRole objects.- Specified by:
getSecurityRolesin classWebBundleDescriptor- Returns:
-
addSecurityRole
public void addSecurityRole(SecurityRole securityRole)
Add a new abstract role to me.- Specified by:
addSecurityRolein classWebBundleDescriptor- Parameters:
securityRole-
-
addSecurityRole
public void addSecurityRole(SecurityRoleDescriptor securityRole)
Add a new abstract role to me.- Specified by:
addSecurityRolein classWebBundleDescriptor- Parameters:
securityRole-
-
getSecurityRoleReferenceByName
public SecurityRoleReference getSecurityRoleReferenceByName(String compName, String roleName)
Return all the references by a given component (by name) to the given rolename.- Specified by:
getSecurityRoleReferenceByNamein classWebBundleDescriptor- Parameters:
compName-roleName-- Returns:
-
combineSecurityConstraints
protected void combineSecurityConstraints(Set<SecurityConstraint> firstScSet, Set<SecurityConstraint> secondScSet)
- Specified by:
combineSecurityConstraintsin classWebBundleDescriptor
-
getSecurityConstraintsSet
public Set<SecurityConstraint> getSecurityConstraintsSet()
- Specified by:
getSecurityConstraintsSetin classWebBundleDescriptor
-
getSecurityConstraints
public Enumeration<SecurityConstraint> getSecurityConstraints()
My list of security constraints.- Specified by:
getSecurityConstraintsin classWebBundleDescriptor- Returns:
-
getSecurityConstraintsForUrlPattern
public Collection<SecurityConstraint> getSecurityConstraintsForUrlPattern(String urlPattern)
- Specified by:
getSecurityConstraintsForUrlPatternin classWebBundleDescriptor
-
addSecurityConstraint
public void addSecurityConstraint(SecurityConstraint securityConstraint)
Add a new security constraint.- Specified by:
addSecurityConstraintin classWebBundleDescriptor- Parameters:
securityConstraint-
-
addSecurityConstraint
public void addSecurityConstraint(SecurityConstraintImpl securityConstraint)
Add a new security constraint.- Parameters:
securityConstraint-
-
removeSecurityConstraint
public void removeSecurityConstraint(SecurityConstraint securityConstraint)
Remove the given security constraint.- Specified by:
removeSecurityConstraintin classWebBundleDescriptor- Parameters:
securityConstraint-
-
getJspConfigDescriptor
public JspConfigDescriptorImpl getJspConfigDescriptor()
-
setJspConfigDescriptor
public void setJspConfigDescriptor(JspConfigDescriptorImpl jspC)
-
getServletDescriptors
public Set<WebComponentDescriptor> getServletDescriptors()
- Specified by:
getServletDescriptorsin classWebBundleDescriptor
-
getJspDescriptors
public Set<WebComponentDescriptor> getJspDescriptors()
- Specified by:
getJspDescriptorsin classWebBundleDescriptor- Returns:
- my Set of jsps.
-
getEnvironmentEntrySet
public Set<EnvironmentEntry> getEnvironmentEntrySet()
- Specified by:
getEnvironmentEntrySetin classWebBundleDescriptor
-
getEnvironmentEntries
public Enumeration<EnvironmentEntry> getEnvironmentEntries()
Return my set of environment properties.- Specified by:
getEnvironmentEntriesin classWebBundleDescriptor- Returns:
-
addEnvironmentEntry
public void addEnvironmentEntry(EnvironmentEntry environmentEntry)
Adds this given environment property to my list.- Specified by:
addEnvironmentEntryin classWebBundleDescriptor- Parameters:
environmentEntry-
-
_getEnvironmentPropertyByName
protected EnvironmentProperty _getEnvironmentPropertyByName(String name)
- Specified by:
_getEnvironmentPropertyByNamein classWebBundleDescriptor
-
getEnvironmentPropertyByName
public EnvironmentProperty getEnvironmentPropertyByName(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:
getEnvironmentPropertyByNamein interfaceJndiNameEnvironment- Specified by:
getEnvironmentPropertyByNamein classWebBundleDescriptor- Parameters:
name-- Returns:
-
removeEnvironmentProperty
public void removeEnvironmentProperty(EnvironmentProperty environmentProperty)
Removes this given environment property from my list.- Specified by:
removeEnvironmentPropertyin interfaceWritableJndiNameEnvironment- Specified by:
removeEnvironmentPropertyin classWebBundleDescriptor- Parameters:
environmentProperty-
-
addEnvironmentProperty
public void addEnvironmentProperty(EnvironmentProperty environmentProperty)
Adds this given environment property to my list.- Specified by:
addEnvironmentPropertyin interfaceWritableJndiNameEnvironment- Specified by:
addEnvironmentPropertyin classWebBundleDescriptor- Parameters:
environmentProperty-
-
removeEnvironmentEntry
public void removeEnvironmentEntry(EnvironmentEntry environmentEntry)
Removes this given environment property from my list.- Specified by:
removeEnvironmentEntryin classWebBundleDescriptor- Parameters:
environmentEntry-
-
combineEnvironmentEntries
protected void combineEnvironmentEntries(JndiNameEnvironment env)
- Specified by:
combineEnvironmentEntriesin classWebBundleDescriptor
-
getLoginConfiguration
public LoginConfiguration getLoginConfiguration()
Return the information about how I should log in.- Specified by:
getLoginConfigurationin classWebBundleDescriptor- Returns:
-
setLoginConfiguration
public void setLoginConfiguration(LoginConfiguration loginConfiguration)
Specifies the information about how I should log in.- Specified by:
setLoginConfigurationin classWebBundleDescriptor- Parameters:
loginConfiguration-
-
setLoginConfiguration
public void setLoginConfiguration(LoginConfigurationImpl loginConfiguration)
-
combineLoginConfiguration
protected void combineLoginConfiguration(WebBundleDescriptor webBundleDescriptor)
- Specified by:
combineLoginConfigurationin classWebBundleDescriptor
-
getWebComponentByName
public WebComponentDescriptor getWebComponentByName(String name)
Search for a web component that I have by name.- Specified by:
getWebComponentByNamein classWebBundleDescriptor- Parameters:
name-- Returns:
-
getWebComponentByCanonicalName
public WebComponentDescriptor getWebComponentByCanonicalName(String name)
Search for a web component that I have by name.- Specified by:
getWebComponentByCanonicalNamein classWebBundleDescriptor- Parameters:
name-- Returns:
-
getWebComponentByImplName
public WebComponentDescriptor[] getWebComponentByImplName(String name)
- Specified by:
getWebComponentByImplNamein classWebBundleDescriptor- Returns:
- a set of web component descriptor of given impl name.
-
getServletFilters
public Vector<ServletFilter> getServletFilters()
- Specified by:
getServletFiltersin classWebBundleDescriptor- Returns:
- a Vector of servlet filters that I have.
-
getServletFilterDescriptors
public Vector<ServletFilter> getServletFilterDescriptors()
- Specified by:
getServletFilterDescriptorsin classWebBundleDescriptor- Returns:
- a Vector of servlet filters that I have.
-
addServletFilter
public void addServletFilter(ServletFilter ref)
Adds a servlet filter to this web component.- Specified by:
addServletFilterin classWebBundleDescriptor- Parameters:
ref-
-
addServletFilter
public void addServletFilter(ServletFilterDescriptor ref)
-
removeServletFilter
public void removeServletFilter(ServletFilter ref)
Removes the given servlet filter from this web component.- Specified by:
removeServletFilterin classWebBundleDescriptor- Parameters:
ref-
-
combineServletFilters
protected void combineServletFilters(WebBundleDescriptor webBundleDescriptor)
- Specified by:
combineServletFiltersin classWebBundleDescriptor
-
getServletFilterMappings
public Vector<ServletFilterMapping> getServletFilterMappings()
Return a Vector of servlet filters that I have.- Specified by:
getServletFilterMappingsin classWebBundleDescriptor- Returns:
-
getServletFilterMappingDescriptors
public Vector<ServletFilterMapping> getServletFilterMappingDescriptors()
Return a Vector of servlet filter mappings that I have.- Specified by:
getServletFilterMappingDescriptorsin classWebBundleDescriptor- Returns:
-
addServletFilterMapping
public void addServletFilterMapping(ServletFilterMapping ref)
Adds a servlet filter mapping to this web component.- Specified by:
addServletFilterMappingin classWebBundleDescriptor- Parameters:
ref-
-
addServletFilterMapping
public void addServletFilterMapping(ServletFilterMappingDescriptor ref)
Adds a servlet filter mapping to this web component.- Parameters:
ref-
-
removeServletFilterMapping
public void removeServletFilterMapping(ServletFilterMapping ref)
Removes the given servlet filter mapping from this web component.- Specified by:
removeServletFilterMappingin classWebBundleDescriptor- Parameters:
ref-
-
moveServletFilterMapping
public void moveServletFilterMapping(ServletFilterMapping ref, int relPos)
* Moves the given servlet filter mapping to a new relative location in * the list- Specified by:
moveServletFilterMappingin classWebBundleDescriptor- Parameters:
ref-relPos-
-
combineServletFilterMappings
protected void combineServletFilterMappings(WebBundleDescriptor webBundleDescriptor)
- Specified by:
combineServletFilterMappingsin classWebBundleDescriptor
-
getAppListeners
public Vector<AppListenerDescriptor> getAppListeners()
- Specified by:
getAppListenersin classWebBundleDescriptor
-
getAppListenerDescriptors
public Vector<AppListenerDescriptor> getAppListenerDescriptors()
- Specified by:
getAppListenerDescriptorsin classWebBundleDescriptor
-
setAppListeners
public void setAppListeners(Collection<? extends AppListenerDescriptor> c)
- Specified by:
setAppListenersin classWebBundleDescriptor
-
addAppListenerDescriptor
public void addAppListenerDescriptor(AppListenerDescriptor ref)
- Specified by:
addAppListenerDescriptorin classWebBundleDescriptor
-
addAppListenerDescriptorToFirst
public void addAppListenerDescriptorToFirst(AppListenerDescriptor ref)
- Specified by:
addAppListenerDescriptorToFirstin classWebBundleDescriptor
-
addAppListenerDescriptor
public void addAppListenerDescriptor(AppListenerDescriptorImpl ref)
-
removeAppListenerDescriptor
public void removeAppListenerDescriptor(AppListenerDescriptor ref)
- Specified by:
removeAppListenerDescriptorin classWebBundleDescriptor
-
moveAppListenerDescriptor
public void moveAppListenerDescriptor(AppListenerDescriptor ref, int relPos)
- Specified by:
moveAppListenerDescriptorin classWebBundleDescriptor
-
getAbsoluteOrderingDescriptor
public AbsoluteOrderingDescriptor getAbsoluteOrderingDescriptor()
-
setAbsoluteOrderingDescriptor
public void setAbsoluteOrderingDescriptor(AbsoluteOrderingDescriptor absOrdering)
-
isDenyUncoveredHttpMethods
public boolean isDenyUncoveredHttpMethods()
- Specified by:
isDenyUncoveredHttpMethodsin classWebBundleDescriptor
-
setDenyUncoveredHttpMethods
public void setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)
-
isShowArchivedRealPathEnabled
public boolean isShowArchivedRealPathEnabled()
- Specified by:
isShowArchivedRealPathEnabledin classWebBundleDescriptor
-
setShowArchivedRealPathEnabled
public void setShowArchivedRealPathEnabled(boolean enabled)
- Specified by:
setShowArchivedRealPathEnabledin classWebBundleDescriptor- Parameters:
enabled-
-
getServletReloadCheckSecs
public int getServletReloadCheckSecs()
- Specified by:
getServletReloadCheckSecsin classWebBundleDescriptor
-
setServletReloadCheckSecs
public void setServletReloadCheckSecs(int secs)
- Specified by:
setServletReloadCheckSecsin classWebBundleDescriptor
-
hasWebServiceClients
public boolean hasWebServiceClients()
- Specified by:
hasWebServiceClientsin classWebBundleDescriptor- Returns:
- true if this bundle descriptor defines web service clients
-
removeVectorItem
protected boolean removeVectorItem(Vector<? extends Object> list, Object ref)
remove a specific object from the given list (does not rely on 'equals')- Specified by:
removeVectorItemin classWebBundleDescriptor- Parameters:
list-ref-- Returns:
-
moveVectorItem
protected void moveVectorItem(Vector list, Object ref, int rpos)
Moves the given object to a new relative location in the specified list- Specified by:
moveVectorItemin classWebBundleDescriptor- Parameters:
list-ref-rpos-
-
visit
public void visit(DescriptorVisitor aVisitor)
visitor API implementation- Overrides:
visitin classDescriptor- Parameters:
aVisitor- the visitor implementation
-
visit
public void visit(ComponentVisitor aVisitor)
visitor API implementation- Overrides:
visitin classBundleDescriptor- Parameters:
aVisitor-
-
putJarNameWebFragmentNamePair
public void putJarNameWebFragmentNamePair(String jarName, String webFragName)
- Specified by:
putJarNameWebFragmentNamePairin classWebBundleDescriptor- Parameters:
jarName-webFragName-
-
getJarNameToWebFragmentNameMap
public Map<String,String> getJarNameToWebFragmentNameMap()
This method return an unmodifiable version of jarName2WebFragNameMap.- Specified by:
getJarNameToWebFragmentNameMapin classWebBundleDescriptor- Returns:
- unmodifiable version of jarName2WebFragNameMap
-
getUrlPatternToServletNameMap
public Map<String,String> getUrlPatternToServletNameMap()
This method is used by WebComponentDescriptor only. The returned map is supposed to be only modified by the corresponding url patterns set.- Specified by:
getUrlPatternToServletNameMapin classWebBundleDescriptor- Returns:
-
resetUrlPatternToServletNameMap
public void resetUrlPatternToServletNameMap()
- Specified by:
resetUrlPatternToServletNameMapin classWebBundleDescriptor
-
getOrderedLibs
public List<String> getOrderedLibs()
- Specified by:
getOrderedLibsin classWebBundleDescriptor
-
addOrderedLib
public void addOrderedLib(String libName)
- Specified by:
addOrderedLibin classWebBundleDescriptor
-
combineInjectionTargets
protected void combineInjectionTargets(EnvironmentProperty env1, EnvironmentProperty env2)
This method will copy the injection targets from env2 to env1.- Specified by:
combineInjectionTargetsin classWebBundleDescriptor- Parameters:
env1-env2-
-
print
public void print(StringBuilder toStringBuilder)
Return a formatted version as a String.- Overrides:
printin classBundleDescriptor
-
printCommon
public void printCommon(StringBuilder toStringBuilder)
- Specified by:
printCommonin classWebBundleDescriptor- Parameters:
toStringBuilder-
-
getModuleType
public ArchiveType getModuleType()
- Specified by:
getModuleTypein classWebBundleDescriptor- Returns:
- the module type for this bundle descriptor
-
getBundleVisitor
public ComponentVisitor getBundleVisitor()
- Specified by:
getBundleVisitorin classWebBundleDescriptor- Returns:
- the visitor for this bundle descriptor
-
getTracerVisitor
public DescriptorVisitor getTracerVisitor()
- Specified by:
getTracerVisitorin classWebBundleDescriptor- Returns:
- the tracer visitor for this descriptor
-
getDeploymentDescriptorDir
public String getDeploymentDescriptorDir()
- Specified by:
getDeploymentDescriptorDirin classWebBundleDescriptor- 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.- Specified by:
getSunDescriptorin classWebBundleDescriptor- 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.- Specified by:
setSunDescriptorin classWebBundleDescriptor- Parameters:
webApp- SunWebApp object representation of web deployment descriptor
-
setExtensionProperty
public void setExtensionProperty(String key, String value)
This property can be used to indicate special processing. For example, a Deployer may set this property.- Specified by:
setExtensionPropertyin classWebBundleDescriptor- Parameters:
key-value-
-
hasExtensionProperty
public boolean hasExtensionProperty(String key)
Determine if an extension property has been set.- Specified by:
hasExtensionPropertyin classWebBundleDescriptor- Parameters:
key-- Returns:
-
getServletInitializersEnabled
public boolean getServletInitializersEnabled()
- Specified by:
getServletInitializersEnabledin classWebBundleDescriptor
-
setServletInitializersEnabled
public void setServletInitializersEnabled(boolean tf)
- Specified by:
setServletInitializersEnabledin classWebBundleDescriptor
-
isJaxrsRolesAllowedEnabled
public boolean isJaxrsRolesAllowedEnabled()
- Specified by:
isJaxrsRolesAllowedEnabledin classWebBundleDescriptor
-
setJaxrsRolesAllowedEnabled
public void setJaxrsRolesAllowedEnabled(boolean jaxrsRolesAllowedEnabled)
- Specified by:
setJaxrsRolesAllowedEnabledin classWebBundleDescriptor
-
getAppContextId
public String getAppContextId()
- Specified by:
getAppContextIdin classWebBundleDescriptor
-
setAppContextId
public void setAppContextId(String appContextId)
- Specified by:
setAppContextIdin classWebBundleDescriptor
-
combineResourceDescriptors
protected void combineResourceDescriptors(JndiNameEnvironment env, JavaEEResourceType javaEEResourceType)
- Specified by:
combineResourceDescriptorsin classWebBundleDescriptor
-
-