org.apache.shindig.gadgets.http

Class DefaultRequestPipeline

java.lang.Object

org.apache.shindig.gadgets.http.DefaultRequestPipeline

All Implemented Interfaces:

RequestPipeline

public class DefaultRequestPipeline
extends Object
implements RequestPipeline

A standard implementation of a request pipeline. Performs request caching and signing on top of standard HTTP requests.

Constructor Summary

Constructors

Constructor and Description
DefaultRequestPipeline(HttpFetcher httpFetcher, HttpCache httpCache, com.google.inject.Provider<OAuthRequest> oauthRequestProvider, com.google.inject.Provider<OAuth2Request> oauth2RequestProvider, ResponseRewriterRegistry responseRewriterRegistry, InvalidationService invalidationService, HttpResponseMetadataHelper metadataHelper)

Method Summary

Methods

Modifier and Type	Method and Description
protected HttpResponse	cacheFetchedResponse(HttpRequest request, HttpResponse fetchedResponse) Cache the HttpResponse object before being returned to caller.
protected HttpResponse	checkCachedResponse(HttpRequest request) Check the HttpRequest object has already allow caching and if do try to get it from cache.
HttpResponse	execute(HttpRequest request) Execute the given request.
protected HttpResponse	fetchResponse(HttpRequest request) Fetch the response from the network using the right fetcher Override this if you need to extend the current behavior of supported auth type.
protected HttpResponse	fixFetchedResponse(HttpRequest request, HttpResponse fetchedResponse, HttpResponse invalidatedResponse, HttpResponse staleResponse) Attempt to "fix" the response by checking its validity and adding additional metadata Override this if you need to add more processing to the HttpResponse before being cached and returned.
static HttpResponse	maybeFixDriftTime(HttpResponse response) Verify response time, and if response time is off from current time by more then speficied time change response time to be current time.
protected void	normalizeProtocol(HttpRequest request) Normalizing the HttpRequest object to verify the validity of the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRequestPipeline

@Inject
public DefaultRequestPipeline(HttpFetcher httpFetcher,
                             HttpCache httpCache,
                             com.google.inject.Provider<OAuthRequest> oauthRequestProvider,
                             com.google.inject.Provider<OAuth2Request> oauth2RequestProvider,
                             ResponseRewriterRegistry responseRewriterRegistry,
                             InvalidationService invalidationService,
                             HttpResponseMetadataHelper metadataHelper)

Method Detail

execute

public HttpResponse execute(HttpRequest request)
                     throws GadgetException

Description copied from interface: RequestPipeline

Execute the given request. TODO: This should throw a custom exception type.

Specified by:

execute in interface RequestPipeline

Throws:

GadgetException

normalizeProtocol

protected void normalizeProtocol(HttpRequest request)
                          throws GadgetException

Normalizing the HttpRequest object to verify the validity of the request.

Parameters:

request -

Throws:

GadgetException

checkCachedResponse

protected HttpResponse checkCachedResponse(HttpRequest request)

Check the HttpRequest object has already allow caching and if do try to get it from cache. Override this if you want to add additional logic to get response for the request from cache.

Parameters:

request -

Returns:

HttpResponse object which either the cached response or null

fetchResponse

protected HttpResponse fetchResponse(HttpRequest request)
                              throws GadgetException

Fetch the response from the network using the right fetcher Override this if you need to extend the current behavior of supported auth type.

Parameters:

request -

Returns:

HttpResponse object fetched from network

Throws:

GadgetException

fixFetchedResponse

protected HttpResponse fixFetchedResponse(HttpRequest request,
                              HttpResponse fetchedResponse,
                              HttpResponse invalidatedResponse,
                              HttpResponse staleResponse)
                                   throws GadgetException

Attempt to "fix" the response by checking its validity and adding additional metadata Override this if you need to add more processing to the HttpResponse before being cached and returned.

Parameters:

request -

fetchedResponse -

invalidatedResponse -

staleResponse -

Returns:

HttpResponse object that has been updated with some metadata tags.

Throws:

GadgetException

cacheFetchedResponse

protected HttpResponse cacheFetchedResponse(HttpRequest request,
                                HttpResponse fetchedResponse)

Cache the HttpResponse object before being returned to caller. The default implementation also invalidate the response object by marking it as valid so the next request can detect if it has been invalidated. Override this if you need to add additional processing to cache the response.

Parameters:

request -

fetchedResponse -

Returns:

HttpResponse object that has been updated with some metadata tags.

maybeFixDriftTime

public static HttpResponse maybeFixDriftTime(HttpResponse response)

Verify response time, and if response time is off from current time by more then speficied time change response time to be current time. The function resolve cases that remote server time is wrong, which can cause resources to expire prematurly or served after they should be expired. The allowd drift time is configured by responseDateDriftLimit.

Parameters:

response - the response to fix

Returns:

new response with fix date or original reesponse