com.liferay.oauth2.provider.scope

Annotation Type RequiresScope

@Retention(value=RUNTIME)
public @interface RequiresScope

This annotation can be used to declare that a method on a JAX-RS resource must only be executed if the incoming request is authorized for the scopes given in the value of the annotation.

When used on JAX-RS resource class, all methods without the annotation will inherit the resource class annotation.

See Also:

RequiresNoScope

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String[]	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allNeeded

Element Detail

value

public abstract java.lang.String[] value

Returns:

The list of scopes that the request needs to be authorized for in order to execute this method

allNeeded

public abstract boolean allNeeded

Returns:

whether the returned scopes in value() all need to be authorized or only one of them. Defaults to true, which means all the specified scopes need to be authorized.

Default:

true