org.jsondoc.core.annotation

Annotation Type ApiAuthToken

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

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

Author:

Fabio Maffioletti

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	roles The role(s) a user must have to correctly access the annotated controller/method.
String	scheme The default scheme placed at the beginning of the Authorization header
String[]	testtokens A list of test tokens that can be used to test methods

Element Detail

roles

public abstract String[] roles

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

Returns:

Default:

"*"

testtokens

public abstract String[] testtokens

A list of test tokens that can be used to test methods

Returns:

Default:

{}

scheme

public abstract String scheme

The default scheme placed at the beginning of the Authorization header

Returns:

Default:

""