WebSpherePreAuthenticatedAuthenticationDetailsSource.java :  » J2EE » spring-ide_2.3.0 » org » springframework » security » ui » preauth » websphere » Java Open Source

package org.springframework.security.ui.preauth.websphere;

import java.util.Arrays;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.security.GrantedAuthority;
import org.springframework.security.MutableGrantedAuthoritiesContainer;
import org.springframework.security.authoritymapping.Attributes2GrantedAuthoritiesMapper;
import org.springframework.security.authoritymapping.SimpleAttributes2GrantedAuthoritiesMapper;
import org.springframework.security.ui.AuthenticationDetailsSourceImpl;
import org.springframework.security.ui.preauth.PreAuthenticatedGrantedAuthoritiesAuthenticationDetails;
import org.springframework.util.Assert;

/**
 * This AuthenticationDetailsSource implementation, when configured with a MutableGrantedAuthoritiesContainer,
 * will set the pre-authenticated granted authorities based on the WebSphere groups for the current WebSphere
 * user, mapped using the configured Attributes2GrantedAuthoritiesMapper.
 * 
 * By default, this class is configured to build instances of the
 * PreAuthenticatedGrantedAuthoritiesAuthenticationDetails class.
 * 
 * @author Ruud Senden
 */
public class WebSpherePreAuthenticatedAuthenticationDetailsSource extends AuthenticationDetailsSourceImpl implements InitializingBean {
  private static final Log LOG = LogFactory.getLog(WebSpherePreAuthenticatedAuthenticationDetailsSource.class);

  private Attributes2GrantedAuthoritiesMapper webSphereGroups2GrantedAuthoritiesMapper = new SimpleAttributes2GrantedAuthoritiesMapper();

  /**
   * Public constructor which overrides the default AuthenticationDetails
   * class to be used.
   */
  public WebSpherePreAuthenticatedAuthenticationDetailsSource() {
    super.setClazz(PreAuthenticatedGrantedAuthoritiesAuthenticationDetails.class);
  }

  /**
   * Check that all required properties have been set.
   */
  public void afterPropertiesSet() throws Exception {
    Assert.notNull(webSphereGroups2GrantedAuthoritiesMapper, "WebSphere groups to granted authorities mapper not set");
  }

  /**
   * Build the authentication details object. If the speficied authentication
   * details class implements the PreAuthenticatedGrantedAuthoritiesSetter, a
   * list of pre-authenticated Granted Authorities will be set based on the
   * WebSphere groups for the current user.
   * 
   * @see org.springframework.security.ui.AuthenticationDetailsSource#buildDetails(Object)
   */
  public Object buildDetails(Object context) {
    Object result = super.buildDetails(context);
    if (result instanceof MutableGrantedAuthoritiesContainer) {
      ((MutableGrantedAuthoritiesContainer) result)
          .setGrantedAuthorities(getWebSphereGroupsBasedGrantedAuthorities());
    }
    return result;
  }

  /**
   * Get a list of Granted Authorities based on the current user's WebSphere groups.
   * 
   * @return GrantedAuthority[] mapped from the user's WebSphere groups.
   */
  private GrantedAuthority[] getWebSphereGroupsBasedGrantedAuthorities() {
    String[] webSphereGroups = WASSecurityHelper.getGroupsForCurrentUser();
    GrantedAuthority[] userGas = webSphereGroups2GrantedAuthoritiesMapper.getGrantedAuthorities(webSphereGroups);
    if (LOG.isDebugEnabled()) {
      LOG.debug("WebSphere groups: " + Arrays.asList(webSphereGroups) + " mapped to Granted Authorities: "
          + Arrays.asList(userGas));
    }
    return userGas;
  }

  /**
   * @param mapper
   *            The Attributes2GrantedAuthoritiesMapper to use
   */
  public void setWebSphereGroups2GrantedAuthoritiesMapper(Attributes2GrantedAuthoritiesMapper mapper) {
    webSphereGroups2GrantedAuthoritiesMapper = mapper;
  }

}