org.everit.authentication.simple.SimpleSubjectManager 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;

/**
 * The service interface for {@link SimpleSubject} management.
 */
public interface SimpleSubjectManager {

  /**
   * Creates a {@link SimpleSubject} linked to the given resourceId.
   *
   * @param resourceId
   *          The ID of the resource to assign to the {@link SimpleSubject}.
   * @param principal
   *          The unique principal of the {@link SimpleSubject}.
   * @param plainCredential
   *          The secret plain credential (password, private key, etc.). null if the
   *          credential is not available at this point. A {@link SimpleSubject} with
   *          null credential won't be authenticated.
   * @return The simple subject.
   */
  SimpleSubject create(long resourceId, String principal, String plainCredential);

  /**
   * Deletes the simple subject by principal.
   *
   * @param principal
   *          The principal of the simple subject.
   * @return true if the simple subject was deleted successfully, otherwise
   *         false.
   */
  boolean delete(String principal);

  /**
   * Returns the encrypted credential of the {@link SimpleSubject} assigned to the given principal.
   * This method is generally used by credential matchers.
   *
   * @param principal
   *          The principal of the {@link SimpleSubject}.
   * @return The encrypted principal or null if no {@link SimpleSubject} exists with
   *         the given principal or the encrypted credential of the {@link SimpleSubject} is
   *         null.
   */
  String readEncryptedCredential(String principal);

  /**
   * Returns the {@link SimpleSubject} assigned to the given principal.
   *
   * @param principal
   *          The principal of the {@link SimpleSubject}.
   * @return The {@link SimpleSubject} or null if no {@link SimpleSubject} found.
   */
  SimpleSubject readSimpleSubjectByPrincipal(String principal);

  /**
   * Updates the credential of a {@link SimpleSubject}.
   *
   * @param principal
   *          The principal of the {@link SimpleSubject}.
   * @param newPlainCredential
   *          The new plain credential of the {@link SimpleSubject}. A {@link SimpleSubject} with
   *          null credential won't be authenticated.
   * @return true if the update was successful, otherwise false.
   */
  boolean updateCredential(String principal, String newPlainCredential);

  /**
   * Updates the credential of a {@link SimpleSubject} if the original plain credential matches the
   * actual credential of the {@link SimpleSubject}.
   *
   * @param principal
   *          The principal of the {@link SimpleSubject}.
   * @param originalPlainCredential
   *          The original plain credential of the {@link SimpleSubject} used to match the actual
   *          credential.
   * @param newPlainCredential
   *          The new plain credential of the {@link SimpleSubject}.
   * @return true if the update was successful, otherwise false.
   */
  boolean updateCredential(String principal, String originalPlainCredential,
      String newPlainCredential);

  /**
   * Updates the principal of a {@link SimpleSubject}.
   *
   * @param principal
   *          The principal of the {@link SimpleSubject}.
   * @param newPrincipal
   *          The new unique principal of the {@link SimpleSubject}.
   * @return true if the update was successful, otherwise false.
   */
  boolean updatePrincipal(String principal, String newPrincipal);

}