com.unboundid.scim.ldap.AttributeTransformation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scim-ldap Show documentation

The UnboundID SCIM-LDAP module builds on the UnboundID SCIM-SDK to provide classes that map SCIM resources to LDAP entries and vice versa. It also contains several APIs that may be used to implement custom behaviors for the mapping configuration file to extend its capabilities above and beyond those provided out of the box. Each extension type varies in the amount of control the implementation has over the mapping process and the amount of effort required for implementation.

There is a newer version: 1.8.26

Show newest version

/*
 * Copyright 2011-2012 UnboundID Corp.
 *
 * 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.scim.ldap;

/**
 * A class representing a transformation to a specified LDAP attribute.
 */
public class AttributeTransformation
{
  private final String ldapAttribute;
  private final Transformation transformation;



  /**
   * Create a new attribute transformation.
   *
   * @param ldapAttribute   The LDAP attribute that is the subject of the
   *                        transformation.
   * @param transformation  The transformation to be applied.
   */
  public AttributeTransformation(final String ldapAttribute,
                                 final Transformation transformation)
  {
    this.ldapAttribute = ldapAttribute;
    this.transformation = transformation;
  }



  /**
   * Create a new attribute transformation from the JAXB type that represents
   * an attribute mapping.
   *
   * @param mapping  The JAXB type that represents an attribute mapping.
   *
   * @return  The new attribute transformation.
   */
  public static AttributeTransformation create(final AttributeMapping mapping)
  {
    final String ldapAttribute = mapping.getLdapAttribute();
    final Transformation transformation =
        Transformation.create(mapping.getTransform());

    return new AttributeTransformation(ldapAttribute, transformation);
  }



  /**
   * Retrieve the LDAP attribute that is the subject of the transformation.
   *
   * @return  The LDAP attribute that is the subject of the transformation.
   */
  public String getLdapAttribute()
  {
    return ldapAttribute;
  }



  /**
   * Retrieve the transformation to be applied.
   *
   * @return  The transformation to be applied.
   */
  public Transformation getTransformation()
  {
    return transformation;
  }
}