org.everit.authentication.simple.SimpleSubject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.everit.authentication.simple Show documentation
Principal and credential based authentication.
The newest version!
/*
 * Copyright (C) 2011 Everit Kft. (http://www.everit.biz)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.everit.authentication.simple;

import javax.annotation.Generated;

/**
 * A principal and credential based subject assigned to a resource. This can be a base of a user in
 * a system.
 */
public class SimpleSubject {

  /**
   * The unique principal of the simple subject. For e.g. user name, email address.
   */
  public final String principal;

  /**
   * The resource ID assigned to the simple subject.
   */
  public final long resourceId;

  /**
   * The ID of the simple subject.
   */
  public final long simpleSubjectId;

  /**
   * Constructor.
   *
   * @param simpleSubjectId
   *          The ID of the simple subject.
   * @param principal
   *          The unique principal of the simple subject. For e.g. user name, email address.
   * @param resourceId
   *          The resource ID assigned to the simple subject.
   */
  public SimpleSubject(final long simpleSubjectId, final String principal, final long resourceId) {
    super();
    this.simpleSubjectId = simpleSubjectId;
    this.principal = principal;
    this.resourceId = resourceId;
  }

  @Override
  @Generated("Eclipse")
  public boolean equals(final Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    SimpleSubject other = (SimpleSubject) obj;
    if (principal == null) {
      if (other.principal != null) {
        return false;
      }
    } else if (!principal.equals(other.principal)) {
      return false;
    }
    if (resourceId != other.resourceId) {
      return false;
    }
    if (simpleSubjectId != other.simpleSubjectId) {
      return false;
    }
    return true;
  }

  @Override
  @Generated("Eclipse")
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = (prime * result) + ((principal == null) ? 0 : principal.hashCode());
    result = (prime * result) + (int) (resourceId ^ (resourceId >>> 32));
    result = (prime * result) + (int) (simpleSubjectId ^ (simpleSubjectId >>> 32));
    return result;
  }

  @Override
  @Generated("Eclipse")
  public String toString() {
    return "SimpleSubject [principal=" + principal + ", resourceId=" + resourceId
        + ", simpleSubjectId=" + simpleSubjectId + "]";
  }

}