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 * trunk/ds/resource/legal-notices/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 * trunk/ds/resource/legal-notices/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 2016-2019 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.broker.types;
028
029import com.unboundid.util.NotExtensible;
030
031import java.security.Principal;
032
033
034
035/**
036 * A principal implementation for users retrievable as SCIM resources.
037 */
038@NotExtensible()
039public interface ScimResourcePrincipal extends Principal
040{
041  /**
042   * Get the SCIM resource endpoint for this user.
043   *
044   * @return the SCIM resource endpoint for this user.
045   */
046  String getResourceEndpoint();
047
048
049
050  /**
051   * Get the SCIM resource ID for this user.
052   *
053   * @return the SCIM resource ID for this user.
054   */
055  String getResourceId();
056
057
058
059  /**
060   * Returns the name of this principal.
061   *
062   * @return the name of this principal.
063   */
064  @Override
065  String getName();
066}