com.peterphi.std.guice.common.auth.annotations

Annotation Type AuthConstraint

@Target(value={METHOD,TYPE})
@Retention(value=RUNTIME)
public @interface AuthConstraint

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	comment The description of this constraint (which can be displayed to users to help explain why they have been denied access)
java.lang.String	id The id of this authentication constraint; designed to allow configuration to override the constraints in the annotation
java.lang.String	role The role the user must have (defaults to "user").
boolean	skip If true, authentication will not be enforced on calls made to the annotation target

Element Detail

id

public abstract java.lang.String id

The id of this authentication constraint; designed to allow configuration to override the constraints in the annotation

Returns:

Default:

"all"

skip

public abstract boolean skip

If true, authentication will not be enforced on calls made to the annotation target

Returns:

Default:

false

role

public abstract java.lang.String role

The role the user must have (defaults to "user"). If the user does not hold this role then an authentication exception will be raised

Returns:

Default:

"user"

comment

public abstract java.lang.String comment

The description of this constraint (which can be displayed to users to help explain why they have been denied access)

Returns:

Default:

""