org.camunda.bpm.engine.impl.identity.Authentication Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-bpm-engine-api Show documentation

There is a newer version: 7.22.0

Show newest version

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; 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.camunda.bpm.engine.impl.identity;

import java.util.ArrayList;
import java.util.List;


/**
 * Allows to expose the id of the currently authenticated user,
 * his groups and his tenants to the process engine.
 *
 * The current authentication is managed using a Thread Local. The value can
 * be set using {@link #setCurrentAuthentication(String, List)},
 * retrieved using {@link #getCurrentAuthentication()} and cleared
 * using {@link #clearCurrentAuthentication()}.
 *
 * Users typically do not use this class directly but rather use
 * the corresponding Service API methods:
 * 

 * 
 * 
 * 
 *
 * @author Tom Baeyens
 * @author Daniel Meyer
 */
public class Authentication {

  protected String authenticatedUserId;
  protected List authenticatedGroupIds;
  protected List authenticatedTenantIds;

  public Authentication() {
  }

  public Authentication(String authenticatedUserId, List groupIds) {
    this(authenticatedUserId, groupIds, null);
  }

  public Authentication(String authenticatedUserId, List authenticatedGroupIds, List authenticatedTenantIds) {
    this.authenticatedUserId = authenticatedUserId;

    if (authenticatedGroupIds != null) {
      this.authenticatedGroupIds = new ArrayList(authenticatedGroupIds);
    }

    if (authenticatedTenantIds != null) {
      this.authenticatedTenantIds = new ArrayList(authenticatedTenantIds);
    }
  }

  public List getGroupIds() {
    return authenticatedGroupIds;
  }

  public String getUserId() {
    return authenticatedUserId;
  }

  public List getTenantIds() {
    return authenticatedTenantIds;
  }

}