Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.atlassian.httpclient.api
Interface ResponseTransformationPromise<O>

Type Parameters:
O - The target object for the transformation.
All Superinterfaces:
java.util.concurrent.Future<O>, com.google.common.util.concurrent.ListenableFuture<O>, com.atlassian.util.concurrent.Promise<O>
public interface ResponseTransformationPromise<O>
extends com.atlassian.util.concurrent.Promise<O>

Promise that allows for transforming functions based on different HTTP codes or exceptions. Under the covers, all functions are used in a fold() call.

Method Summary
 ResponseTransformationPromise<O> badRequest(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'bad request' (400) HTTP responses.
 ResponseTransformationPromise<O> clientError(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'client error' (4xx) HTTP responses.
 ResponseTransformationPromise<O> conflict(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'conflict' (409) HTTP responses.
 ResponseTransformationPromise<O> created(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'created' (201) HTTP responses.
 ResponseTransformationPromise<O> done(com.google.common.base.Function<Response,O> f)
          Register a function to transform all completed (1xx, 2xx, 3xx, 4xx, and 5xx) HTTP responses.
 ResponseTransformationPromise<O> error(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform all error (4xx and 5xx) HTTP responses.
 ResponseTransformationPromise<O> fail(com.google.common.base.Function<java.lang.Throwable,? extends O> f)
          Register a function to transform exceptions thrown while executing the HTTP request.
 ResponseTransformationPromise<O> forbidden(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'forbidden' (403) HTTP responses.
 ResponseTransformationPromise<O> informational(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'informational' (1xx) HTTP responses.
 ResponseTransformationPromise<O> internalServerError(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'internal server error' (500) HTTP responses.
 ResponseTransformationPromise<O> noContent(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'no content' (204) HTTP responses.
 ResponseTransformationPromise<O> notFound(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'not found' (404) HTTP responses.
 ResponseTransformationPromise<O> notModified(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'not modified' (304) HTTP responses.
 ResponseTransformationPromise<O> notSuccessful(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform all non-'successful' (1xx, 3xx, 4xx, 5xx) HTTP responses.
 ResponseTransformationPromise<O> ok(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'ok' (200) HTTP responses.
 ResponseTransformationPromise<O> on(int statusCode, com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform HTTP responses with a specific status code.
 ResponseTransformationPromise<O> others(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform all other HTTP responses (i.e.
 ResponseTransformationPromise<O> otherwise(com.google.common.base.Function<java.lang.Throwable,O> f)
          Register a function to transform both of the following events: Any value passed to fail() Any value passed to others(), converted into an exception
 ResponseTransformationPromise<O> redirection(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'redirection' (3xx) HTTP responses.
 ResponseTransformationPromise<O> seeOther(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'see other' (303) HTTP responses.
 ResponseTransformationPromise<O> serverError(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'server error' (5xx) HTTP responses.
 ResponseTransformationPromise<O> serviceUnavailable(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'service unavailable' (503) HTTP responses.
 ResponseTransformationPromise<O> successful(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'successful' (2xx) HTTP responses.
 ResponseTransformationPromise<O> unauthorized(com.google.common.base.Function<Response,? extends O> f)
          Register a function to transform 'unauthorized' (401) HTTP responses.
 
Methods inherited from interface com.atlassian.util.concurrent.Promise
claim, done, fail, flatMap, fold, map, recover, then
 
Methods inherited from interface com.google.common.util.concurrent.ListenableFuture
addListener
 
Methods inherited from interface java.util.concurrent.Future
cancel, get, get, isCancelled, isDone
 

Method Detail

on

ResponseTransformationPromise<O> on(int statusCode,
                                    com.google.common.base.Function<Response,? extends O> f)
Register a function to transform HTTP responses with a specific status code. Use this as a fallback if the status code you're interested in does not have a more explicit registration method for it.

Parameters:
statusCode - The code to select on
f - The transformation function
Returns:
This instance for chaining

informational

ResponseTransformationPromise<O> informational(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'informational' (1xx) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

successful

ResponseTransformationPromise<O> successful(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'successful' (2xx) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

ok

ResponseTransformationPromise<O> ok(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'ok' (200) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

created

ResponseTransformationPromise<O> created(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'created' (201) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

noContent

ResponseTransformationPromise<O> noContent(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'no content' (204) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

redirection

ResponseTransformationPromise<O> redirection(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'redirection' (3xx) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

seeOther

ResponseTransformationPromise<O> seeOther(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'see other' (303) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

notModified

ResponseTransformationPromise<O> notModified(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'not modified' (304) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

clientError

ResponseTransformationPromise<O> clientError(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'client error' (4xx) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

badRequest

ResponseTransformationPromise<O> badRequest(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'bad request' (400) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

unauthorized

ResponseTransformationPromise<O> unauthorized(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'unauthorized' (401) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

forbidden

ResponseTransformationPromise<O> forbidden(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'forbidden' (403) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

notFound

ResponseTransformationPromise<O> notFound(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'not found' (404) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

conflict

ResponseTransformationPromise<O> conflict(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'conflict' (409) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

serverError

ResponseTransformationPromise<O> serverError(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'server error' (5xx) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

internalServerError

ResponseTransformationPromise<O> internalServerError(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'internal server error' (500) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

serviceUnavailable

ResponseTransformationPromise<O> serviceUnavailable(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform 'service unavailable' (503) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

error

ResponseTransformationPromise<O> error(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform all error (4xx and 5xx) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

notSuccessful

ResponseTransformationPromise<O> notSuccessful(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform all non-'successful' (1xx, 3xx, 4xx, 5xx) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

others

ResponseTransformationPromise<O> others(com.google.common.base.Function<Response,? extends O> f)
Register a function to transform all other HTTP responses (i.e. those not explicitly registered for).

Parameters:
f - The transformation function
Returns:
This instance for chaining

otherwise

ResponseTransformationPromise<O> otherwise(com.google.common.base.Function<java.lang.Throwable,O> f)
Register a function to transform both of the following events:

Parameters:
f - The transformation function
Returns:
This instance for chaining

done

ResponseTransformationPromise<O> done(com.google.common.base.Function<Response,O> f)
Register a function to transform all completed (1xx, 2xx, 3xx, 4xx, and 5xx) HTTP responses.

Parameters:
f - The transformation function
Returns:
This instance for chaining

fail

ResponseTransformationPromise<O> fail(com.google.common.base.Function<java.lang.Throwable,? extends O> f)
Register a function to transform exceptions thrown while executing the HTTP request.

Parameters:
f - The transformation function
Returns:
This instance for chaining
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012 Atlassian. All Rights Reserved.