org.restdoc.server.ext.oauth2

Class OAuth2Extension

java.lang.Object

org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

org.restdoc.server.ext.oauth2.OAuth2Extension

All Implemented Interfaces:

IRestDocGeneratorExtension

public class OAuth2Extension
extends RestDocGeneratorExtensionAdapter

Constructor Summary

Constructors

Constructor and Description
OAuth2Extension()
OAuth2Extension(String tokenEndpoint, String authEndpoint, String... grants)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthEndpoint()
String	getClientaccess()
String[]	getGrants()
String	getTokenEndpoint()
void	newMethod(org.restdoc.api.RestResource restResource, org.restdoc.api.MethodDefinition def, Method method) invoked for every method
void	renderDoc(String path, org.restdoc.api.RestDoc doc) invoked of RestDoc generation
void	setAuthEndpoint(String authEndpoint)
void	setClientaccess(String clientaccess)
void	setGrants(String[] grants)
void	setTokenEndpoint(String tokenEndpoint)

Methods inherited from class org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

headerParam, newResource, newSchema, pathParam, queryParam

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2Extension

public OAuth2Extension()

OAuth2Extension

public OAuth2Extension(String tokenEndpoint,
               String authEndpoint,
               String... grants)

Parameters:

tokenEndpoint -

authEndpoint -

grants -

Method Detail

getClientaccess

public String getClientaccess()

setClientaccess

public void setClientaccess(String clientaccess)

getGrants

public String[] getGrants()

setGrants

public void setGrants(String[] grants)

getTokenEndpoint

public String getTokenEndpoint()

setTokenEndpoint

public void setTokenEndpoint(String tokenEndpoint)

getAuthEndpoint

public String getAuthEndpoint()

setAuthEndpoint

public void setAuthEndpoint(String authEndpoint)

newMethod

public void newMethod(org.restdoc.api.RestResource restResource,
             org.restdoc.api.MethodDefinition def,
             Method method)

Description copied from interface: IRestDocGeneratorExtension

invoked for every method

Specified by:

newMethod in interface IRestDocGeneratorExtension

Overrides:

newMethod in class RestDocGeneratorExtensionAdapter

Parameters:

restResource - the super resource

def - the MethodDefinition

method - the Java reflection Method

renderDoc

public void renderDoc(String path,
             org.restdoc.api.RestDoc doc)

Description copied from interface: IRestDocGeneratorExtension

invoked of RestDoc generation

Specified by:

renderDoc in interface IRestDocGeneratorExtension

Overrides:

renderDoc in class RestDocGeneratorExtensionAdapter

Parameters:

path - the requested path

doc - the generated doc