org.jsondoc.core.annotation

Annotation Type ApiAuthBasic

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

This annotation is to be used on your "service" class, for example controllers, or on exposed methods. It specifies that the controller/method needs basic authentication.

Author:

Fabio Maffioletti

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	roles The role(s) a user must have to correctly access the annotated controller/method

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
ApiAuthBasicUser[]	testusers A list of test users that can be used to test methods with different username/password/roles combinations

Element Detail

roles

public abstract String[] roles

The role(s) a user must have to correctly access the annotated controller/method

Returns:

testusers

public abstract ApiAuthBasicUser[] testusers

A list of test users that can be used to test methods with different username/password/roles combinations

Returns:

Default:

{}