com.ksc.handlers.IRequestHandler2 Maven / Gradle / Ivy
/*
* Copyright (c) 2016. Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://ksyun.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.ksc.handlers;
import com.ksc.KscServiceException;
import com.ksc.KscWebServiceRequest;
import com.ksc.Request;
import com.ksc.Response;
import com.ksc.annotation.SdkInternalApi;
import com.ksc.http.HttpResponse;
/**
* Interface for {@link RequestHandler2}. Do not use this outside the core SDK. We can and will add
* methods to this interface in the future. Extends {@link RequestHandler2} to implement a custom
* request handler.
*/
@SdkInternalApi
public interface IRequestHandler2 {
/**
* Runs any additional processing logic on the specified request object before it is marshaled
* into an HTTP request.
*
* If you're going to modify the request, make sure to clone it first, modify the clone, and
* return it from this method. Otherwise your changes will leak out to the user, who might reuse
* the request object without realizing that it was modified as part of sending it the first
* time.
*
* @param request
* the request passed in by the user
* @return the (possibly different) request to marshal
*/
KscWebServiceRequest beforeMarshalling(KscWebServiceRequest request);
/**
* Runs any additional processing logic on the specified request (before it is executed by the
* client runtime).
*
* @param request
* The low level request being processed.
*/
void beforeRequest(Request request);
/**
* Runs any additional processing logic on the specified response before it's unmarshalled. This
* callback is only invoked on successful responses that will be unmarsahlled into an
* appropriate modeled class and not for unsuccessful responses that will be unmarshalled into a
* subclass of {@link KscServiceException}
*
* @param request
* The low level request being processed.
* @param httpResponse
* The Raw HTTP response before being unmarshalled
* @return {@link HttpResponse} to replace the actual response. May be a mutated version of the
* original or a completely new {@link HttpResponse} object
*/
HttpResponse beforeUnmarshalling(Request request, HttpResponse httpResponse);
/**
* Runs any additional processing logic on the specified request (after is has been executed by
* the client runtime).
*
* @param request
* The low level request being processed.
* @param response
* The response generated from the specified request.
*/
void afterResponse(Request request, Response response);
/**
* Runs any additional processing logic on a request after it has failed.
*
* @param request
* The request that generated an error.
* @param response
* the response or null if the failure occurred before the response is made available
* @param e
* The error that resulted from executing the request.
*/
void afterError(Request request, Response response, Exception e);
}