Grizzly NIO 5.0.2 · org.glassfish.grizzly.servlet.ServletRegistration

Modifier and Type	Field and Description
protected ExpectationHandler	expectationHandler
protected boolean	isAsyncSupported
protected int	loadOnStartup
private String	runAs The run-as identity for this servlet.
protected Servlet	servlet
protected Class<? extends Servlet>	servletClass
protected final ArraySet<String>	urlPatterns

Access	Constructor and Description
protected	ServletRegistration(final WebappContext the owning `WebappContext`. ctx, final String the name of the Filter. name, final String the fully qualified class name of the `Servlet` implementation. servletClassName) Creates a new ServletRegistration associated with the specified `WebappContext`.
protected	ServletRegistration(final WebappContext the owning `WebappContext`. ctx, final String the name of the Filter. name, final Servlet the `Servlet` instance. servlet) Creates a new ServletRegistration associated with the specified `WebappContext`.
protected	ServletRegistration(final WebappContext the owning `WebappContext`. ctx, final String the name of the Filter. name, final Class<? extends Servlet> the class of the `Servlet` implementation. servletClass) Creates a new ServletRegistration associated with the specified `WebappContext`.

Method Summary

Modifier and Type	Method and Description
public Set<String>	Returns: the (possibly empty) Set of URL patterns that are already mapped to a different Servlet addMapping(String... the URL patterns of the servlet mapping urlPatterns) Implements jakarta.servlet.ServletRegistration.addMapping. Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.
public int	compareTo(ServletRegistration o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public ExpectationHandler	Returns: the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue"). getExpectationHandler() Get the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue").
public Collection<String>	Returns: a (possibly empty) `Collection` of the currently available mappings of the Servlet represented by this `ServletRegistration` getMappings() Implements jakarta.servlet.ServletRegistration.getMappings. Gets the currently available mappings of the Servlet represented by this `ServletRegistration`.
public String	getRunAsRole() Implements jakarta.servlet.ServletRegistration.getRunAsRole. Gets the name of the runAs role of the Servlet represented by this `ServletRegistration`.
public void	setAsyncSupported(boolean isAsyncSupported) Implements jakarta.servlet.Registration.Dynamic.setAsyncSupported. Configures the Servlet or Filter represented by this dynamic Registration as supporting asynchronous operations or not.
public void	setExpectationHandler(ExpectationHandler the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue"). expectationHandler) Set the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue").
public void	setLoadOnStartup(int the initialization priority of the Servlet loadOnStartup) Implements jakarta.servlet.ServletRegistration.Dynamic.setLoadOnStartup. Sets the `loadOnStartup` priority on the Servlet represented by this dynamic ServletRegistration.
public void	setMultipartConfig(MultipartConfigElement multipartConfig) Implements jakarta.servlet.ServletRegistration.Dynamic.setMultipartConfig. Sets the `MultipartConfigElement` to be applied to the mappings defined for this `ServletRegistration`.
public void	setRunAsRole(String roleName) Implements jakarta.servlet.ServletRegistration.Dynamic.setRunAsRole. Sets the name of the `runAs` role for this `ServletRegistration`.
public Set<String>	setServletSecurity(ServletSecurityElement constraint) Implements jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity. Sets the `ServletSecurityElement` to be applied to the mappings defined for this `ServletRegistration`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.glassfish.grizzly.servlet.Registration:: equals getClassName getInitParameter getInitParameters getName hashCode setInitParameter setInitParameters

expectationHandler	back to summary
protected ExpectationHandler expectationHandler

isAsyncSupported	back to summary
protected boolean isAsyncSupported

loadOnStartup	back to summary
protected int loadOnStartup

runAs	back to summary
private String runAs The run-as identity for this servlet.

servlet	back to summary
protected Servlet servlet

servletClass	back to summary
protected Class<? extends Servlet> servletClass

urlPatterns	back to summary
protected final ArraySet<String> urlPatterns

