org.soulwing.cas.transformer.DistinguishedToSimpleNameTransformer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cas-subsystem Show documentation

Wildfly subsystem that monitors web application deployments and attaches CAS authentication support.

There is a newer version: 2.0.3

/*
 * File created on Feb 25, 2015 
 *
 * Copyright (c) 2014 Virginia Polytechnic Institute and State University
 *
 * 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.soulwing.cas.transformer;

import java.util.Properties;

import javax.naming.InvalidNameException;
import javax.naming.ldap.LdapName;
import javax.naming.ldap.Rdn;
import javax.xml.transform.Transformer;

import org.soulwing.cas.api.AttributeTransformer;

/**
 * An {@link AttributeTransformer} that returns the common name component
 * of a distinguished name value.
 *
 * @author Carl Harris
 */
public class DistinguishedToSimpleNameTransformer
    extends AttributeTransformer {

  public static final String NAME_COMPONENT = "name-component";
  public static final String FAIL_ON_ERROR = "fail-on-error";
  public static final String DEFAULT_NAME_COMPONENT = "cn";
  
  private String nameComponent;
  private boolean failOnError;
  
  /**
   * {@inheritDoc}
   */
  @Override
  public void initialize(Properties properties) { 
    super.initialize(properties);    
    nameComponent = properties.getProperty(NAME_COMPONENT, 
        DEFAULT_NAME_COMPONENT); 
    failOnError = Boolean.parseBoolean(properties.getProperty(FAIL_ON_ERROR, 
        Boolean.FALSE.toString()));
  }
  
  /**
   * {@inheritDoc}
   */
  @Override
  public String transform(String value) {
    try {
      LdapName name = new LdapName(value);
      for (Rdn rdn : name.getRdns()) {
        if (nameComponent.equalsIgnoreCase(rdn.getType())) {
          return rdn.getValue().toString();
        }
      }
      if (!failOnError) return value;
      throw new IllegalArgumentException("does not contain a '" 
          + nameComponent + "' component: '" + value + "'");      
    }
    catch (InvalidNameException ex) {
      if (!failOnError) return value;
      throw new IllegalArgumentException("not a valid LDAP name: '" + value 
          + "'");
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public String toString() {
    return String.format("%s(%s=%s, %s=%s)",
        getClass().getSimpleName().replaceFirst(
            Transformer.class.getSimpleName() + "$", ""),
            NAME_COMPONENT, nameComponent,
            FAIL_ON_ERROR, failOnError);
  }

}