com.unboundid.scim2.extension.messages.consent.Consent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scim2-ubid-extensions Show documentation

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.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2015-2019 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.extension.messages.consent;

import com.unboundid.scim2.common.BaseScimResource;
import com.unboundid.scim2.common.annotations.Attribute;
import com.unboundid.scim2.common.annotations.Schema;
import com.unboundid.scim2.common.types.AttributeDefinition;
import com.unboundid.scim2.common.types.Meta;

import java.util.List;

@Schema(description = "Consent objects.  These represent a user giving" +
    "consent for a client to access identity data.",
    id = "urn:pingidentity:scim:api:messages:2.0:consent",
    name = "Consent")
public final class Consent extends BaseScimResource
{
  @Attribute(description = "The client for this consent.",
      mutability = AttributeDefinition.Mutability.IMMUTABLE)
  private final OAuth2Client client;

  @Attribute(description = "The scopes for this consent.",
      mutability = AttributeDefinition.Mutability.READ_WRITE,
      multiValueClass = Scope.class)
  private final List scopes;

  // private no-arg constructor for Jackson.  Jackson will construct
  // this object and set all fields (even private final ones).
  private Consent()
  {
    this(null, null);
  }

  /**
   * Construct a new Consent object.  This should only be needed by the
   * server.
   *
   * @param client client for this consent.
   * @param scopes scopes for this consent.
   */
  public Consent(final OAuth2Client client, final List scopes)
  {
    this.setMeta(new Meta());
    this.client = client;
    this.scopes = scopes;
  }

  /**
   * Gets the client for this consent.
   *
   * @return the client for this consent.
   */
  public OAuth2Client getClient()
  {
    return client;
  }

  /**
   * Gets the scopes for this consent.
   *
   * @return the scopes for this consent.
   */
  public List getScopes()
  {
    return scopes;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean equals(final Object o)
  {
    if (this == o)
    {
      return true;
    }

    if (o == null || getClass() != o.getClass())
    {
      return false;
    }

    if (!super.equals(o))
    {
      return false;
    }

    Consent consent = (Consent) o;

    if (client != null ? !client.equals(consent.client) :
        consent.client != null)
    {
      return false;
    }

    return !(scopes != null ? !scopes.equals(consent.scopes) :
        consent.scopes != null);

  }

  /**
   * {@inheritDoc}
   */
  @Override
  public int hashCode()
  {
    int result = super.hashCode();
    result = 31 * result + (client != null ? client.hashCode() : 0);
    result = 31 * result + (scopes != null ? scopes.hashCode() : 0);
    return result;
  }

}