Package com.sun.enterprise.deployment

Class WebComponentDescriptor

java.lang.Object

java.util.Observable

org.glassfish.deployment.common.DynamicAttributesDescriptor

org.glassfish.deployment.common.Descriptor

com.sun.enterprise.deployment.WebComponentDescriptor

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

WebComponentDescriptorImpl

public abstract class WebComponentDescriptor
extends Descriptor

Common data and behavior of the deployment information about a JSP or JavaServlet in EE.

Author:

Jerome Dochez

See Also:

Serialized Form

Field Summary

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
WebComponentDescriptor()

Method Summary

Modifier and Type	Method	Description
abstract void	add(WebComponentDescriptor other)
abstract void	add(WebComponentDescriptor other, boolean combineUrlPatterns, boolean combineConflict)
abstract void	addInitializationParameter(InitializationParameter initializationParameter)
abstract void	addSecurityRoleReference(SecurityRoleReference securityRoleReference)
abstract void	addUrlPattern(String urlPattern)
abstract boolean	equals(Object other)
abstract Application	getApplication()
abstract String	getCanonicalName()
abstract Set<String>	getConflictedInitParameterNames()
abstract InitializationParameter	getInitializationParameterByName(String name)
abstract Enumeration<InitializationParameter>	getInitializationParameters()
abstract Set<InitializationParameter>	getInitializationParameterSet()
abstract Integer	getLoadOnStartUp()
abstract MultipartConfig	getMultipartConfig()
abstract RunAsIdentityDescriptor	getRunAsIdentity()
abstract SecurityRoleReference	getSecurityRoleReferenceByName(String roleReferenceName)
abstract Enumeration<SecurityRoleReference>	getSecurityRoleReferences()
abstract Set<SecurityRoleReference>	getSecurityRoleReferenceSet()
abstract Enumeration<String>	getUrlPatterns()
abstract Set<String>	getUrlPatternsSet()
abstract Method[]	getUserDefinedHttpMethods()
abstract boolean	getUsesCallerIdentity()
abstract WebBundleDescriptor	getWebBundleDescriptor()
abstract String	getWebComponentImplementation()
abstract int	hashCode()
abstract Boolean	isAsyncSupported()
abstract boolean	isConflict()
abstract boolean	isConflict(WebComponentDescriptor other, boolean allowNullImplNameOverride)
abstract boolean	isEnabled()
abstract boolean	isServlet()
abstract void	removeInitializationParameter(InitializationParameter initializationParameter)
abstract void	removeSecurityRoleReference(SecurityRoleReference securityRoleReference)
abstract void	removeUrlPattern(String urlPattern)
abstract void	setAsyncSupported(Boolean asyncSupported)
abstract void	setCanonicalName(String canonicalName)
abstract void	setConflict(boolean conflict)
abstract void	setEnabled(boolean enabled)
abstract void	setLoadOnStartUp(Integer loadOnStartUp)
abstract void	setLoadOnStartUp(String loadOnStartUp)
abstract void	setMultipartConfig(MultipartConfig multipartConfig)
abstract void	setRunAsIdentity(RunAsIdentityDescriptor runAs)
abstract void	setServlet(boolean isServlet)
abstract void	setUsesCallerIdentity(boolean isCallerID)
abstract void	setWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)
abstract void	setWebComponentImplementation(String implFile)

Methods inherited from class org.glassfish.deployment.common.Descriptor

addDescriptorExtension, addPrefixMapping, createUniqueFilenameAmongst, createUniqueNameAmongst, createUniqueNameAmongstNamedDescriptors, fillDocType, getDeploymentExtensions, getDescription, getDescriptorExtension, getDescriptorExtensions, getDisplayName, getDocType, getLargeIconUri, getLocalizedDescription, getLocalizedDescriptions, getLocalizedDisplayName, getLocalizedDisplayNames, getLocalizedLargeIconUri, getLocalizedLargeIconUris, getLocalizedSmallIconUri, getLocalizedSmallIconUris, getName, getPrefixMapping, getSmallIconUri, isBoundsChecking, print, setBoundsChecking, setDescription, setDisplayName, setLargeIconUri, setLocalizedDescription, setLocalizedDisplayName, setLocalizedLargeIconUri, setLocalizedSmallIconUri, setName, setSmallIconUri, visit

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebComponentDescriptor

public WebComponentDescriptor()

Method Detail

getInitializationParameterSet

public abstract Set<InitializationParameter> getInitializationParameterSet()

getInitializationParameters

public abstract Enumeration<InitializationParameter> getInitializationParameters()

getInitializationParameterByName

public abstract InitializationParameter getInitializationParameterByName(String name)

addInitializationParameter

public abstract void addInitializationParameter(InitializationParameter initializationParameter)

removeInitializationParameter

public abstract void removeInitializationParameter(InitializationParameter initializationParameter)

getUrlPatternsSet

public abstract Set<String> getUrlPatternsSet()

getUrlPatterns

public abstract Enumeration<String> getUrlPatterns()

addUrlPattern

public abstract void addUrlPattern(String urlPattern)

removeUrlPattern

public abstract void removeUrlPattern(String urlPattern)

setWebBundleDescriptor

public abstract void setWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)

getWebBundleDescriptor

public abstract WebBundleDescriptor getWebBundleDescriptor()

getCanonicalName

public abstract String getCanonicalName()

setCanonicalName

public abstract void setCanonicalName(String canonicalName)

getLoadOnStartUp

public abstract Integer getLoadOnStartUp()

setLoadOnStartUp

public abstract void setLoadOnStartUp(Integer loadOnStartUp)

setLoadOnStartUp

public abstract void setLoadOnStartUp(String loadOnStartUp)
                               throws NumberFormatException

Throws:

NumberFormatException

getSecurityRoleReferenceSet

public abstract Set<SecurityRoleReference> getSecurityRoleReferenceSet()

getSecurityRoleReferences

public abstract Enumeration<SecurityRoleReference> getSecurityRoleReferences()

getSecurityRoleReferenceByName

public abstract SecurityRoleReference getSecurityRoleReferenceByName(String roleReferenceName)

addSecurityRoleReference

public abstract void addSecurityRoleReference(SecurityRoleReference securityRoleReference)

removeSecurityRoleReference

public abstract void removeSecurityRoleReference(SecurityRoleReference securityRoleReference)

setRunAsIdentity

public abstract void setRunAsIdentity(RunAsIdentityDescriptor runAs)

getRunAsIdentity

public abstract RunAsIdentityDescriptor getRunAsIdentity()

getUsesCallerIdentity

public abstract boolean getUsesCallerIdentity()

setUsesCallerIdentity

public abstract void setUsesCallerIdentity(boolean isCallerID)

getMultipartConfig

public abstract MultipartConfig getMultipartConfig()

setMultipartConfig

public abstract void setMultipartConfig(MultipartConfig multipartConfig)

getApplication

public abstract Application getApplication()

setWebComponentImplementation

public abstract void setWebComponentImplementation(String implFile)

getWebComponentImplementation

public abstract String getWebComponentImplementation()

isServlet

public abstract boolean isServlet()

setServlet

public abstract void setServlet(boolean isServlet)

isEnabled

public abstract boolean isEnabled()

setEnabled

public abstract void setEnabled(boolean enabled)

setAsyncSupported

public abstract void setAsyncSupported(Boolean asyncSupported)

isAsyncSupported

public abstract Boolean isAsyncSupported()

setConflict

public abstract void setConflict(boolean conflict)

isConflict

public abstract boolean isConflict()

getUserDefinedHttpMethods

public abstract Method[] getUserDefinedHttpMethods()

equals

public abstract boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

add

public abstract void add(WebComponentDescriptor other)

add

public abstract void add(WebComponentDescriptor other,
                         boolean combineUrlPatterns,
                         boolean combineConflict)

isConflict

public abstract boolean isConflict(WebComponentDescriptor other,
                                   boolean allowNullImplNameOverride)

getConflictedInitParameterNames

public abstract Set<String> getConflictedInitParameterNames()