com.google.api.control

Class ControlFilter

java.lang.Object

com.google.api.control.ControlFilter

All Implemented Interfaces:

javax.servlet.Filter

public class ControlFilter
extends java.lang.Object
implements javax.servlet.Filter

ControlFilter is a Filter that provides service control. Requests do not proceed unless the response to a call Client.check(com.google.api.servicecontrol.v1.CheckRequest) succeeds. All calls are 'reported' via a call to Client.report(com.google.api.servicecontrol.v1.ReportRequest)

Constructor Summary

Constructors

Constructor and Description
ControlFilter()
ControlFilter(Client client, java.lang.String projectId, com.google.common.base.Ticker ticker, com.google.api.client.util.Clock clock, com.google.api.client.http.HttpTransport transport)

Method Summary

Modifier and Type	Method and Description
protected Client	createClient(java.lang.String configServiceName) A template method for constructing clients.
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig)
protected void	setProjectId(java.lang.String projectId) A template method used while initializing the filter.
protected int	statsLogFrequency()

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlFilter

public ControlFilter(@Nullable
                     Client client,
                     @Nullable
                     java.lang.String projectId,
                     @Nullable
                     com.google.common.base.Ticker ticker,
                     @Nullable
                     com.google.api.client.util.Clock clock,
                     @Nullable
                     com.google.api.client.http.HttpTransport transport)

ControlFilter

public ControlFilter()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

setProjectId

protected void setProjectId(java.lang.String projectId)

A template method used while initializing the filter. Intended Usage

Subclasses of may override this method to customize how the project Id is determined

statsLogFrequency

protected int statsLogFrequency()

createClient

protected Client createClient(java.lang.String configServiceName)
                       throws java.security.GeneralSecurityException,
                              java.io.IOException

A template method for constructing clients. Intended Usage

Subclasses of may override this method to customize how the client get's built. Note that this method is intended to be invoked by init(FilterConfig) when the serviceName parameter is provided. If that parameter is missing, this function will not be called and the client will not be constructed.

Parameters:

configServiceName - the service name to use in constructing the client

Returns:

a Client

Throws:

java.security.GeneralSecurityException - indicates that client was not created successfully

java.io.IOException - indicates that the client was not created successfully

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

java.io.IOException

javax.servlet.ServletException