A G H I M N O P Q R S W

A

AnnotationMap - Class in org.restdoc.server.impl

a map of annotations

AnnotationMap(Annotation[]) - Constructor for class org.restdoc.server.impl.AnnotationMap

G

getAnnotation(Class<T>) - Method in class org.restdoc.server.impl.AnnotationMap

getAuthEndpoint() - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

getClientaccess() - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

getConsumesMediaType(Method) - Static method in class org.restdoc.server.impl.util.MediaTypeResolver

getGrants() - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

getProducesMediaType(Method) - Static method in class org.restdoc.server.impl.util.MediaTypeResolver

getRestDocResources() - Method in interface org.restdoc.server.impl.IProvideRestDoc

getRestDocSchemas() - Method in interface org.restdoc.server.impl.IProvideRestDoc

getRestDocStringForPath(String) - Method in class org.restdoc.server.impl.RestDocGenerator

getSchemaFromType(Type, Map<String, Schema>, IRestDocGeneratorExtension) - Static method in class org.restdoc.server.impl.util.SchemaResolver

same as getSchemaFromClassOrNull but throws RestDocException if no schema is found

getSchemaFromTypeOrNull(Type, Map<String, Schema>, IRestDocGeneratorExtension) - Static method in class org.restdoc.server.impl.util.SchemaResolver

getSize(String, Class<?>, Type, Annotation[], MediaType) - Method in class org.restdoc.server.impl.RestDocProvider

getTokenEndpoint() - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

H

hasAnnotation(Class<? extends Annotation>) - Method in class org.restdoc.server.impl.AnnotationMap

hasAnnotation(Class<? extends Annotation>...) - Method in class org.restdoc.server.impl.AnnotationMap

headerParam(String, HeaderDefinition, Type, AnnotationMap) - Method in interface org.restdoc.server.impl.IRestDocGeneratorExtension

invoked for every header parameter

headerParam(String, HeaderDefinition, Type, AnnotationMap) - Method in class org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

I

init(Class<?>[], GlobalHeader, String) - Method in class org.restdoc.server.impl.RestDocGenerator

initialize the RestDoc Generator

IProvideRestDoc - Interface in org.restdoc.server.impl

This class provide methods to retrieve the RestDoc without parsing the Annotations

IRestDocGeneratorExtension - Interface in org.restdoc.server.impl

isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in class org.restdoc.server.impl.RestDocProvider

M

MediaTypeResolver - Class in org.restdoc.server.impl.util

Copyright 2013 Cinovo AG

N

newMethod(RestResource, MethodDefinition, Method) - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

newMethod(RestResource, MethodDefinition, Method) - Method in interface org.restdoc.server.impl.IRestDocGeneratorExtension

invoked for every method

newMethod(RestResource, MethodDefinition, Method) - Method in class org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

newResource(RestResource) - Method in interface org.restdoc.server.impl.IRestDocGeneratorExtension

invoked on every new rest resource

newResource(RestResource) - Method in class org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

newSchema(String, Schema, Class<?>) - Method in interface org.restdoc.server.impl.IRestDocGeneratorExtension

invoked for every used schema class

newSchema(String, Schema, Class<?>) - Method in class org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

O

OAuth2Extension - Class in org.restdoc.server.ext.oauth2

OAuth2Extension() - Constructor for class org.restdoc.server.ext.oauth2.OAuth2Extension

OAuth2Extension(String, String, String...) - Constructor for class org.restdoc.server.ext.oauth2.OAuth2Extension

org.restdoc.server.ext.oauth2 - package org.restdoc.server.ext.oauth2

org.restdoc.server.impl - package org.restdoc.server.impl

org.restdoc.server.impl.util - package org.restdoc.server.impl.util

P

parseMethodParameter(List<String>, Map<String, HeaderDefinition>, Map<String, ParamDefinition>, Type, Annotation[]) - Method in class org.restdoc.server.impl.RestDocGenerator

pathParam(String, ParamDefinition, Type, AnnotationMap) - Method in interface org.restdoc.server.impl.IRestDocGeneratorExtension

invoked for every path parameter

pathParam(String, ParamDefinition, Type, AnnotationMap) - Method in class org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

Q

queryParam(String, ParamDefinition, Type, AnnotationMap) - Method in interface org.restdoc.server.impl.IRestDocGeneratorExtension

invoked for every query parameter

queryParam(String, ParamDefinition, Type, AnnotationMap) - Method in class org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

R

registerGeneratorExtension(IRestDocGeneratorExtension) - Method in class org.restdoc.server.impl.RestDocGenerator

renderDoc(String, RestDoc) - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

renderDoc(String, RestDoc) - Method in interface org.restdoc.server.impl.IRestDocGeneratorExtension

invoked of RestDoc generation

renderDoc(String, RestDoc) - Method in class org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

RestDocException - Exception in org.restdoc.server.impl

Exception thrown by the framework on errors

RestDocException(String, Throwable) - Constructor for exception org.restdoc.server.impl.RestDocException

RestDocException(String) - Constructor for exception org.restdoc.server.impl.RestDocException

RestDocException(Throwable) - Constructor for exception org.restdoc.server.impl.RestDocException

RestDocGenerator - Class in org.restdoc.server.impl

Use this class to generate RestDoc

RestDocGenerator() - Constructor for class org.restdoc.server.impl.RestDocGenerator

RestDocGeneratorExtensionAdapter - Class in org.restdoc.server.impl

RestDocGeneratorExtensionAdapter() - Constructor for class org.restdoc.server.impl.RestDocGeneratorExtensionAdapter

RestDocProvider - Class in org.restdoc.server.impl

Copyright 2013 Taimos

https://issues.apache.org/jira/browse/CXF-4996

RestDocProvider() - Constructor for class org.restdoc.server.impl.RestDocProvider

S

SchemaResolver - Class in org.restdoc.server.impl.util

Copyright 2013 Cinovo AG

Scopes - Annotation Type in org.restdoc.server.ext.oauth2

setAuthEndpoint(String) - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

setClientaccess(String) - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

setGrants(String[]) - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

setTokenEndpoint(String) - Method in class org.restdoc.server.ext.oauth2.OAuth2Extension

W

writeTo(String, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in class org.restdoc.server.impl.RestDocProvider

A G H I M N O P Q R S W