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 2021 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.scim2.types;
028
029import com.unboundid.util.NotExtensible;
030
031import javax.servlet.http.HttpServletRequest;
032
033/**
034 * Represents a SCIM 2 request.
035 */
036@NotExtensible
037public interface SCIMRequest
038{
039  /**
040   * Gets the associated HTTP servlet request.
041   *
042   * @return  The HTTP servlet request.
043   */
044  HttpServletRequest getHttpServletRequest();
045
046  /**
047   * Gets the name of the SCIM resource type.
048   *
049   * @return The SCIM resource type name.
050   */
051  String getResourceType();
052
053  /**
054   * Gets the SCIM resource ID.
055   *
056   * @return The SCIM resource ID.
057   */
058  String getResourceId();
059
060  /**
061   * Gets the name of the SCIM sub-resource type.
062   *
063   * @return The SCIM sub-resource type name.
064   */
065  String getSubResourceType();
066
067  /**
068   * Gets the SCIM sub-resource ID.
069   *
070   * @return The SCIM sub-resource ID.
071   */
072  String getSubResourceId();
073}