com.cedarsoft.rest.JaxbMapping Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of server Show documentation
The newest version!
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.rest;

import com.cedarsoft.jaxb.JaxbObject;
import com.cedarsoft.jaxb.JaxbStub;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.ws.rs.core.UriBuilder;
import java.util.ArrayList;
import java.util.List;

/**
 * @param  the type
 * @param  the Jaxb type
 * @param  the Jaxb stub type
 */
public abstract class JaxbMapping> {
  @NotNull
  private final DelegateJaxbMappings delegateJaxbMappings = new DelegateJaxbMappings();

  @NotNull
  public DelegateJaxbMappings getDelegatesMapping() {
    return delegateJaxbMappings;
  }

  @NotNull
  public S getJaxbObjectStub( @NotNull T object, @NotNull UriContext context ) {
    return createJaxbObjectStub( object, context );
  }

  @NotNull
  public J getJaxbObject( @NotNull T object, @NotNull UriContext context ) {
    return createJaxbObject( object, context );
  }

  @Nullable
  protected  J get( @NotNull Class jaxbType, @Nullable T object, @NotNull UriContext context ) {
    if ( object == null ) {
      return null;
    }
    //    return getDelegatesMapping().getMapping( jaxbType ).getJaxbObject( object, context.getUriBuilder() );
    return getDelegatesMapping().getMapping( jaxbType ).getJaxbObject( object, context );
  }

  @Nullable
  protected  List get( @NotNull Class jaxbType, @NotNull Iterable objects, @NotNull UriContext context ) {
    JaxbMapping> mapping = getDelegatesMapping().getMapping( jaxbType );

    List converted = new ArrayList();
    for ( T object : objects ) {
      //      converted.add( mapping.getJaxbObject( object, context.getUriBuilder() ) );
      converted.add( mapping.getJaxbObject( object, context ) );
    }

    return converted;
  }

  @Nullable
  protected > S getStub( @NotNull Class jaxbStubType, @Nullable T object, @NotNull UriContext context ) {
    if ( object == null ) {
      return null;
    }
    return getDelegatesMapping().getMappingForStub( jaxbStubType ).getJaxbObjectStub( object, context );
  }

  @Nullable
  protected > List getStub( @NotNull Class jaxbSubType, @NotNull Iterable objects, @NotNull UriContext context ) {
    JaxbMapping mapping = getDelegatesMapping().getMappingForStub( jaxbSubType );

    List converted = new ArrayList();
    for ( T object : objects ) {
      //      converted.add( mapping.getJaxbObject( object, context.getUriBuilder() ) );
      converted.add( mapping.getJaxbObjectStub( object, context ) );
    }

    return converted;
  }

  @NotNull
  public List getJaxbObjects( @NotNull Iterable objects, @NotNull UriContext context ) {
    List currentJaxbObjects = new ArrayList();
    for ( T object : objects ) {
      currentJaxbObjects.add( getJaxbObject( object, context ) );
    }
    return currentJaxbObjects;
  }

  @NotNull
  public List getJaxbStubs( @NotNull Iterable objects, @NotNull UriContext context ) {
    List currentJaxbObjects = new ArrayList();
    for ( T object : objects ) {
      currentJaxbObjects.add( getJaxbObjectStub( object, context ) );
    }
    return currentJaxbObjects;
  }

  /**
   * Creates the local context.
   * The local context has an updated URI context.
   *
   * @param context    the base context (not local!)
   * @param jaxbObject the jaxb object
   * @return the local context (with updated URI builder) - or null if no local context is available
   */
  @Nullable
  protected UriContext createLocalContext( @NotNull UriContext context, @NotNull JaxbObject jaxbObject ) {
    UriBuilder localUri = getUri( jaxbObject, context );
    if ( localUri == null ) {
      return null;
    }
    return context.create( localUri );
  }

  /**
   * Creates the jaxb object
   *
   * @param object  the object
   * @param context the context
   * @return the jaxb object
   */
  @NotNull
  protected final J createJaxbObject( @NotNull T object, @NotNull UriContext context ) {
    J jaxbObject = createJaxbObject( object );

    UriContext localContext = createLocalContext( context, jaxbObject );
    if ( localContext != null ) {
      setHref( jaxbObject, localContext );
    }

    copyFieldsToJaxbObject( object, jaxbObject, localContext != null ? localContext : context );
    return jaxbObject;
  }

  /**
   * Creates the JaxbObjectStub.
   * 
   * A stub only contains the very basic informations off the object. It is used in collections and when referenced
   * from other objects.
   * 

   * It has to contain a href to fetch the missing details later.
   *
   * @param object  the object
   * @param context the context
   * @return the stub
   */
  protected final S createJaxbObjectStub( @NotNull T object, @NotNull UriContext context ) {
    S jaxbStub = createJaxbStub( object );

    UriContext localContext = createLocalContext( context, jaxbStub );
    if ( localContext != null ) {
      setHref( jaxbStub, localContext );
    }

    copyFieldsToStub( object, jaxbStub, localContext != null ? localContext : context );
    return jaxbStub;

  }

  /**
   * Sets the URI to the jaxb object.
   * Override this method for custom behaviour (e.g. no href set)
   *
   * @param jaxbObject the jaxb object
   * @param context    the context
   */
  protected void setHref( @NotNull JaxbObject jaxbObject, @NotNull UriContext context ) {
    jaxbObject.setHref( context.getUri() );
  }

  /**
   * Returns the local URI for the object
   *
   * @param object  the object (may be used to fetch the ID)
   * @param context the context
   * @return the updated uri builder or null of no URI is available
   */
  @Nullable
  protected abstract UriBuilder getUri( @NotNull JaxbObject object, @NotNull UriContext context );

  /**
   * Creates the basic JaxbObject.
   * This method also *must* set the ID
   *
   * @param object the object
   * @return the jaxb object (with the ID set)
   */
  @NotNull
  protected abstract J createJaxbObject( @NotNull T object );

  /**
   * Creates the basic stub.
   * This method also *must* set the ID
   *
   * @param object the object
   * @return the stub object (with the ID set)
   */
  @NotNull
  protected abstract S createJaxbStub( @NotNull T object );

  /**
   * Copies the fields from the source to the target.
   * 
   * Context: This is the local context that has been created using the URI returned by {@link #getUri(JaxbObject, UriContext)}.
   * If that method returns null, there is no local context available and the given parameter is the context of the parent.
   *
   * @param source  the source object
   * @param target  the target jaxb object
   * @param context the (local) context.
   */
  protected abstract void copyFieldsToJaxbObject( @NotNull T source, @NotNull J target, @NotNull UriContext context );

  protected abstract void copyFieldsToStub( @NotNull T source, @NotNull S target, @NotNull UriContext context );
}