aQute.openapi.provider

Class OpenAPIContext

java.lang.Object

aQute.openapi.provider.OpenAPIContext

public class OpenAPIContext
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenAPIContext(OpenAPIRuntime runtime, Dispatcher dispatcher, HttpServletRequest request, HttpServletResponse response)

Method Summary

Modifier and Type	Method and Description
void	begin(int i)
void	begin(java.lang.String name)
<T> T	body(java.lang.Class<T> type)
<T> T	call(java.util.concurrent.Callable<T> callable)
void	checkPermission(java.lang.String name, java.lang.String... resource)
void	copy(java.io.InputStream in, java.lang.String mime)
java.lang.String[]	csv(java.lang.String value)
java.lang.String[]	csv(java.lang.String[] parameters)
boolean	doOptions(java.lang.String... methods)
void	end()
protected void	escapeCommas(java.lang.StringBuilder sb, java.lang.String s)
java.lang.String	formData(java.lang.String name)
java.lang.String[]	formDataArray(java.lang.String name)
java.lang.String	getOperation()
java.lang.String	getOriginalIP()
HttpServletRequest	getRequest()
HttpServletResponse	getResponse()
java.lang.String	getURL()
java.lang.String	getUser()
boolean	hasPermission(java.lang.String action, java.lang.String... arguments)
java.lang.String	header(java.lang.String name)
java.lang.String[]	headers(java.lang.String name)
boolean	in(java.lang.String value, java.lang.String... sortedSet)
protected boolean	isBeginStatus()
boolean	isEncrypted()
boolean	isMethod(OpenAPIBase.Method method)
<T> java.util.List<T>	listBody(java.lang.Class<T> componentType)
OpenAPIBase.Method	method()
<T> java.util.Optional<T>	optional(T value)
OpenAPIContext	or()
java.lang.String	parameter(java.lang.String name)
java.lang.String[]	parameters(java.lang.String parameter)
OpenAPIBase.Part	part(java.lang.String key)
java.lang.String	path()
java.lang.String	path(java.lang.String id)
void	pathParameter(java.lang.String key, java.lang.String value)
java.lang.String[]	pipes(java.lang.String value)
java.lang.String[]	pipes(java.lang.String[] parameters)
void	report(java.lang.Exception e)
boolean	require(java.lang.Object value, java.lang.String name)
protected void	securityException(java.lang.String name, java.lang.String message)
void	setOperation(java.lang.String operation)
void	setResult(java.lang.Object result, int resultCode)
void	setUser(java.lang.String user)
java.lang.String[]	ssv(java.lang.String value)
java.lang.String[]	ssv(java.lang.String[] parameters)
<T> java.util.List<T>	toArray(java.lang.Class<T> type, java.lang.String[] values)
java.lang.Boolean	toBoolean(java.lang.String value)
java.time.LocalDate	toDate(java.lang.String parameter)
java.lang.Double	toDouble(java.lang.String value)
<T extends java.lang.Enum<T>> T	toEnumMember(java.lang.Class<T> eClass, java.lang.String value)
java.lang.Integer	toInt(java.lang.String value)
java.lang.Long	toLong(java.lang.String value)
java.lang.Long	toLongDateTime(java.lang.String value)
char[]	toPassword(java.lang.String value)
java.lang.String	toString(java.lang.String value)
java.lang.String[]	tsv(java.lang.String value)
java.lang.String[]	tsv(java.lang.String[] parameters)
boolean	validate(boolean expression, java.lang.Object value, java.lang.String reference, java.lang.String validation)
void	verify()
OpenAPIContext	verify(OpenAPISecurityDefinition def, java.lang.String... args)
OpenAPIBase.MimeWrapper	wrap(java.lang.String mimeType, byte[] data)
OpenAPIBase.MimeWrapper	wrap(java.lang.String mimeType, java.io.File in)
OpenAPIBase.MimeWrapper	wrap(java.lang.String mimeType, java.io.InputStream in)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAPIContext

protected OpenAPIContext(OpenAPIRuntime runtime,
                         Dispatcher dispatcher,
                         HttpServletRequest request,
                         HttpServletResponse response)

Method Detail

isMethod

public boolean isMethod(OpenAPIBase.Method method)

method

public OpenAPIBase.Method method()

pathParameter

public void pathParameter(java.lang.String key,
                          java.lang.String value)

setResult

public void setResult(java.lang.Object result,
                      int resultCode)
               throws java.io.IOException

Throws:

java.io.IOException

isBeginStatus

protected boolean isBeginStatus()

parameter

public java.lang.String parameter(java.lang.String name)

parameters

public java.lang.String[] parameters(java.lang.String parameter)

header

public java.lang.String header(java.lang.String name)

headers

public java.lang.String[] headers(java.lang.String name)

