A B C D E F G H I L M P R S T W
All Classes All Packages

A

addFormParameter(String, String, String, Type) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Register a query parameter

addPathParameter(String, String, String, Type) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Register a path parameter

addQueryParameter(String, String, String, Type) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Register a query parameter

B

build(Class<?>, String) - Static method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Build a RestEndpoint based on a klass

C

ch.colabproject.colab.generator.plugin - package ch.colabproject.colab.generator.plugin

ch.colabproject.colab.generator.plugin.rest - package ch.colabproject.colab.generator.plugin.rest

ClientException - Exception in ch.colabproject.colab.generator.plugin.rest

4xx error

ClientException() - Constructor for exception ch.colabproject.colab.generator.plugin.rest.ClientException

ClientException(Response.Status) - Constructor for exception ch.colabproject.colab.generator.plugin.rest.ClientException

Create a client error exception

close() - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient

Close the client.

convertType(Type, Map<String, Type>) - Static method in class ch.colabproject.colab.generator.plugin.TypeScriptHelper

Convert java type to typescript type.

CookieFilter(String) - Constructor for class ch.colabproject.colab.generator.plugin.rest.RestClient.CookieFilter

New filter

D

debug(String) - Static method in class ch.colabproject.colab.generator.plugin.Logger

Print a debug message.

delete(String, GenericType<T>, String...) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient

send DELETE request.

E

error(String) - Static method in class ch.colabproject.colab.generator.plugin.Logger

Print an error message.

ErrorHandler - Interface in ch.colabproject.colab.generator.plugin.rest

Error handler

execute() - Method in class ch.colabproject.colab.generator.plugin.GeneratorPlugin

execute() - Method in class ch.colabproject.colab.generator.plugin.HelpMojo

F

FileHelper - Class in ch.colabproject.colab.generator.plugin

filter(ClientRequestContext) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient.CookieFilter

If set, add Cookie header to the request.

filter(ClientRequestContext, ClientResponseContext) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient.CookieFilter

On request response, fetch set-cookie value

FormField<T> - Class in ch.colabproject.colab.generator.plugin.rest

Represents a form field

FormField() - Constructor for class ch.colabproject.colab.generator.plugin.rest.FormField

G

generateInterface(Type, Map<String, Type>, Map<String, List<String>>, Reflections, Map<String, ClassDoc>) - Static method in class ch.colabproject.colab.generator.plugin.TypeScriptHelper

Generate typescript interface.This method will populate types map with type required by the generated interface

generateJavaClient(String, boolean) - Method in class ch.colabproject.colab.generator.plugin.Generator

One all classes have been processed with Generator.processPackages(), this method will create subdirectories that match the packageName.Then the client will be generated in the clientName.java file.

generateJavaClient(Map<String, String>, String, Map<String, ClassDoc>, Reflections) - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Write java class as string.The generated class is an inner class which has to be included in a main class.

generateTypescriptClient(String, boolean) - Method in class ch.colabproject.colab.generator.plugin.Generator

Generate typescript client in targetDir

generateTypescriptClient(Map<String, Type>, Map<String, ClassDoc>, Reflections) - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Write ts client for this controller.This method will populate types map with type which requires a dedicated TS interface

Generator - Class in ch.colabproject.colab.generator.plugin

Generator(String[]) - Constructor for class ch.colabproject.colab.generator.plugin.Generator

Initialize the client generator.

Generator(String[], String, String) - Constructor for class ch.colabproject.colab.generator.plugin.Generator

Initialize the client generator.

GeneratorPlugin - Class in ch.colabproject.colab.generator.plugin

Maven plugin to generate REST client.

GeneratorPlugin() - Constructor for class ch.colabproject.colab.generator.plugin.GeneratorPlugin

Default constructor.

get(String, GenericType<T>, String...) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient

send GET request.

getAllParameters() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get all parameters.

getBodyParam() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of bodyParam

getConsumes() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of consumes

getData() - Method in class ch.colabproject.colab.generator.plugin.rest.FormField

Get the value of data

getFormParameters() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of formParameters

getFullPath() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of fullPath

getHttpMethod() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of httpMethod

getInAnnotationName() - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Get @PathParam name

getJavadoc() - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Get the value of javadoc

getJsonBMapper() - Method in class ch.colabproject.colab.generator.plugin.Generator

get JSON-B to use.

getMimeType() - Method in class ch.colabproject.colab.generator.plugin.rest.FormField

Get the value of mimeType

getName() - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Get the value of name

getName() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of name

getPathParameters() - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Get the value of pathParameters

getPathParameters() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of pathParameters

getProduces() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of produces

getQueryParameters() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of queryParameters

getRestEndpoints() - Method in class ch.colabproject.colab.generator.plugin.Generator

Get rest service description

getRestMethods() - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Get all rest methods

getReturnType() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of returnType

getSimpleClassName() - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Get simple class name

getType() - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Get the value of type

getUrlParameters() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get URL parameters.

H

handleError(Object) - Method in interface ch.colabproject.colab.generator.plugin.rest.ErrorHandler

Error handler

