org.springframework.security.core.annotation

Annotation Type AuthenticationPrincipal

@Target(value={PARAMETER,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
public @interface AuthenticationPrincipal

Annotation that is used to resolve Authentication.getPrincipal() to a method argument.

Since:

4.0 See: AuthenticationPrincipalArgumentResolver

Author:

Rob Winch

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	errorOnInvalidType True if a ClassCastException should be thrown when the current Authentication.getPrincipal() is the incorrect type.

Element Detail

errorOnInvalidType

public abstract boolean errorOnInvalidType

True if a ClassCastException should be thrown when the current Authentication.getPrincipal() is the incorrect type. Default is false.

Returns:

Default:

false