Class WebComponentDescriptorImpl
- java.lang.Object
-
- java.util.Observable
-
- org.glassfish.deployment.common.DynamicAttributesDescriptor
-
- org.glassfish.deployment.common.Descriptor
-
- com.sun.enterprise.deployment.WebComponentDescriptor
-
- org.glassfish.web.deployment.descriptor.WebComponentDescriptorImpl
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
WebComponentDescriptorStub
public class WebComponentDescriptorImpl extends WebComponentDescriptor
Common data and behavior of the deployment information about a JSP or JavaServlet in J2EE.- Author:
- Jerome Dochez
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
BASIC_AUTHENTICATION
Constant for Basic authentication.static String
DELETE
Constant for the http DELETE method.static String
FORM_AUTHENTICATION
Constant for Form authentication.static String
GET
Constant for the htpp GET method.static String
POST
Constant for the http POST method.static String
PUT
Constant for the http PUT method.static String
SSL_AUTHENTICATION
Constant for Secure authentication.-
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 WebComponentDescriptorImpl()
The default constructor.WebComponentDescriptorImpl(WebComponentDescriptor other)
The copy constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(WebComponentDescriptor other)
void
add(WebComponentDescriptor other, boolean combineUrlPatterns, boolean combineConflict)
this method will combine the information from this "other" // WebComponentDescriptor with current WebComponentDescriptor // // when there are conflicts between the contents of the two, // the value from current WebComponentDescriptor will override // the value in "other" // // Note: in the Set API, we only add value when such value // is not existed in the Set already // // If combineUrlPatterns is false, then the first one take priority, // otherwise take the second one.void
addInitializationParameter(InitializationParameter initializationParameter)
Adds a servlet initialization parameter to this component.void
addSecurityRoleReference(SecurityRoleReference securityRoleReference)
Adds a security role reference to this web component.void
addUrlPattern(String urlPattern)
Adds an alias to this web component.boolean
equals(Object other)
Application
getApplication()
String
getCanonicalName()
The canonical name for the web component.Set<String>
getConflictedInitParameterNames()
InitializationParameter
getInitializationParameterByName(String name)
Enumeration<InitializationParameter>
getInitializationParameters()
Set<InitializationParameter>
getInitializationParameterSet()
Integer
getLoadOnStartUp()
MultipartConfig
getMultipartConfig()
RunAsIdentityDescriptor
getRunAsIdentity()
Gets the run-as of the referee EJB.SecurityRoleReference
getSecurityRoleReferenceByName(String roleReferenceName)
Enumeration<SecurityRoleReference>
getSecurityRoleReferences()
Set<SecurityRoleReference>
getSecurityRoleReferenceSet()
Enumeration<String>
getUrlPatterns()
Set<String>
getUrlPatternsSet()
Method[]
getUserDefinedHttpMethods()
This method return an array of user defined http doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace methods.boolean
getUsesCallerIdentity()
WebBundleDescriptor
getWebBundleDescriptor()
String
getWebComponentImplementation()
int
hashCode()
Boolean
isAsyncSupported()
boolean
isConflict()
boolean
isConflict(WebComponentDescriptor other, boolean allowNullImplNameOverride)
boolean
isEnabled()
boolean
isServlet()
void
print(StringBuilder toStringBuilder)
A formatted string representing my state.void
removeInitializationParameter(InitializationParameter initializationParameter)
Removes the given servlet initialization parameter from this component.void
removeSecurityRoleReference(SecurityRoleReference securityRoleReference)
Removes the given security role reference from this web component.void
removeUrlPattern(String urlPattern)
Removes a URL pattern from this web component.void
setAsyncSupported(Boolean asyncSupported)
void
setCanonicalName(String canonicalName)
Sets the canonical name of this web component.void
setConflict(boolean conflict)
void
setEnabled(boolean enabled)
void
setLoadOnStartUp(Integer loadOnStartUp)
Sets the order on which this component will be loaded by the web server.void
setLoadOnStartUp(String loadOnStartUp)
Sets the order on which this component will be loaded by the web server.void
setMultipartConfig(MultipartConfig multipartConfig)
void
setMultipartConfig(MultipartConfigDescriptor multipartConfigDesc)
DeploymentDescriptorNode.addNodeDescriptor(node) need this.void
setRunAsIdentity(RunAsIdentityDescriptor runAs)
Sets the run-as of the referee EJB.void
setServlet(boolean isServlet)
void
setUsesCallerIdentity(boolean isCallerID)
void
setWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)
void
setWebComponentImplementation(String implFile)
sets the implementation file for this web component, the implementation file is either a servlet class name of a jsp file name.-
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, 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
-
-
-
-
Field Detail
-
BASIC_AUTHENTICATION
public static final String BASIC_AUTHENTICATION
Constant for Basic authentication.- See Also:
- Constant Field Values
-
FORM_AUTHENTICATION
public static final String FORM_AUTHENTICATION
Constant for Form authentication.- See Also:
- Constant Field Values
-
SSL_AUTHENTICATION
public static final String SSL_AUTHENTICATION
Constant for Secure authentication.- See Also:
- Constant Field Values
-
GET
public static final String GET
Constant for the htpp GET method.- See Also:
- Constant Field Values
-
PUT
public static final String PUT
Constant for the http PUT method.- See Also:
- Constant Field Values
-
POST
public static final String POST
Constant for the http POST method.- See Also:
- Constant Field Values
-
DELETE
public static final String DELETE
Constant for the http DELETE method.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WebComponentDescriptorImpl
public WebComponentDescriptorImpl()
The default constructor.
-
WebComponentDescriptorImpl
public WebComponentDescriptorImpl(WebComponentDescriptor other)
The copy constructor.
-
-
Method Detail
-
getInitializationParameterSet
public Set<InitializationParameter> getInitializationParameterSet()
- Specified by:
getInitializationParameterSet
in classWebComponentDescriptor
-
getInitializationParameters
public Enumeration<InitializationParameter> getInitializationParameters()
- Specified by:
getInitializationParameters
in classWebComponentDescriptor
- Returns:
- the Set of servlet initialization parameters.
-
getInitializationParameterByName
public InitializationParameter getInitializationParameterByName(String name)
- Specified by:
getInitializationParameterByName
in classWebComponentDescriptor
- Parameters:
name
-- Returns:
- a matching initialization parameter by its name if there is one.
-
addInitializationParameter
public void addInitializationParameter(InitializationParameter initializationParameter)
Adds a servlet initialization parameter to this component.- Specified by:
addInitializationParameter
in classWebComponentDescriptor
- Parameters:
initializationParameter
-
-
removeInitializationParameter
public void removeInitializationParameter(InitializationParameter initializationParameter)
Removes the given servlet initialization parameter from this component.- Specified by:
removeInitializationParameter
in classWebComponentDescriptor
- Parameters:
initializationParameter
-
-
getConflictedInitParameterNames
public Set<String> getConflictedInitParameterNames()
- Specified by:
getConflictedInitParameterNames
in classWebComponentDescriptor
-
getUrlPatternsSet
public Set<String> getUrlPatternsSet()
- Specified by:
getUrlPatternsSet
in classWebComponentDescriptor
- Returns:
- the set of URL pattern aliases for this component.
-
getUrlPatterns
public Enumeration<String> getUrlPatterns()
- Specified by:
getUrlPatterns
in classWebComponentDescriptor
- Returns:
- an enumeration of (String) URL pattern aliases for this component.
-
addUrlPattern
public void addUrlPattern(String urlPattern)
Adds an alias to this web component.- Specified by:
addUrlPattern
in classWebComponentDescriptor
- Parameters:
urlPattern
-
-
removeUrlPattern
public void removeUrlPattern(String urlPattern)
Removes a URL pattern from this web component.- Specified by:
removeUrlPattern
in classWebComponentDescriptor
- Parameters:
urlPattern
-
-
setWebBundleDescriptor
public void setWebBundleDescriptor(WebBundleDescriptor webBundleDescriptor)
- Specified by:
setWebBundleDescriptor
in classWebComponentDescriptor
-
getWebBundleDescriptor
public WebBundleDescriptor getWebBundleDescriptor()
- Specified by:
getWebBundleDescriptor
in classWebComponentDescriptor
- Returns:
- the web app object to which this object belongs
-
getCanonicalName
public String getCanonicalName()
The canonical name for the web component.- Specified by:
getCanonicalName
in classWebComponentDescriptor
- Returns:
-
setCanonicalName
public void setCanonicalName(String canonicalName)
Sets the canonical name of this web component.- Specified by:
setCanonicalName
in classWebComponentDescriptor
- Parameters:
canonicalName
-
-
getLoadOnStartUp
public Integer getLoadOnStartUp()
- Specified by:
getLoadOnStartUp
in classWebComponentDescriptor
- Returns:
- the order on which this component will be loaded by the web server.
-
setLoadOnStartUp
public void setLoadOnStartUp(Integer loadOnStartUp)
Sets the order on which this component will be loaded by the web server.- Specified by:
setLoadOnStartUp
in classWebComponentDescriptor
- Parameters:
loadOnStartUp
-
-
setLoadOnStartUp
public void setLoadOnStartUp(String loadOnStartUp) throws NumberFormatException
Sets the order on which this component will be loaded by the web server.- Specified by:
setLoadOnStartUp
in classWebComponentDescriptor
- Parameters:
loadOnStartUp
-- Throws:
NumberFormatException
-
getSecurityRoleReferenceSet
public Set<SecurityRoleReference> getSecurityRoleReferenceSet()
- Specified by:
getSecurityRoleReferenceSet
in classWebComponentDescriptor
-
getSecurityRoleReferences
public Enumeration<SecurityRoleReference> getSecurityRoleReferences()
- Specified by:
getSecurityRoleReferences
in classWebComponentDescriptor
- Returns:
- the Set of security role references that I have.
-
getSecurityRoleReferenceByName
public SecurityRoleReference getSecurityRoleReferenceByName(String roleReferenceName)
- Specified by:
getSecurityRoleReferenceByName
in classWebComponentDescriptor
- Parameters:
roleReferenceName
-- Returns:
- a matching role reference by name or null if there is none matching.
-
addSecurityRoleReference
public void addSecurityRoleReference(SecurityRoleReference securityRoleReference)
Adds a security role reference to this web component.- Specified by:
addSecurityRoleReference
in classWebComponentDescriptor
- Parameters:
securityRoleReference
-
-
removeSecurityRoleReference
public void removeSecurityRoleReference(SecurityRoleReference securityRoleReference)
Removes the given security role reference from this web component.- Specified by:
removeSecurityRoleReference
in classWebComponentDescriptor
- Parameters:
securityRoleReference
-
-
setRunAsIdentity
public void setRunAsIdentity(RunAsIdentityDescriptor runAs)
Sets the run-as of the referee EJB.- Specified by:
setRunAsIdentity
in classWebComponentDescriptor
- Parameters:
runAs
- the value of run-as
-
getRunAsIdentity
public RunAsIdentityDescriptor getRunAsIdentity()
Gets the run-as of the referee EJB.- Specified by:
getRunAsIdentity
in classWebComponentDescriptor
- Returns:
- the value of run-as.
-
getUsesCallerIdentity
public boolean getUsesCallerIdentity()
- Specified by:
getUsesCallerIdentity
in classWebComponentDescriptor
-
setUsesCallerIdentity
public void setUsesCallerIdentity(boolean isCallerID)
- Specified by:
setUsesCallerIdentity
in classWebComponentDescriptor
-
getMultipartConfig
public MultipartConfig getMultipartConfig()
- Specified by:
getMultipartConfig
in classWebComponentDescriptor
-
setMultipartConfig
public void setMultipartConfig(MultipartConfig multipartConfig)
- Specified by:
setMultipartConfig
in classWebComponentDescriptor
-
setMultipartConfig
public void setMultipartConfig(MultipartConfigDescriptor multipartConfigDesc)
DeploymentDescriptorNode.addNodeDescriptor(node) need this.- Parameters:
multipartConfigDesc
-
-
getApplication
public Application getApplication()
- Specified by:
getApplication
in classWebComponentDescriptor
-
setWebComponentImplementation
public void setWebComponentImplementation(String implFile)
sets the implementation file for this web component, the implementation file is either a servlet class name of a jsp file name.- Specified by:
setWebComponentImplementation
in classWebComponentDescriptor
- Parameters:
implFile
- the servlet class name or the jsp file
-
getWebComponentImplementation
public String getWebComponentImplementation()
- Specified by:
getWebComponentImplementation
in classWebComponentDescriptor
-
isServlet
public boolean isServlet()
- Specified by:
isServlet
in classWebComponentDescriptor
-
setServlet
public void setServlet(boolean isServlet)
- Specified by:
setServlet
in classWebComponentDescriptor
-
isEnabled
public boolean isEnabled()
- Specified by:
isEnabled
in classWebComponentDescriptor
-
setEnabled
public void setEnabled(boolean enabled)
- Specified by:
setEnabled
in classWebComponentDescriptor
-
setAsyncSupported
public void setAsyncSupported(Boolean asyncSupported)
- Specified by:
setAsyncSupported
in classWebComponentDescriptor
-
isAsyncSupported
public Boolean isAsyncSupported()
- Specified by:
isAsyncSupported
in classWebComponentDescriptor
-
setConflict
public void setConflict(boolean conflict)
- Specified by:
setConflict
in classWebComponentDescriptor
-
isConflict
public boolean isConflict()
- Specified by:
isConflict
in classWebComponentDescriptor
-
getUserDefinedHttpMethods
public Method[] getUserDefinedHttpMethods()
This method return an array of user defined http doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace methods. It is used for processing web security annotations.- Specified by:
getUserDefinedHttpMethods
in classWebComponentDescriptor
- Returns:
- an array of methods.
-
print
public void print(StringBuilder toStringBuilder)
A formatted string representing my state.- Overrides:
print
in classDescriptor
- Parameters:
toStringBuilder
-
-
equals
public boolean equals(Object other)
- Specified by:
equals
in classWebComponentDescriptor
-
hashCode
public int hashCode()
- Specified by:
hashCode
in classWebComponentDescriptor
-
add
public void add(WebComponentDescriptor other)
- Specified by:
add
in classWebComponentDescriptor
-
add
public void add(WebComponentDescriptor other, boolean combineUrlPatterns, boolean combineConflict)
this method will combine the information from this "other" // WebComponentDescriptor with current WebComponentDescriptor // // when there are conflicts between the contents of the two, // the value from current WebComponentDescriptor will override // the value in "other" // // Note: in the Set API, we only add value when such value // is not existed in the Set already // // If combineUrlPatterns is false, then the first one take priority, // otherwise take the second one. // // If combineConflict is true, it will combine the init parameter // conflict information in #getConflictedInitParameterSet. // // And the conflict boolean will not be set.- Specified by:
add
in classWebComponentDescriptor
- Parameters:
other
-combineUrlPatterns
-combineConflict
-
-
isConflict
public boolean isConflict(WebComponentDescriptor other, boolean allowNullImplNameOverride)
- Specified by:
isConflict
in classWebComponentDescriptor
-
-