HelpMojo - Class in ch.colabproject.colab.generator.plugin

Display help information on client-generator-plugin.
Call mvn client-generator:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class ch.colabproject.colab.generator.plugin.HelpMojo

I

info(String) - Static method in class ch.colabproject.colab.generator.plugin.Logger

Print a info message.

initLogger(Log) - Static method in class ch.colabproject.colab.generator.plugin.Logger

Initialize logger.

isAdminResource() - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Get the value of adminResource

isAdminResource() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of adminResource

isAuthenticationRequired() - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Get the value of authenticationRequired

isAuthenticationRequired() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of authenticationRequired

isDeprecated() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of deprecated

isInit() - Static method in class ch.colabproject.colab.generator.plugin.Logger

Check if log is initialized.

isOptional() - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Is the parameter optional?

isReturnTypeGeneric() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Get the value of returnTypeGeneric

L

Logger - Class in ch.colabproject.colab.generator.plugin

Print message with a Maven Log.

M

main(String...) - Static method in class ch.colabproject.colab.generator.plugin.GeneratorPlugin

Simple app to test the generator.it will not generate any files but will print output

P

Param - Class in ch.colabproject.colab.generator.plugin.rest

represent a REST method parameter

Param() - Constructor for class ch.colabproject.colab.generator.plugin.rest.Param

post(String, Object, GenericType<T>, String...) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient

send JSON POST request.

post(String, Map<String, FormField>, GenericType<T>, String...) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient

send multipart form POST request.

post(String, GenericType<T>, String...) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient

send POST request with an empty body.

processPackages() - Method in class ch.colabproject.colab.generator.plugin.Generator

Process all classes annotated with Path.

put(String, Object, GenericType<T>, String...) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient

send PUT request with JSON body.

put(String, Map<String, FormField>, GenericType<T>, String...) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient

send multipart form PUT request.

put(String, GenericType<T>, String...) - Method in class ch.colabproject.colab.generator.plugin.rest.RestClient

send PUT request with an empty body.

R

readFile(String) - Static method in class ch.colabproject.colab.generator.plugin.FileHelper

Read file as string

RestClient - Class in ch.colabproject.colab.generator.plugin.rest

JakartaEE-based rest client.

RestClient(String, String, Jsonb, Object...) - Constructor for class ch.colabproject.colab.generator.plugin.rest.RestClient

Create a REST client.

RestClient.CookieFilter - Class in ch.colabproject.colab.generator.plugin.rest

Cookie filter make sure the session cookie is set.

RestEndpoint - Class in ch.colabproject.colab.generator.plugin.rest

Represent a rest controller.

RestEndpoint() - Constructor for class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

RestMethod - Class in ch.colabproject.colab.generator.plugin.rest

Represent a rest method

RestMethod() - Constructor for class ch.colabproject.colab.generator.plugin.rest.RestMethod

S

ServerException - Exception in ch.colabproject.colab.generator.plugin.rest

Server 5xx error

ServerException() - Constructor for exception ch.colabproject.colab.generator.plugin.rest.ServerException

Default 500 error

ServerException(Response.Status) - Constructor for exception ch.colabproject.colab.generator.plugin.rest.ServerException

Create a server error exception

setAdminResource(boolean) - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Set the value of adminResource

setAdminResource(boolean) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of adminResource

setAuthenticationRequired(boolean) - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Set the value of authenticationRequired

setAuthenticationRequired(boolean) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of authenticationRequired

setBodyParam(Param) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of bodyParam

setConsumes(List<String>) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of consumes

setData(T) - Method in class ch.colabproject.colab.generator.plugin.rest.FormField

Set the value of data

setDeprecated(boolean) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of deprecated

setFormParameters(List<Param>) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of formParameters

setFullPath(String) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of fullPath

setHttpMethod(String) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of httpMethod

setInAnnotationName(String) - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Set the path param name

setJavadoc(String) - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Set the value of javadoc

setMimeType(MediaType) - Method in class ch.colabproject.colab.generator.plugin.rest.FormField

Set the value of mimeType

setName(String) - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Set the value of name

setName(String) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of name

setOptional(boolean) - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Set parameter optional-ness

setPathParameters(List<Param>) - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

Set the value of pathParameters

setPathParameters(List<Param>) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of pathParameters

setProduces(List<String>) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of produces

setQueryParameters(List<Param>) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of queryParameters

setReturnType(Type) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of returnType

setReturnTypeGeneric(boolean) - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

Set the value of returnTypeGeneric

setType(Type) - Method in class ch.colabproject.colab.generator.plugin.rest.Param

Set the value of type

T

toString() - Method in class ch.colabproject.colab.generator.plugin.rest.RestEndpoint

toString() - Method in class ch.colabproject.colab.generator.plugin.rest.RestMethod

TypeScriptHelper - Class in ch.colabproject.colab.generator.plugin

Some methods to convert java things to typescript ones

W

warn(String) - Static method in class ch.colabproject.colab.generator.plugin.Logger

Print a warn message.

A B C D E F G H I L M P R S T W
All Classes All Packages