Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'bundles/org.eclipse.osgi.services/src/org/osgi/service/http/runtime/dto/FilterDTO.java')
-rw-r--r--bundles/org.eclipse.osgi.services/src/org/osgi/service/http/runtime/dto/FilterDTO.java40
1 files changed, 21 insertions, 19 deletions
diff --git a/bundles/org.eclipse.osgi.services/src/org/osgi/service/http/runtime/dto/FilterDTO.java b/bundles/org.eclipse.osgi.services/src/org/osgi/service/http/runtime/dto/FilterDTO.java
index 88adede63..d9df0a9aa 100644
--- a/bundles/org.eclipse.osgi.services/src/org/osgi/service/http/runtime/dto/FilterDTO.java
+++ b/bundles/org.eclipse.osgi.services/src/org/osgi/service/http/runtime/dto/FilterDTO.java
@@ -20,15 +20,15 @@ import java.util.Map;
import org.osgi.dto.DTO;
/**
- * Represents a servlet {@code javax.servlet.Filter} filter currently being used
- * for a servlet context.
+ * Represents a servlet {@code javax.servlet.Filter} service currently being
+ * used for by a servlet context.
*
* @NotThreadSafe
* @author $Id$
*/
public class FilterDTO extends DTO {
/**
- * The name of the servlet filter.
+ * The name of the servlet filter. This field is never {@code null}.
*/
public String name;
@@ -36,8 +36,8 @@ public class FilterDTO extends DTO {
* The request mappings for the servlet filter.
*
* <p>
- * The specified patterns are used to determine whether a request is
- * mapped to the servlet filter.
+ * The specified patterns are used to determine whether a request is mapped
+ * to the servlet filter. This array might be empty.
*/
public String[] patterns;
@@ -45,8 +45,8 @@ public class FilterDTO extends DTO {
* The servlet names for the servlet filter.
*
* <p>
- * The specified names are used to determine the servlets whose requests
- * are mapped to the servlet filter.
+ * The specified names are used to determine the servlets whose requests are
+ * mapped to the servlet filter. This array might be empty.
*/
public String[] servletNames;
@@ -55,7 +55,7 @@ public class FilterDTO extends DTO {
*
* <p>
* The specified regular expressions are used to determine whether a request
- * is mapped to the servlet filter.
+ * is mapped to the servlet filter. This array might be empty.
*/
public String[] regexs;
@@ -69,29 +69,31 @@ public class FilterDTO extends DTO {
*
* <p>
* The specified names are used to determine in what occasions the servlet
- * filter is called
+ * filter is called. This array is never {@code null}.
*/
public String[] dispatcher;
/**
- * The filter initialization parameters as provided during registration
- * of the filter. Additional parameters like the Http Service Runtime
- * attributes are not included.
+ * The servlet filter initialization parameters as provided during
+ * registration of the servlet filter. Additional parameters like the Http
+ * Service Runtime attributes are not included. If the servlet filter has
+ * not initialization parameters, this map is empty.
*/
public Map<String, String> initParams;
/**
- * Service property identifying the filter. In the case of a filter registered
- * in the service registry and picked up by a whiteboard implementation, this value
- * is not negative and corresponds to the service id in the registry.
- * If the filter has not been registered in the service registry, the value
- * is negative and a unique negative value is generated by the Http Service Runtime
- * in this case.
+ * Service property identifying the servlet filter. In the case of a servlet
+ * filter registered in the service registry and picked up by a Http
+ * Whiteboard Implementation, this value is not negative and corresponds to
+ * the service id in the registry. If the servlet filter has not been
+ * registered in the service registry, the value is negative and a unique
+ * negative value is generated by the Http Service Runtime in this case.
*/
public long serviceId;
/**
- * The service id of the {@code ServletContext} for the servlet filter.
+ * The service id of the servlet context for the servlet filter represented
+ * by this DTO.
*/
public long servletContextId;
}

Back to the top