Package org.glassfish.web.deployment.descriptor

Class ServletFilterDescriptor

java.lang.Object

java.util.Observable

org.glassfish.deployment.common.DynamicAttributesDescriptor

org.glassfish.deployment.common.Descriptor

org.glassfish.web.deployment.descriptor.ServletFilterDescriptor

All Implemented Interfaces:

ServletFilter, Serializable

public class ServletFilterDescriptor
extends Descriptor
implements ServletFilter

Deployment object representing the servlet filter spec

Author:

Martin D. Flynn

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
ServletFilterDescriptor()	generic constructor
ServletFilterDescriptor(String className, String name)	constructor specifying descriptor name (Filter name) & displayName

Method Summary

Modifier and Type	Method	Description
void	addInitializationParameter(EnvironmentProperty ref)
void	addInitializationParameter(InitializationParameter ref)
boolean	equals(Object obj)	compare equals
String	getClassName()	get class name
String	getDisplayName()	get display name
Vector<InitializationParameter>	getInitializationParameters()
String	getName()	get filter name
int	hashCode()
boolean	hasSetDisplayName()
Boolean	isAsyncSupported()
boolean	isConflict()
boolean	isConflict(ServletFilterDescriptor other)
void	removeInitializationParameter(InitializationParameter ref)
void	setAsyncSupported(Boolean asyncSupported)
void	setClassName(String name)	set class name
void	setConflict(boolean conflict)
void	setDisplayName(String name)	set display name
void	setInitializationParameters(Collection<InitializationParameter> c)
void	setName(String filterName)	set filter name

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, print, setBoundsChecking, setDescription, setLargeIconUri, setLocalizedDescription, setLocalizedDisplayName, setLocalizedLargeIconUri, setLocalizedSmallIconUri, 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

Methods inherited from interface com.sun.enterprise.deployment.web.ServletFilter

getDescription, getLargeIconUri, getSmallIconUri, setDescription, setLargeIconUri, setSmallIconUri

Constructor Detail

ServletFilterDescriptor

public ServletFilterDescriptor()

generic constructor

ServletFilterDescriptor

public ServletFilterDescriptor(String className,
                               String name)

constructor specifying descriptor name (Filter name) & displayName

Method Detail

setClassName

public void setClassName(String name)

set class name

Specified by:

setClassName in interface ServletFilter

getClassName

public String getClassName()

get class name

Specified by:

getClassName in interface ServletFilter

setDisplayName

public void setDisplayName(String name)

set display name

Specified by:

setDisplayName in interface ServletFilter

Overrides:

setDisplayName in class Descriptor

Parameters:

name - the display name

getDisplayName

public String getDisplayName()

get display name

Specified by:

getDisplayName in interface ServletFilter

Overrides:

getDisplayName in class Descriptor

Returns:

the display name

hasSetDisplayName

public boolean hasSetDisplayName()

setName

public void setName(String filterName)

set filter name

Specified by:

setName in interface ServletFilter

Overrides:

setName in class Descriptor

Parameters:

filterName - the new name of the descriptor.

getName

public String getName()

get filter name

Specified by:

getName in interface ServletFilter

Overrides:

getName in class Descriptor

Returns:

the name of this descriptor

setInitializationParameters

public void setInitializationParameters(Collection<InitializationParameter> c)

Specified by:

setInitializationParameters in interface ServletFilter

getInitializationParameters

public Vector<InitializationParameter> getInitializationParameters()

Specified by:

getInitializationParameters in interface ServletFilter

addInitializationParameter

public void addInitializationParameter(InitializationParameter ref)

Specified by:

addInitializationParameter in interface ServletFilter

addInitializationParameter

public void addInitializationParameter(EnvironmentProperty ref)

removeInitializationParameter

public void removeInitializationParameter(InitializationParameter ref)

Specified by:

removeInitializationParameter in interface ServletFilter

setAsyncSupported

public void setAsyncSupported(Boolean asyncSupported)

Specified by:

setAsyncSupported in interface ServletFilter

isAsyncSupported

public Boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface ServletFilter

setConflict

public void setConflict(boolean conflict)

isConflict

public boolean isConflict()

isConflict

public boolean isConflict(ServletFilterDescriptor other)

equals

public boolean equals(Object obj)

compare equals

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object