src/com/google/enterprise/secmgr/config/AuthnMechSaml.java

// Copyright 2009 Google Inc.
//
// 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 com.google.enterprise.secmgr.config;

import com.google.common.base.Objects;
import com.google.common.base.Predicate;
import com.google.common.collect.ImmutableList;
import com.google.enterprise.secmgr.json.ProxyTypeAdapter;
import com.google.gson.GsonBuilder;

import java.util.List;

import javax.annotation.concurrent.Immutable;

/**
 * The configuration of a SAML authentication mechanism.
 */
@Immutable
public final class AuthnMechSaml extends AuthnMechanism {

  public static final String TYPE_NAME = "SAML";

  private final String entityId;

  public static AuthnMechSaml make(String name, String entityId) {
    return new AuthnMechSaml(name, entityId);
  }

  private AuthnMechSaml(String name, String entityId) {
    super(name);
    this.entityId = checkString(entityId);
  }

  public static AuthnMechSaml makeEmpty() {
    return new AuthnMechSaml();
  }

  private AuthnMechSaml() {
    super();
    this.entityId = null;
  }

  @Override
  public String getTypeName() {
    return TYPE_NAME;
  }

  @Override
  public List<CredentialTransform> getCredentialTransforms() {
    return ImmutableList.of(
        CredentialTransform.make(CredentialTypeSet.NONE, CredentialTypeSet.VERIFIED_PRINCIPAL));
  }

  @Override
  public AuthnMechanism copyWithNewName(String name) {
    return make(name, getEntityId());
  }

  @Override
  public boolean equals(Object object) {
    if (object == this) { return true; }
    if (!(object instanceof AuthnMechSaml)) { return false; }
    AuthnMechSaml mech = (AuthnMechSaml) object;
    return super.equals(mech)
        && Objects.equal(entityId, mech.getEntityId());
  }

  @Override
  public int hashCode() {
    return super.hashCode(entityId);
  }

  /**
   * Get the SAML entity ID for this authority.  This ID is used as a key when
   * looking up SAML metadata that describes the authority.
   *
   * @return The SAML entity ID as a string, never null or empty, normally a URI.
   */
  public String getEntityId() {
    return entityId;
  }

  public static final Predicate<AuthnMechanism> SAML_PREDICATE = new Predicate<AuthnMechanism>() {
    public boolean apply(AuthnMechanism config) {
      return (config instanceof AuthnMechSaml);
    }
  };

  static void registerTypeAdapters(GsonBuilder builder) {
    builder.registerTypeAdapter(AuthnMechSaml.class,
        ProxyTypeAdapter.make(AuthnMechSaml.class, LocalProxy.class));
  }

  private static final class LocalProxy extends MechanismProxy<AuthnMechSaml> {
    String entityId;

    @SuppressWarnings("unused")
    LocalProxy() {
    }

    @SuppressWarnings("unused")
    LocalProxy(AuthnMechSaml mechanism) {
      super(mechanism);
      entityId = mechanism.getEntityId();
    }

    @Override
    public AuthnMechSaml build() {
      return make(name, entityId);
    }
  }
}