path

public java.lang.String path(java.lang.String id)
                      throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

toLong

public java.lang.Long toLong(java.lang.String value)

toString

public java.lang.String toString(java.lang.String value)

optional

public <T> java.util.Optional<T> optional(T value)

part

public OpenAPIBase.Part part(java.lang.String key)
                      throws java.io.IOException,
                             ServletException

Throws:

java.io.IOException

ServletException

body

public <T> T body(java.lang.Class<T> type)
           throws java.lang.Exception

Throws:

java.lang.Exception

listBody

public <T> java.util.List<T> listBody(java.lang.Class<T> componentType)
                               throws java.lang.Exception

Throws:

java.lang.Exception

begin

public void begin(java.lang.String name)

begin

public void begin(int i)

validate

public boolean validate(boolean expression,
                        java.lang.Object value,
                        java.lang.String reference,
                        java.lang.String validation)

end

public void end()

toArray

public <T> java.util.List<T> toArray(java.lang.Class<T> type,
                                     java.lang.String[] values)
                              throws java.lang.Exception

Throws:

java.lang.Exception

in

public boolean in(java.lang.String value,
                  java.lang.String... sortedSet)

toLongDateTime

public java.lang.Long toLongDateTime(java.lang.String value)

toInt

public java.lang.Integer toInt(java.lang.String value)

toBoolean

public java.lang.Boolean toBoolean(java.lang.String value)

setOperation

public void setOperation(java.lang.String operation)

report

public void report(java.lang.Exception e)

csv

public java.lang.String[] csv(java.lang.String value)

ssv

public java.lang.String[] ssv(java.lang.String value)

tsv

public java.lang.String[] tsv(java.lang.String value)

pipes

public java.lang.String[] pipes(java.lang.String value)

toDouble

public java.lang.Double toDouble(java.lang.String value)

require

public boolean require(java.lang.Object value,
                       java.lang.String name)

toPassword

public char[] toPassword(java.lang.String value)

toDate

public java.time.LocalDate toDate(java.lang.String parameter)

getUser

public java.lang.String getUser()

getOriginalIP

public java.lang.String getOriginalIP()

setUser

public void setUser(java.lang.String user)

securityException

protected void securityException(java.lang.String name,
                                 java.lang.String message)

copy

public void copy(java.io.InputStream in,
                 java.lang.String mime)
          throws java.io.IOException

Throws:

java.io.IOException

or

public OpenAPIContext or()

verify

public OpenAPIContext verify(OpenAPISecurityDefinition def,
                             java.lang.String... args)
                      throws java.lang.Exception

Throws:

java.lang.Exception

verify

public void verify()
            throws java.lang.Exception

Throws:

java.lang.Exception

hasPermission

public boolean hasPermission(java.lang.String action,
                             java.lang.String... arguments)
                      throws java.lang.Exception

Throws:

java.lang.Exception

checkPermission

public void checkPermission(java.lang.String name,
                            java.lang.String... resource)
                     throws java.lang.Exception

Throws:

java.lang.Exception

path

public java.lang.String path()

call

public <T> T call(java.util.concurrent.Callable<T> callable)
           throws java.lang.Exception

Throws:

java.lang.Exception

isEncrypted

public boolean isEncrypted()

getURL

public java.lang.String getURL()

getRequest

public HttpServletRequest getRequest()

getResponse

public HttpServletResponse getResponse()

getOperation

public java.lang.String getOperation()

formData

public java.lang.String formData(java.lang.String name)

formDataArray

public java.lang.String[] formDataArray(java.lang.String name)

escapeCommas

protected void escapeCommas(java.lang.StringBuilder sb,
                            java.lang.String s)

csv

public java.lang.String[] csv(java.lang.String[] parameters)

pipes

public java.lang.String[] pipes(java.lang.String[] parameters)

tsv

public java.lang.String[] tsv(java.lang.String[] parameters)

ssv

public java.lang.String[] ssv(java.lang.String[] parameters)

wrap

public OpenAPIBase.MimeWrapper wrap(java.lang.String mimeType,
                                    byte[] data)

wrap

public OpenAPIBase.MimeWrapper wrap(java.lang.String mimeType,
                                    java.io.InputStream in)
                             throws java.io.IOException

Throws:

java.io.IOException

wrap

public OpenAPIBase.MimeWrapper wrap(java.lang.String mimeType,
                                    java.io.File in)
                             throws java.io.IOException

Throws:

java.io.IOException

doOptions

public boolean doOptions(java.lang.String... methods)
                  throws java.lang.Exception

Throws:

java.lang.Exception

toEnumMember

public <T extends java.lang.Enum<T>> T toEnumMember(java.lang.Class<T> eClass,
                                                    java.lang.String value)