capital.scalable.restdocs.misc

Class AuthorizationSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

capital.scalable.restdocs.misc.AuthorizationSnippet

All Implemented Interfaces:

SectionSupport, org.springframework.restdocs.snippet.Snippet

public class AuthorizationSnippet
extends org.springframework.restdocs.snippet.TemplatedSnippet
implements SectionSupport

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHORIZATION

Constructor Summary

Constructors

Constructor and Description
AuthorizationSnippet(String defaultAuthorization)

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,Object>	createModel(org.springframework.restdocs.operation.Operation operation)
static org.springframework.mock.web.MockHttpServletRequest	documentAuthorization(org.springframework.mock.web.MockHttpServletRequest request, String authorization)
String	getFileName() File name (= section name).
String	getHeaderKey() Section header key corresponding to entry in translation file.
boolean	hasContent(org.springframework.restdocs.operation.Operation operation) Flag if section will render non-empty content.

Methods inherited from class org.springframework.restdocs.snippet.TemplatedSnippet

document, getAttributes, getSnippetName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AUTHORIZATION

public static final String AUTHORIZATION

See Also:

Constant Field Values

Constructor Detail

AuthorizationSnippet

public AuthorizationSnippet(String defaultAuthorization)

Method Detail

createModel

protected Map<String,Object> createModel(org.springframework.restdocs.operation.Operation operation)

Specified by:

createModel in class org.springframework.restdocs.snippet.TemplatedSnippet

documentAuthorization

public static org.springframework.mock.web.MockHttpServletRequest documentAuthorization(org.springframework.mock.web.MockHttpServletRequest request,
                                                                        String authorization)

getFileName

public String getFileName()

Description copied from interface: SectionSupport

File name (= section name).

Specified by:

getFileName in interface SectionSupport

getHeaderKey

public String getHeaderKey()

Description copied from interface: SectionSupport

Section header key corresponding to entry in translation file.

Specified by:

getHeaderKey in interface SectionSupport

hasContent

public boolean hasContent(org.springframework.restdocs.operation.Operation operation)

Description copied from interface: SectionSupport

Flag if section will render non-empty content.

Specified by:

hasContent in interface SectionSupport

Parameters:

operation - operation

Returns:

true if snippet will return non-empty content; false otherwise