Package org.jolokia.server.core.osgi

Class OsgiAgentServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

org.jolokia.server.core.http.AgentServlet

org.jolokia.server.core.osgi.OsgiAgentServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public class OsgiAgentServlet
extends AgentServlet

Extended here for the sole purpose of exporting this servlet to the outside in order that it can be instantiated from another bundle. This service also tracks the availability of a log service in order redirect the servlet logging to the log service (if available). Otherwise it uses the servlet's logging facility as fallback.

Since:

10.02.11

Author:

roland

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OsgiAgentServlet()	Constructor with an empty context
OsgiAgentServlet(org.osgi.framework.BundleContext pContext)	Constructor which associates this servlet with a bundle context
OsgiAgentServlet(org.osgi.framework.BundleContext pContext, Restrictor pRestrictor)	Constructor with a bundle context and a given restrictor

Method Summary

Modifier and Type	Method	Description
protected LogHandler	createLogHandler(jakarta.servlet.ServletConfig pServletConfig, Configuration pConfiguration)	Create a log handler which tracks a LogService and, if available, use the log service for logging, in the other time uses the servlet's default logging facility
void	destroy()
protected ServerDetectorLookup	getServerDetectorLookup()	Get an OSGi based lookup mechanism for finding all detectors available during
void	init(jakarta.servlet.ServletConfig pServletConfig)	Initialize the backend systems by creating a JolokiaServiceManager A subclass can tune this step by overriding AgentServlet.createLogHandler(jakarta.servlet.ServletConfig, org.jolokia.server.core.config.Configuration), AgentServlet.createRestrictor(org.jolokia.server.core.config.Configuration, org.jolokia.server.core.service.api.LogHandler) and AgentServlet.createConfig(jakarta.servlet.ServletConfig)
protected void	initServices(jakarta.servlet.ServletConfig pServletConfig, JolokiaServiceManager pServiceManager)	Initialize the service manager and add an OSGi based lookup mechanism

Methods inherited from class org.jolokia.server.core.http.AgentServlet

createConfig, createRestrictor, doGet, doOptions, doPost

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doPut, doTrace, getLastModified, service, service

Methods inherited from class jakarta.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OsgiAgentServlet

public OsgiAgentServlet()

Constructor with an empty context

OsgiAgentServlet

public OsgiAgentServlet(org.osgi.framework.BundleContext pContext)

Constructor which associates this servlet with a bundle context

Parameters:

pContext - bundle context to associate with

OsgiAgentServlet

public OsgiAgentServlet(org.osgi.framework.BundleContext pContext,
 Restrictor pRestrictor)

Constructor with a bundle context and a given restrictor

Parameters:

pContext - associated bundle context

pRestrictor - restrictor to use or null if the default lookup mechanism should be used

Method Details

init

public void init(jakarta.servlet.ServletConfig pServletConfig)
          throws jakarta.servlet.ServletException

Initialize the backend systems by creating a JolokiaServiceManager A subclass can tune this step by overriding AgentServlet.createLogHandler(jakarta.servlet.ServletConfig, org.jolokia.server.core.config.Configuration), AgentServlet.createRestrictor(org.jolokia.server.core.config.Configuration, org.jolokia.server.core.service.api.LogHandler) and AgentServlet.createConfig(jakarta.servlet.ServletConfig)

Specified by:

init in interface jakarta.servlet.Servlet

Overrides:

init in class AgentServlet

Parameters:

pServletConfig - servlet configuration

Throws:

jakarta.servlet.ServletException

getServerDetectorLookup

protected ServerDetectorLookup getServerDetectorLookup()

Get an OSGi based lookup mechanism for finding all detectors available during

Overrides:

getServerDetectorLookup in class AgentServlet

Returns:

lookup instance

createLogHandler

protected LogHandler createLogHandler(jakarta.servlet.ServletConfig pServletConfig,
 Configuration pConfiguration)

Create a log handler which tracks a LogService and, if available, use the log service for logging, in the other time uses the servlet's default logging facility

Overrides:

createLogHandler in class AgentServlet

Parameters:

pServletConfig - servlet configuration

pConfiguration - configuration which contains information like a log class handler or whether to to do debugging

Returns:

a default log handler

initServices

protected void initServices(jakarta.servlet.ServletConfig pServletConfig,
 JolokiaServiceManager pServiceManager)

Initialize the service manager and add an OSGi based lookup mechanism

Overrides:

initServices in class AgentServlet

Parameters:

pServletConfig - servlet configuration

pServiceManager - service manager to which to add services

destroy

public void destroy()

Specified by:

destroy in interface jakarta.servlet.Servlet

Overrides:

destroy in class AgentServlet