com.google.api.ads.common.lib.client.HeaderHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ads-lib Show documentation

Client library for Java for accessing ads APIs including DFP. If you want to use this library, you must also include another Maven artifact to specify which framework you would like to use it with. For example, to use DFP with Axis, you should include the "dfp-axis" artifact.

There is a newer version: 5.6.0

Show newest version

// Copyright 2011, Google Inc. 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.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License 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.google.api.ads.common.lib.client;

import com.google.api.ads.common.lib.exception.AuthenticationException;
import com.google.api.ads.common.lib.exception.ServiceException;

/**
 * Interface for handling headers.
 */
public interface HeaderHandler {

  /**
   * Sets the headers on the SOAP client using the session and descriptor.
   *
   * @param soapClient the SOAP client
   * @param adsSession the ads session
   * @param adsServiceDescriptor the ads service descriptor
   * @throws ServiceException if there was a problem setting the headers
   * @throws AuthenticationException if there was a problem authenticating the
   *     session
   */
  void setHeaders(Object soapClient, S adsSession, D adsServiceDescriptor)
      throws ServiceException, AuthenticationException;
  
  /**
   * No-op implementation of HeaderHandler 
   */
  public static class NoOpHeaderHandler
    implements HeaderHandler{

    @Override
    public void setHeaders(Object soapClient, S adsSession, D adsServiceDescriptor)
        throws ServiceException, AuthenticationException {
      // No-op
    }
  }
}