All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.unboundid.scim2.client.requests.ModifyRequestBuilder Maven / Gradle / Ivy

Go to download

The UnboundID SCIM2 SDK is a library that may be used to interact with various types of SCIM-enabled endpoints (such as the Ping Identity server products) to perform lightweight, cloud-based identity management via the SCIM Protocol. See https://simplecloud.info for more information.

The newest version!
/*
 * Copyright 2015-2024 Ping Identity Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License (GPLv2 only)
 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
 * as published by the Free Software Foundation.
 *
 * This program 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see .
 */

package com.unboundid.scim2.client.requests;

import com.fasterxml.jackson.databind.JsonNode;
import com.unboundid.scim2.common.Path;
import com.unboundid.scim2.common.ScimResource;
import com.unboundid.scim2.common.annotations.NotNull;
import com.unboundid.scim2.common.annotations.Nullable;
import com.unboundid.scim2.common.exceptions.ScimException;
import com.unboundid.scim2.common.messages.PatchOperation;
import com.unboundid.scim2.common.messages.PatchRequest;
import com.unboundid.scim2.common.utils.JsonUtils;

import jakarta.ws.rs.ProcessingException;
import jakarta.ws.rs.client.Entity;
import jakarta.ws.rs.client.Invocation;
import jakarta.ws.rs.client.WebTarget;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.Response;

import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

/**
 * A builder for SCIM modify requests.
 */
