Class AbstractServiceReferenceConfig

  extended by


public abstract class AbstractServiceReferenceConfig
extends Object

The AbstractServiceReferenceConfig may be used as a base class to define ServletConfig and FilterConfig instances from OSGi ServiceReference objects. The properties of this service reference are used as the initialization parameters of the configuration object.

The name of the servlet or filter may be retrieved from the service reference by calling the static getName(ServiceReference) method. This method looks for the following service reference properties, assuming the first non-null value found:

  1. sling.core.servletName - A service registration property which may be set to define an independent servlet name.
  2. - The name of the Declarative Services component if the OSGi service is registered using Declarative Services.
  3. - The Service PID of the service.
  4. - The ID of the service as set by the OSGi framework service registry. This property is guaranteed to always be set by the OSGi specification.

Constructor Summary
AbstractServiceReferenceConfig(javax.servlet.ServletContext servletContext, org.osgi.framework.ServiceReference reference, String name)
          Deprecated. Sets up this base configuration object.
Method Summary
 String getInitParameter(String name)
 Enumeration<?> getInitParameterNames()
protected  String getName()
          Deprecated. Returns the name of this configuration object.
static String getName(org.osgi.framework.ServiceReference reference)
          Deprecated. Looks for a name value in the service reference properties.
 javax.servlet.ServletContext getServletContext()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public AbstractServiceReferenceConfig(javax.servlet.ServletContext servletContext,
                                      org.osgi.framework.ServiceReference reference,
                                      String name)
Sets up this base configuration object.

servletContext - The ServletContext attached to this configuration.
reference - The service reference providing the initialization parameter values.
name - The name of this configuration.
See Also:
Method Detail


public String getInitParameter(String name)


public Enumeration<?> getInitParameterNames()


public javax.servlet.ServletContext getServletContext()


protected String getName()
Returns the name of this configuration object. Implementations may use this value to implement the ServletConfig.getServletName() or FilterConfig.getFilterName() methods.


public static String getName(org.osgi.framework.ServiceReference reference)
Looks for a name value in the service reference properties. See the class comment at the top for the list of properties checked by this method.

Copyright © 2007-2011 The Apache Software Foundation. All Rights Reserved.