org.powertac.common.XMLMessageConverter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common Show documentation
Domain types, services, utilities shared by Power TAC server and agents
There is a newer version: 1.9.0
/*
 * Copyright (c) 2011 by the original author or authors.
 *
 * 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 org.powertac.common;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import javax.annotation.PostConstruct;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.powertac.common.msg.CustomerBootstrapData;
import org.powertac.common.msg.SimEnd;
import org.powertac.common.msg.SimPause;
import org.powertac.common.msg.SimResume;
import org.powertac.common.msg.SimStart;
import org.powertac.common.spring.SpringApplicationContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.core.type.classreading.CachingMetadataReaderFactory;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.stereotype.Service;
import org.springframework.util.ClassUtils;
import org.springframework.util.SystemPropertyUtils;

import com.thoughtworks.xstream.XStream;

@Service
public class XMLMessageConverter 
{
  private static final Logger log = LogManager.getLogger(XMLMessageConverter.class);
  
  @SuppressWarnings("rawtypes")
  private Class[] commandClasses = { CustomerBootstrapData.class, SimEnd.class,
      SimStart.class, SimPause.class, SimResume.class };

  private XStream xstream;
  
  // inject context here so that it would be initialized before this class
  // @PostConstruct method get called and use the singleton.
  @Autowired
  private SpringApplicationContext context;

  @SuppressWarnings("rawtypes")
  @PostConstruct
  public void afterPropertiesSet() {
    xstream = new XStream();

    try {
      List classes = findMyTypes("org.powertac.common");
      for (Class clazz : classes) {
        log.info("processing class " + clazz.getName());
        xstream.processAnnotations(clazz);
      }
    } catch (IOException e) {
      log.error("failed to process annotation", e);
    } catch (ClassNotFoundException e) {
      log.error("failed to process annotation", e);
    }

    for (Class commandClazz : commandClasses) {
      xstream.processAnnotations(commandClazz);
    }

    xstream.autodetectAnnotations(true);

    xstream.aliasSystemAttribute(null, "class");
  }

  public String toXML(Object message) {
    return xstream.toXML(message);
  }

  public Object fromXML(String xml) {
    return xstream.fromXML(xml);
  }
    
  @SuppressWarnings("rawtypes")
  private List findMyTypes(String basePackage) throws IOException, ClassNotFoundException
  {
      ResourcePatternResolver resourcePatternResolver = new PathMatchingResourcePatternResolver();
      MetadataReaderFactory metadataReaderFactory = new CachingMetadataReaderFactory(resourcePatternResolver);

      List candidates = new ArrayList();
      String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +
                                 resolveBasePackage(basePackage) + "/" + "**/*.class";
      Resource[] resources = resourcePatternResolver.getResources(packageSearchPath);
      for (Resource resource : resources) {
          if (resource.isReadable()) {
              MetadataReader metadataReader = metadataReaderFactory.getMetadataReader(resource);
              candidates.add(Class.forName(metadataReader.getClassMetadata().getClassName()));
          }
      }
      return candidates;
  }

  private String resolveBasePackage(String basePackage) {
      return ClassUtils.convertClassNameToResourcePath(SystemPropertyUtils.resolvePlaceholders(basePackage));
  }
}