Package org.springframework.security.web.bind.annotation

Annotation Type AuthenticationPrincipal

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

Deprecated.

Use AuthenticationPrincipal instead.

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	Description
boolean	errorOnInvalidType	Deprecated. True if a ClassCastException should be thrown when the current Authentication.getPrincipal() is the incorrect type.

Element Detail

errorOnInvalidType

boolean errorOnInvalidType

Deprecated.

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

Returns:

Default:

false