net.ozwolf.raml.annotations

Annotation Type RamlSecurityScheme

@Retention(value=RUNTIME)
public @interface RamlSecurityScheme

RAML Security Scheme Annotation

Used to describe a security scheme.

Works in conjunction with the @RamlApp annotation.

Types must adhere to the allowed security schemes defined by the RAML 1.0 specification.

See Also:

RamlApp, RamlSecuredBy

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
RamlDescribedBy	describedBy The overall descriptor of the security scheme, covering required headers, query parameters and associated responses.
String	key The security scheme key.
String	type The type of security scheme.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description The description of the security scheme.
RamlOAuth1Settings	oauth1Settings Define the settings for OAuth 1.0
RamlOAuth2Settings	oauth2Settings Define the settings for OAuth 2.0

Element Detail

key

public abstract String key

The security scheme key.

This key is use with the @RamlSecuredBy annotation to link resource methods to this security scheme

Returns:

the security scheme key

type

public abstract String type

The type of security scheme.

Must adhere to the allowed types defined by the RAML specification.

Returns:

the security scheme type

describedBy

public abstract RamlDescribedBy describedBy

The overall descriptor of the security scheme, covering required headers, query parameters and associated responses.

Returns:

the security scheme descriptor

description

public abstract String description

The description of the security scheme.

Returns:

the security scheme description

Default:

""

oauth1Settings

public abstract RamlOAuth1Settings oauth1Settings

Define the settings for OAuth 1.0

Returns:

the OAuth 1.0 settings

Default:

@net.ozwolf.raml.annotations.security.RamlOAuth1Settings(requestTokenUri="", authorizationUri="", tokenCredentialsUri="")

oauth2Settings

public abstract RamlOAuth2Settings oauth2Settings

Define the settings for OAuth 2.0

Returns:

the OAuth 2.0 settings

Default:

@net.ozwolf.raml.annotations.security.RamlOAuth2Settings(authorizationUri="", authorizationGrants="", accessTokenUri="")