public abstract class ModifyRequestBuilder>
    extends ResourceReturningRequestBuilder
{
  /**
   * The list of patch operations to include in the request.
   */
  @NotNull
  protected final List operations;

  /**
   * The version to match.
   */
  @Nullable
  protected String version;

  /**
   * Create a new ModifyRequestBuilder.
   *
   * @param target The WebTarget to PATCH.
   */
  private ModifyRequestBuilder(@NotNull final WebTarget target)
  {
    super(target);
    this.operations = new LinkedList();
  }

  /**
   * {@inheritDoc}
   */
  @Override
  @NotNull
  Invocation.Builder buildRequest()
  {
    Invocation.Builder request = super.buildRequest();
    if(version != null)
    {
      request.header(HttpHeaders.IF_MATCH, version);
    }
    return request;
  }

  /**
   * A builder for SCIM modify requests for where the returned resource POJO
   * type will be the same as the original.
   */
  public static final class Generic
      extends ModifyRequestBuilder>
  {
    @NotNull
    private final T resource;

    /**
     * Create a new generic modify request builder.
     *
     * @param target The WebTarget to PATCH.
     * @param resource The SCIM resource to retrieve.
     */
    public Generic(@NotNull final WebTarget target, @NotNull final T resource)
    {
      super(target);
      this.resource = resource;
    }


    /**
     * Modify the resource only if the resource has not been modified from the
     * resource provided.
     *
     * @return This builder.
     */
    @NotNull
    public Generic ifMatch()
    {
      this.version = getResourceVersion(resource);
      return this;
    }

    /**
     * Invoke the SCIM modify request.
     *
     * @return The successfully modified SCIM resource.
     * @throws ProcessingException If a JAX-RS runtime exception occurred.
     * @throws ScimException If the SCIM service provider responded with an error.
     */
    @NotNull
    @SuppressWarnings("unchecked")
    public T invoke() throws ScimException
    {
      return (T) invoke(resource.getClass());
    }

    /**
     * Invoke the SCIM modify request.
     *
     * @param  The type of object to return.
     * @param cls The Java class object used to determine the type to return.
     * @return The successfully modified SCIM resource.
     * @throws ProcessingException If a JAX-RS runtime exception occurred.
     * @throws ScimException If the SCIM service provider responded with an error.
     */
    @NotNull
    public  C invoke(@NotNull final Class cls) throws ScimException
    {
      PatchRequest patchRequest = new PatchRequest(operations);
      Response response = buildRequest().method("PATCH",
          Entity.entity(patchRequest, getContentType()));
      try
      {
        if (response.getStatusInfo().getFamily() ==
            Response.Status.Family.SUCCESSFUL)
        {
          return response.readEntity(cls);
        } else
        {
          throw toScimException(response);
        }
      }
      finally
      {
        response.close();
      }
    }
  }


  /**
   * A builder for SCIM modify requests for where the returned resource POJO
   * type will be provided.
   */
  public static final class Typed extends ModifyRequestBuilder
  {
    /**
     * Create a new generic modify request builder.
     *
     * @param target The WebTarget to PATCH.
     */
    public Typed(@NotNull final WebTarget target)
    {
      super(target);
    }

    /**
     * Modify the resource only if the resource has not been modified since the
     * provided version.
     *
     * @param version The version of the resource to compare.
     * @return This builder.
     */
    @NotNull
    public Typed ifMatch(@Nullable final String version)
    {
      this.version = version;
      return this;
    }

    /**
     * Invoke the SCIM modify request.
     *
     * @param  The type of object to return.
     * @param cls The Java class object used to determine the type to return.
     * @return The successfully modified SCIM resource.
     * @throws ProcessingException If a JAX-RS runtime exception occurred.
     * @throws ScimException If the SCIM service provider responded with an error.
     */
    @NotNull
    public  T invoke(@NotNull final Class cls) throws ScimException
    {
      PatchRequest patchRequest = new PatchRequest(operations);
      Response response = buildRequest().method("PATCH",
          Entity.entity(patchRequest, getContentType()));
      try
      {
        if(response.getStatusInfo().getFamily() ==
            Response.Status.Family.SUCCESSFUL)
        {
          return response.readEntity(cls);
        }
        else
        {
          throw toScimException(response);
        }
      }
      finally
      {
        response.close();
      }
    }
  }

  /**
   * Set value of the attribute specified by the path, replacing any existing
   * value(s).
   *
   * @param path The path to the attribute whose value to set.
   * @param object The value to set.
   *
   * @return This patch operation request.
   * @throws ScimException If the path is invalid.
   */
  @NotNull
  public T replaceValue(@NotNull final String path,
                        @Nullable final Object object)
      throws ScimException
  {
    return replaceValue(Path.fromString(path), object);
  }

  /**
   * Set value of the attribute specified by the path, replacing any existing
   * value(s).
   *
   * @param path The path to the attribute whose value to set.
   * @param object The value to set.
   *
   * @return This patch operation request.
   */
  @NotNull
  public T replaceValue(@NotNull final Path path, @Nullable final Object object)
  {
    JsonNode newObjectNode = JsonUtils.valueToNode(object);
    return addOperation(PatchOperation.replace(path, newObjectNode));
  }

  /**
   * Set values of the attribute specified by the path, replacing any existing
   * values.
   *
   * @param path The path to the attribute whose value to set.
   * @param objects The value(s) to set.
   *
   * @return This patch operation request.
   * @throws ScimException If the path is invalid.
   */
  @NotNull
  public T replaceValues(@NotNull final String path,
                         @Nullable final Collection objects)
      throws ScimException
  {
    return replaceValues(Path.fromString(path), objects);
  }

  /**
   * Set values of the attribute specified by the path, replacing any existing
   * values.
   *
   * @param path The path to the attribute whose value to set.
   * @param objects The value(s) to set.
   *
   * @return This patch operation request.
   */
  @NotNull
  public T replaceValues(@NotNull final Path path,
                         @Nullable final Collection objects)
  {
    JsonNode newObjectNode = JsonUtils.valueToNode(objects);
    return addOperation(PatchOperation.replace(path, newObjectNode));
  }

  /**
   * Set values of the attribute specified by the path, replacing any existing
   * values.
   *
   * @param path The path to the attribute whose value to set.
   * @param objects The value(s) to set.
   *
   * @return This patch operation request.
   * @throws ScimException If the path is invalid.
   */
  @NotNull
  public T replaceValues(@NotNull final String path,
                         @NotNull final Object... objects)
      throws ScimException
  {
    return replaceValues(Path.fromString(path), objects);

  }

  /**
   * Set values of the attribute specified by the path, replacing any existing
   * values.
   *
   * @param path The path to the attribute whose value to set.
   * @param objects The value(s) to set.
   *
   * @return This patch operation request.
   */
  @NotNull
  public T replaceValues(@NotNull final Path path,
                         @NotNull final Object... objects)
  {
    JsonNode newObjectNode = JsonUtils.valueToNode(objects);
    return addOperation(PatchOperation.replace(path, newObjectNode));
  }

  /**
   * Add values to the multi-valued attribute specified by the path.
   *
   * @param path The path to the multi-valued attribute.
   * @param objects The values to add.
   *
   * @return This patch operation request.
   * @throws ScimException If the path is invalid.
   */
  @NotNull
  public T addValues(@NotNull final String path,
                     @NotNull final Collection objects)
      throws ScimException
  {
    return addValues(Path.fromString(path), objects);
  }

  /**
   * Add values to the multi-valued attribute specified by the path.
   *
   * @param path The path to the multi-valued attribute.
   * @param objects The values to add.
   *
   * @return This patch operation request.
   */
  @NotNull
  public T addValues(@NotNull final Path path,
                     @NotNull final Collection objects)
  {
    JsonNode newObjectNode = JsonUtils.valueToNode(objects);
    return addOperation(PatchOperation.add(path, newObjectNode));
  }

  /**
   * Add values to the multi-valued attribute specified by the path.
   *
   * @param path The path to the multi-valued attribute.
   * @param objects The values to add.
   *
   * @return This patch operation request.
   * @throws ScimException If the path is invalid.
   */
  @NotNull
  public T addValues(@NotNull final String path,
                     @NotNull final Object... objects)
      throws ScimException
  {
    return addValues(Path.fromString(path), objects);


  }

  /**
   * Add values to the multi-valued attribute specified by the path.
   *
   * @param path The path to the multi-valued attribute.
   * @param objects The values to add.
   *
   * @return This patch operation request.
   */
  @NotNull
  public T addValues(@NotNull final Path path,
                     @NotNull final Object... objects)
  {
    JsonNode newObjectNode = JsonUtils.valueToNode(objects);
    return addOperation(PatchOperation.add(path, newObjectNode));
  }

  /**
   * Remove all values of the attribute specified by the path.
   *
   * @param path The path to the attribute whose value to remove.
   *
   * @return This patch operation request.
   * @throws ScimException If the path is invalid.
   */
  @NotNull
  public T removeValues(@NotNull final String path)
      throws ScimException
  {
    return removeValues(Path.fromString(path));

  }

  /**
   * Remove all values of the attribute specified by the path.
   *
   * @param path The path to the attribute whose value to remove.
   *
   * @return This patch operation request.
   * @throws ScimException If the path is invalid.
   */
  @NotNull
  public T removeValues(@NotNull final Path path)
      throws ScimException
  {
    return addOperation(PatchOperation.remove(path));
  }

  /**
   * Add a new patch operation this this patch request.
   *
   * @param op The patch operation to add.
   *
   * @return This patch operation request.
   */
  @NotNull
  @SuppressWarnings("unchecked")
  public T addOperation(@NotNull final PatchOperation op)
  {
    operations.add(op);
    return (T) this;
  }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy