com.google.api.ads.common.lib.soap.jaxb.JaxBSerializer 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 2012 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.soap.jaxb;

import org.apache.commons.lang.SerializationException;

import java.io.StringWriter;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Marshaller;
import javax.xml.namespace.QName;

/**
 * Serializes a JAX-WS generated class to XML.
 *
 *
 * @param  Class we are serializing.
 */
public class JaxBSerializer {

  private final Class clazz;
  private final QName qname;
  private final JAXBContext jaxbContext;

  /**
   * Constructs a JAX-WS serializer for the specified class.
   *
   * @param clazz Class to serialize.
   * @param qname A QName representing the local name for the class - this will be used as the root
   *        tag name.
   * @throws SerializationException if unable to construct the serializer.
   */
  public JaxBSerializer(Class clazz, QName qname) {
    this.clazz = clazz;
    this.qname = qname;
    try {
      this.jaxbContext = JAXBContext.newInstance(clazz);
    } catch (JAXBException e) {
      throw new SerializationException(
          String.format(
              "Could not construct a serializer for class %s and QName %s.", clazz, qname),
          e);
    }
  }

  /**
   * Serializes the object.
   *
   * @throws SerializationException if we cannot serialize the object.
   */
  public String serialize(T object) {
    return serialize(object, true);
  }

  /**
   * Serializes the object with the option to include or exclude the XML declaration.
   *
   * @throws SerializationException if we cannot serialize the object.
   */
  public String serialize(T object, boolean includeXmlDeclaration) {
    try {
      Marshaller marshaller = jaxbContext.createMarshaller();
      marshaller.setProperty(Marshaller.JAXB_FRAGMENT, Boolean.valueOf(!includeXmlDeclaration));
      JAXBElement element =
          new JAXBElement(qname, clazz, object);
      StringWriter stringWriter = new StringWriter();
      marshaller.marshal(element, stringWriter);
      return stringWriter.toString();
    } catch (JAXBException e) {
      throw new SerializationException(String.format("Could not serialize object: %s.", object), e);
    }
  }
}