com.ibm.portal.portlet.service.siteanalyzer
Interface PortletSiteAnalyzerLoggingServiceHome

All Superinterfaces:
PortletService

public interface PortletSiteAnalyzerLoggingServiceHome
extends PortletService

Portlet service for JSR compliant portlets to leverage the portlet-level site analytics capabilities of IBM WebSphere Portal.

The following sample shows how to perform the JNDI lookup to acquire a service object:

 com.ibm.portal.portlet.service.PortletServiceHome psh;
 javax.naming.Context ctx = new javax.naming.InitialContext();
 
 try {
        psh = (PortletServiceHome) ctx
                        .lookup(PortletSiteAnalyzerLoggingServiceHome.JNDI_NAME);
 } catch (javax.naming.NameNotFoundException ex) {
        // error handling
 }
 
 // obtain the service object 
 PortletSiteAnalyzerLoggingServiceHome saLogServiceHome = (PortletSiteAnalyzerLoggingServiceHome) psh
                .getPortletService(PortletSiteAnalyzerLoggingServiceHome.class);
 

Since:
6.1.0.1

Field Summary
static java.lang.String JNDI_NAME
          Name that can be used for the JNDI lookup of this service
 
Method Summary
 PortletSiteAnalyzerLogger getLogger(ActionRequest req, ActionResponse resp)
          Returns a logger that logs action requests to the site analyzer log file.
 PortletSiteAnalyzerLogger getLogger(ActionRequest actionRequest, ActionResponse actionResponse, ParameterNamesProcessor paramNamesProcessor)
          Returns a logger that logs action requests to the site analyzer log file.
 PortletSiteAnalyzerLogger getLogger(EventRequest req, EventResponse resp)
          Returns a logger that logs event requests to the site analyzer log file.
 PortletSiteAnalyzerLogger getLogger(EventRequest eventRequest, EventResponse eventResponse, ParameterNamesProcessor paramNamesProcessor)
          Returns a logger that logs event requests to the site analyzer log file.
 PortletSiteAnalyzerLogger getLogger(RenderRequest req, RenderResponse resp)
          Returns a logger that logs render requests to the site analyzer log file.
 PortletSiteAnalyzerLogger getLogger(RenderRequest renderRequest, RenderResponse renderResponse, ParameterNamesProcessor paramNamesProcessor)
          Returns a logger that logs render requests to the site analyzer log file.
 PortletSiteAnalyzerLogger getLogger(ResourceRequest req, ResourceResponse resp)
          Returns a logger that logs resource requests to the site analyzer log file.
 PortletSiteAnalyzerLogger getLogger(ResourceRequest resourceRequest, ResourceResponse resourceResponse, ParameterNamesProcessor paramNamesProcessor)
          Returns a logger that logs resource requests to the site analyzer log file.
 

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME
Name that can be used for the JNDI lookup of this service

Method Detail

getLogger

PortletSiteAnalyzerLogger getLogger(ActionRequest req,
                                    ActionResponse resp)
Returns a logger that logs action requests to the site analyzer log file.

Parameters:
req - action request
resp - action response
Returns:
the logger that is valid in the scope of the request and response that are passed in.

getLogger

PortletSiteAnalyzerLogger getLogger(EventRequest req,
                                    EventResponse resp)
Returns a logger that logs event requests to the site analyzer log file.

Parameters:
req - event request
resp - event response
Returns:
the logger that is valid in the scope of the request and response that are passed in.

getLogger

PortletSiteAnalyzerLogger getLogger(RenderRequest req,
                                    RenderResponse resp)
Returns a logger that logs render requests to the site analyzer log file.

Parameters:
req - render request
resp - render response
Returns:
the logger that is valid in the scope of the request and response that are passed in.

getLogger

PortletSiteAnalyzerLogger getLogger(ResourceRequest req,
                                    ResourceResponse resp)
Returns a logger that logs resource requests to the site analyzer log file.

Parameters:
req - resource request
resp - resource response
Returns:
the logger that is valid in the scope of the request and response that are passed in.

getLogger

PortletSiteAnalyzerLogger getLogger(ActionRequest actionRequest,
                                    ActionResponse actionResponse,
                                    ParameterNamesProcessor paramNamesProcessor)
Returns a logger that logs action requests to the site analyzer log file.

Parameters:
req - the current action request.
resp - the current action response.
paramNamesProcessor - the callback to replace actual request parameter names by meaningful keys for the site analytics log entry.
Returns:
the logger that is valid in the scope of the request and response that are passed in.

getLogger

PortletSiteAnalyzerLogger getLogger(EventRequest eventRequest,
                                    EventResponse eventResponse,
                                    ParameterNamesProcessor paramNamesProcessor)
Returns a logger that logs event requests to the site analyzer log file.

Parameters:
req - the current event request.
resp - the current event response.
paramNamesProcessor - the callback to replace actual request parameter names by meaningful keys for the site analytics log entry.
Returns:
the logger, the logger is only valid in the scope of the request and response that are passed in.

getLogger

PortletSiteAnalyzerLogger getLogger(RenderRequest renderRequest,
                                    RenderResponse renderResponse,
                                    ParameterNamesProcessor paramNamesProcessor)
Returns a logger that logs render requests to the site analyzer log file.

Parameters:
req - the current render request.
resp - the current render response.
paramNamesProcessor - the callback to replace actual request parameter names by meaningful keys for the site analytics log entry.
Returns:
the logger that is valid in the scope of the request and response that are passed in.

getLogger

PortletSiteAnalyzerLogger getLogger(ResourceRequest resourceRequest,
                                    ResourceResponse resourceResponse,
                                    ParameterNamesProcessor paramNamesProcessor)
Returns a logger that logs resource requests to the site analyzer log file.

Parameters:
req - the current resource request.
resp - the current resource response.
paramNamesProcessor - the callback to replace actual request parameter names by meaningful keys for the site analytics log entry.
Returns:
the logger that is valid in the scope of the request and response that are passed in.