PrincipalSid.java

/*
 * Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
 *
 * 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.springframework.security.acls.domain;

import org.springframework.security.acls.model.Sid;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.userdetails.UserDetails;

import org.springframework.util.Assert;

/**
 * Represents an <code>Authentication.getPrincipal()</code> as a <code>Sid</code>.
 * <p>
 * This is a basic implementation that simply uses the <code>String</code>-based principal
 * for <code>Sid</code> comparison. More complex principal objects may wish to provide an
 * alternative <code>Sid</code> implementation that uses some other identifier.
 * </p>
 *
 * @author Ben Alex
 */
public class PrincipalSid implements Sid {
	// ~ Instance fields
	// ================================================================================================

	private final String principal;

	// ~ Constructors
	// ===================================================================================================

	public PrincipalSid(String principal) {
		Assert.hasText(principal, "Principal required");
		this.principal = principal;
	}

	public PrincipalSid(Authentication authentication) {
		Assert.notNull(authentication, "Authentication required");
		Assert.notNull(authentication.getPrincipal(), "Principal required");

		if (authentication.getPrincipal() instanceof UserDetails) {
			this.principal = ((UserDetails) authentication.getPrincipal()).getUsername();
		}
		else {
			this.principal = authentication.getPrincipal().toString();
		}
	}

	// ~ Methods
	// ========================================================================================================

	public boolean equals(Object object) {
		if ((object == null) || !(object instanceof PrincipalSid)) {
			return false;
		}

		// Delegate to getPrincipal() to perform actual comparison (both should be
		// identical)
		return ((PrincipalSid) object).getPrincipal().equals(this.getPrincipal());
	}

	public int hashCode() {
		return this.getPrincipal().hashCode();
	}

	public String getPrincipal() {
		return principal;
	}

	public String toString() {
		return "PrincipalSid[" + this.principal + "]";
	}
}