001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * docs/licenses/cddl.txt
011 * or http://www.opensource.org/licenses/cddl1.php.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * docs/licenses/cddl.txt.  If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 *      Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 *      Copyright 2013-2021 Ping Identity Corporation
026 */
027
028package com.unboundid.directory.sdk.broker.types;
029
030import com.unboundid.util.NotExtensible;
031
032
033
034/**
035 * Represents a request to create an entry in a Store Adapter.
036 */
037@NotExtensible
038public interface StoreCreateRequest
039  extends StoreRequest
040{
041  /**
042   * Retrieve the JSON object to be created. This string can be parsed using
043   * any JSON library. For example, Jackson's ObjectMapper.readTree() or the
044   * UnboundID LDAP SDK's JSONObject constructor.
045   *
046   * @return The JSON object to be created.
047   */
048  String getObjectToCreate();
049}