ServletRegistration	back to summary
protected ServletRegistration(final WebappContext ctx, final String name, final String servletClassName) Creates a new ServletRegistration associated with the specified `WebappContext`. Parameters ctx:WebappContext the owning `WebappContext`. name:String the name of the Filter. servletClassName:String the fully qualified class name of the `Servlet` implementation.

ServletRegistration	back to summary
protected ServletRegistration(final WebappContext ctx, final String name, final Servlet servlet) Creates a new ServletRegistration associated with the specified `WebappContext`. Parameters ctx:WebappContext the owning `WebappContext`. name:String the name of the Filter. servlet:Servlet the `Servlet` instance.

ServletRegistration	back to summary
protected ServletRegistration(final WebappContext ctx, final String name, final Class<? extends Servlet> servletClass) Creates a new ServletRegistration associated with the specified `WebappContext`. Parameters ctx:WebappContext the owning `WebappContext`. name:String the name of the Filter. servletClass:Class<? extends Servlet> the class of the `Servlet` implementation.

Method Detail

addMapping back to summary

addMapping	back to summary
public Set<String> addMapping(String... urlPatterns) Implements jakarta.servlet.ServletRegistration.addMapping. Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration. If any of the specified URL patterns are already mapped to a different Servlet, no updates will be performed. If this method is called multiple times, each successive call adds to the effects of the former. Parameters urlPatterns:String[] the URL patterns of the servlet mapping Returns:Set<String> the (possibly empty) Set of URL patterns that are already mapped to a different Servlet Annotations @Override Exceptions IllegalArgumentException: if `urlPatterns` is null or empty IllegalStateException: if the ServletContext from which this ServletRegistration was obtained has already been initialized

public Set<String> addMapping(String... urlPatterns)

Implements jakarta.servlet.ServletRegistration.addMapping.

Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.

If any of the specified URL patterns are already mapped to a different Servlet, no updates will be performed.

If this method is called multiple times, each successive call adds to the effects of the former.

Parameters

urlPatterns:String[]: the URL patterns of the servlet mapping

Returns:Set<String>

the (possibly empty) Set of URL patterns that are already mapped to a different Servlet

Annotations

@Override

Exceptions

IllegalArgumentException:: if urlPatterns is null or empty
IllegalStateException:: if the ServletContext from which this ServletRegistration was obtained has already been initialized

compareTo back to summary

compareTo	back to summary
public int compareTo(ServletRegistration o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override

public int compareTo(ServletRegistration o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

getExpectationHandler back to summary

getExpectationHandler	back to summary
public ExpectationHandler getExpectationHandler() Get the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue"). Returns:ExpectationHandler the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue").

public ExpectationHandler getExpectationHandler()

Get the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").

Returns:ExpectationHandler: the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").

getMappings back to summary

getMappings	back to summary
public Collection<String> getMappings() Implements jakarta.servlet.ServletRegistration.getMappings. Gets the currently available mappings of the Servlet represented by this `ServletRegistration`. If permitted, any changes to the returned `Collection` must not affect this `ServletRegistration`. Returns:Collection<String> a (possibly empty) `Collection` of the currently available mappings of the Servlet represented by this `ServletRegistration` Annotations @Override

public Collection<String> getMappings()

Implements jakarta.servlet.ServletRegistration.getMappings.

Gets the currently available mappings of the Servlet represented by this ServletRegistration.

If permitted, any changes to the returned Collection must not affect this ServletRegistration.

Returns:Collection<String>

a (possibly empty) Collection of the currently available mappings of the Servlet represented by this ServletRegistration

Annotations

@Override

getRunAsRole back to summary

getRunAsRole	back to summary
public String getRunAsRole() Implements jakarta.servlet.ServletRegistration.getRunAsRole. Doc from jakarta.servlet.ServletRegistration.getRunAsRole. Gets the name of the runAs role of the Servlet represented by this `ServletRegistration`. Annotations @Override

public String getRunAsRole()

Implements jakarta.servlet.ServletRegistration.getRunAsRole.

Doc from jakarta.servlet.ServletRegistration.getRunAsRole.

Gets the name of the runAs role of the Servlet represented by this ServletRegistration.

Annotations

@Override

setAsyncSupported	back to summary
public void setAsyncSupported(boolean isAsyncSupported) Implements jakarta.servlet.Registration.Dynamic.setAsyncSupported. Doc from jakarta.servlet.Registration.Dynamic.setAsyncSupported. Configures the Servlet or Filter represented by this dynamic Registration as supporting asynchronous operations or not. By default, servlet and filters do not support asynchronous operations. A call to this method overrides any previous setting. Annotations @Override

setAsyncSupported

back to summary

public void setAsyncSupported(boolean isAsyncSupported)

Implements jakarta.servlet.Registration.Dynamic.setAsyncSupported.

Doc from jakarta.servlet.Registration.Dynamic.setAsyncSupported.

Configures the Servlet or Filter represented by this dynamic Registration as supporting asynchronous operations or not.

By default, servlet and filters do not support asynchronous operations.

A call to this method overrides any previous setting.

Annotations

@Override

setExpectationHandler back to summary

setExpectationHandler	back to summary
public void setExpectationHandler(ExpectationHandler expectationHandler) Set the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue"). Parameters expectationHandler:ExpectationHandler the `ExpectationHandler` responsible for processing `Expect:` header (for example "Expect: 100-Continue").

public void setExpectationHandler(ExpectationHandler expectationHandler)

Set the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").

Parameters

expectationHandler:ExpectationHandler: the ExpectationHandler responsible for processing Expect: header (for example "Expect: 100-Continue").

setLoadOnStartup back to summary

setLoadOnStartup	back to summary
public void setLoadOnStartup(int loadOnStartup) Implements jakarta.servlet.ServletRegistration.Dynamic.setLoadOnStartup. Sets the `loadOnStartup` priority on the Servlet represented by this dynamic ServletRegistration. A `loadOnStartup` value of greater than or equal to zero indicates to the container the initialization priority of the Servlet. In this case, the container must instantiate and initialize the Servlet during the initialization phase of the WebappContext, that is, after it has invoked all of the ServletContextListener objects configured for the WebappContext at their `jakarta.servlet.ServletContextListener#contextInitialized` method. If `loadOnStartup` is a negative integer, the container is free to instantiate and initialize the Servlet lazily. The default value for `loadOnStartup` is `-1`. A call to this method overrides any previous setting. Parameters loadOnStartup:int the initialization priority of the Servlet Annotations @Override Exceptions IllegalStateException: if the ServletContext from which this ServletRegistration was obtained has already been initialized

public void setLoadOnStartup(int loadOnStartup)

Implements jakarta.servlet.ServletRegistration.Dynamic.setLoadOnStartup.

Sets the loadOnStartup priority on the Servlet represented by this dynamic ServletRegistration.

A loadOnStartup value of greater than or equal to zero indicates to the container the initialization priority of the Servlet. In this case, the container must instantiate and initialize the Servlet during the initialization phase of the WebappContext, that is, after it has invoked all of the ServletContextListener objects configured for the WebappContext at their jakarta.servlet.ServletContextListener#contextInitialized method.

If loadOnStartup is a negative integer, the container is free to instantiate and initialize the Servlet lazily.

The default value for loadOnStartup is -1.

A call to this method overrides any previous setting.

Parameters

loadOnStartup:int: the initialization priority of the Servlet

Annotations

@Override

Exceptions

IllegalStateException:: if the ServletContext from which this ServletRegistration was obtained has already been initialized

setMultipartConfig back to summary

setMultipartConfig	back to summary
public void setMultipartConfig(MultipartConfigElement multipartConfig) Implements jakarta.servlet.ServletRegistration.Dynamic.setMultipartConfig. Doc from jakarta.servlet.ServletRegistration.Dynamic.setMultipartConfig. Sets the `MultipartConfigElement` to be applied to the mappings defined for this `ServletRegistration`. If this method is called multiple times, each successive call overrides the effects of the former. Annotations @Override

public void setMultipartConfig(MultipartConfigElement multipartConfig)

Implements jakarta.servlet.ServletRegistration.Dynamic.setMultipartConfig.

Doc from jakarta.servlet.ServletRegistration.Dynamic.setMultipartConfig.

Sets the MultipartConfigElement to be applied to the mappings defined for this ServletRegistration. If this method is called multiple times, each successive call overrides the effects of the former.

Annotations

@Override

setRunAsRole back to summary

setRunAsRole	back to summary
public void setRunAsRole(String roleName) Implements jakarta.servlet.ServletRegistration.Dynamic.setRunAsRole. Doc from jakarta.servlet.ServletRegistration.Dynamic.setRunAsRole. Sets the name of the `runAs` role for this `ServletRegistration`. Annotations @Override

public void setRunAsRole(String roleName)

Implements jakarta.servlet.ServletRegistration.Dynamic.setRunAsRole.

Doc from jakarta.servlet.ServletRegistration.Dynamic.setRunAsRole.

Sets the name of the runAs role for this ServletRegistration.

Annotations

@Override

setServletSecurity back to summary

setServletSecurity	back to summary
public Set<String> setServletSecurity(ServletSecurityElement constraint) Implements jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity. Doc from jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity. Sets the `ServletSecurityElement` to be applied to the mappings defined for this `ServletRegistration`. This method applies to all mappings added to this `ServletRegistration` up until the point that the `ServletContext` from which it was obtained has been initialized. If a URL pattern of this ServletRegistration is an exact target of a `security-constraint` that was established via the portable deployment descriptor, then this method does not change the `security-constraint` for that pattern, and the pattern will be included in the return value. If a URL pattern of this ServletRegistration is an exact target of a security constraint that was established via the `jakarta.servlet.annotation.ServletSecurity` annotation or a previous call to this method, then this method replaces the security constraint for that pattern. If a URL pattern of this ServletRegistration is neither the exact target of a security constraint that was established via the `jakarta.servlet.annotation.ServletSecurity` annotation or a previous call to this method, nor the exact target of a `security-constraint` in the portable deployment descriptor, then this method establishes the security constraint for that pattern from the argument `ServletSecurityElement`. The returned set is not backed by the `Dynamic` object, so changes in the returned set are not reflected in the `Dynamic` object, and vice-versa. Annotations @Override

public Set<String> setServletSecurity(ServletSecurityElement constraint)

Implements jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity.

Doc from jakarta.servlet.ServletRegistration.Dynamic.setServletSecurity.

Sets the ServletSecurityElement to be applied to the mappings defined for this ServletRegistration.

This method applies to all mappings added to this ServletRegistration up until the point that the ServletContext from which it was obtained has been initialized.

If a URL pattern of this ServletRegistration is an exact target of a security-constraint that was established via the portable deployment descriptor, then this method does not change the security-constraint for that pattern, and the pattern will be included in the return value.

If a URL pattern of this ServletRegistration is an exact target of a security constraint that was established via the jakarta.servlet.annotation.ServletSecurity annotation or a previous call to this method, then this method replaces the security constraint for that pattern.

If a URL pattern of this ServletRegistration is neither the exact target of a security constraint that was established via the jakarta.servlet.annotation.ServletSecurity annotation or a previous call to this method, nor the exact target of a security-constraint in the portable deployment descriptor, then this method establishes the security constraint for that pattern from the argument ServletSecurityElement.

The returned set is not backed by the Dynamic object, so changes in the returned set are not reflected in the Dynamic object, and vice-versa.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class ServletRegistration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail