org.springframework.security.web.bind.annotation

Annotation Type AuthenticationPrincipal

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

Annotation that binds a method parameter or method return value to the Authentication.getPrincipal(). This is necessary to signal that the argument should be resolved to the current user rather than a user that might be edited on a form.

Since:

3.2

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