org.jasig.cas.authentication.handler

Class PrefixSuffixPrincipalNameTransformer

java.lang.Object

org.jasig.cas.authentication.handler.PrefixSuffixPrincipalNameTransformer

All Implemented Interfaces:

PrincipalNameTransformer

public final class PrefixSuffixPrincipalNameTransformer
extends Object
implements PrincipalNameTransformer

Transform the user id by adding a prefix or suffix.

Since:

3.3.6

Version:

$Revision$ $Date$

Author:

Howard Gilbert, Scott Battaglia

Constructor Summary

Constructors

Constructor and Description
PrefixSuffixPrincipalNameTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
void	setPrefix(String prefix)
void	setSuffix(String suffix)
String	transform(String formUserId) Transform the string typed into the login form into a tentative Principal Name to be validated by a specific type of Authentication Handler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrefixSuffixPrincipalNameTransformer

public PrefixSuffixPrincipalNameTransformer()

Method Detail

transform

public String transform(String formUserId)

Description copied from interface: PrincipalNameTransformer

Transform the string typed into the login form into a tentative Principal Name to be validated by a specific type of Authentication Handler.

The Principal Name eventually assigned by the CredentialsToPrincipalResolver may be unqualified ("AENewman"). However, validation of the Principal name against a particular backend source represented by a particular Authentication Handler may require transformation to a temporary fully qualified format such as AENewman@MAD.DCCOMICS.COM or MAD\AENewman. After validation, this form of the Principal name is discarded in favor of the choice made by the Resolver.

Specified by:

transform in interface PrincipalNameTransformer

Parameters:

formUserId - The raw userid typed into the login form

Returns:

the string that the Authentication Handler should lookup in the backend system

setPrefix

public void setPrefix(String prefix)

setSuffix

public void setSuffix(String suffix)