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 2019 Ping Identity Corporation
026 */
027package com.unboundid.directory.sdk.broker.types;
028
029import com.fasterxml.jackson.databind.node.ObjectNode;
030import com.unboundid.util.NotExtensible;
031
032import java.security.Principal;
033
034/**
035 * A principal implementation for a user represented by an access token.
036 */
037@NotExtensible()
038public interface TokenOwnerPrincipal extends Principal
039{
040  /**
041   * Returns the name of this principal.
042   *
043   * @return The name of this principal.
044   */
045  @Override
046  String getName();
047
048  /**
049   * Gets the token owner's attributes.
050   *
051   * @return The token owner's attributes as a JSON object. May be {@code null}.
052   */
053  ObjectNode getResource();
054}