ApiRequest (Java Server GD-API Spec Implementation 0.11.2 API)

java.lang.Object
- io.github.ibuildthecloud.gdapi.request.ApiRequest

```
public class ApiRequest
extends Object
```

Constructor Summary

Constructors
Constructor and Description
`ApiRequest(ApiRequest request)`
`ApiRequest(String apiVersion, ApiServletContext requestServletContext, SchemaFactory schemaFactory)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`commit()`
`String`	`getAction()`
`String`	`getApiVersion()`
`Object`	`getAttribute(Object object)`
`String`	`getClientIp()`
`Map<String,List<Condition>>`	`getConditions()`
`Map<String,Object>`	`getCreateDefaults()`
`List<Throwable>`	`getExceptions()`
`String`	`getId()`
`Include`	`getInclude()`
`InputStream`	`getInputStream()`
`String`	`getLink()`
`Locale`	`getLocale()`
`String`	`getMethod()`
`Map<String,String>`	`getOptions()`
`OutputStream`	`getOutputStream()`
`Pagination`	`getPagination()`
`String`	`getQueryString()`
`Object`	`getRequestObject()`
`Map<String,Object>`	`getRequestParams()`
`String`	`getRequestUrl()`
`String`	`getRequestVersion()`
`int`	`getResponseCode()`
`String`	`getResponseContentType()`
`String`	`getResponseFormat()`
`Object`	`getResponseObject()`
`String`	`getResponseUrlBase()`
`SchemaFactory`	`getSchemaFactory()`
`ApiServletContext`	`getServletContext()`
`Sort`	`getSort()`
`long`	`getStartTime()`
`String`	`getStaticResourceBase()`
`String`	`getSubContext()`
`String`	`getType()`
`UrlBuilder`	`getUrlBuilder()`
`boolean`	`isCommitted()`
`<T> T`	`proxyRequestObject(Class<T> type)`
`ApiRequest`	`reset()`
`void`	`setAction(String action)`
`void`	`setApiVersion(String apiVersion)`
`void`	`setAttribute(Object key, Object value)`
`void`	`setClientIp(String clientIp)`
`void`	`setConditions(Map<String,List<Condition>> conditions)`
`void`	`setCreateDefaults(Map<String,Object> createDefaults)`
`void`	`setId(String id)`
`void`	`setInclude(Include include)`
`void`	`setLink(String link)`
`void`	`setLocale(Locale locale)`
`void`	`setMethod(String method)`
`void`	`setPagination(Pagination pagination)`
`void`	`setQueryString(String queryString)`
`void`	`setRequestObject(Object requestObject)`
`void`	`setRequestParams(Map<String,Object> requestParams)`
`void`	`setRequestServletContext(ApiServletContext requestServletContext)`
`void`	`setRequestUrl(String requestUrl)`
`void`	`setRequestVersion(String requestVersion)`
`void`	`setResponseCode(int responseCode)`
`void`	`setResponseContentType(String contentType)`
`void`	`setResponseFormat(String responseType)`
`void`	`setResponseObject(Object responseObject)`
`void`	`setResponseUrlBase(String responseUrlBase)`
`void`	`setSchemaFactory(SchemaFactory schemaFactory)`
`void`	`setSort(Sort sort)`
`void`	`setStaticResourceBase(String staticResourceBase)`
`void`	`setSubContext(String subContext)`
`void`	`setType(String type)`
`void`	`setUrlBuilder(UrlBuilder urlWriter)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiRequest
```
public ApiRequest(ApiRequest request)
```

ApiRequest

public ApiRequest(String apiVersion,
          ApiServletContext requestServletContext,
          SchemaFactory schemaFactory)

Method Detail

reset
```
public ApiRequest reset()
```

getInputStream

public InputStream getInputStream()
                           throws IOException

Throws:: IOException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Throws:: IOException

proxyRequestObject

public <T> T proxyRequestObject(Class<T> type)

getType
```
public String getType()
```

setType
```
public void setType(String type)
```

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getLink
```
public String getLink()
```

setLink
```
public void setLink(String link)
```

getMethod
```
public String getMethod()
```

setMethod
```
public void setMethod(String method)
```

isCommitted
```
public boolean isCommitted()
```

getResponseCode
```
public int getResponseCode()
```

setResponseCode

public void setResponseCode(int responseCode)

getResponseObject
```
public Object getResponseObject()
```

setResponseObject

public void setResponseObject(Object responseObject)

getRequestObject
```
public Object getRequestObject()
```

setRequestObject

public void setRequestObject(Object requestObject)

getAction
```
public String getAction()
```

setAction
```
public void setAction(String action)
```

getRequestParams

public Map<String,Object> getRequestParams()

setRequestParams

public void setRequestParams(Map<String,Object> requestParams)

getClientIp
```
public String getClientIp()
```

setClientIp

public void setClientIp(String clientIp)

getRequestUrl
```
public String getRequestUrl()
```

setRequestUrl

public void setRequestUrl(String requestUrl)

getResponseUrlBase
```
public String getResponseUrlBase()
```

setResponseUrlBase

public void setResponseUrlBase(String responseUrlBase)

getRequestVersion
```
public String getRequestVersion()
```

setRequestVersion

public void setRequestVersion(String requestVersion)

getResponseFormat
```
public String getResponseFormat()
```

setResponseFormat

public void setResponseFormat(String responseType)

setResponseContentType

public void setResponseContentType(String contentType)

getResponseContentType

public String getResponseContentType()

getQueryString
```
public String getQueryString()
```

setQueryString

public void setQueryString(String queryString)

getServletContext

public ApiServletContext getServletContext()

setRequestServletContext

public void setRequestServletContext(ApiServletContext requestServletContext)

getStartTime
```
public long getStartTime()
```

commit
```
public void commit()
```

getUrlBuilder
```
public UrlBuilder getUrlBuilder()
```

setUrlBuilder

public void setUrlBuilder(UrlBuilder urlWriter)

getApiVersion
```
public String getApiVersion()
```

setApiVersion

public void setApiVersion(String apiVersion)

getConditions

public Map<String,List<Condition>> getConditions()

setConditions

public void setConditions(Map<String,List<Condition>> conditions)

getSort
```
public Sort getSort()
```

setSort
```
public void setSort(Sort sort)
```

getPagination
```
public Pagination getPagination()
```

setPagination

public void setPagination(Pagination pagination)

getLocale
```
public Locale getLocale()
```

setLocale
```
public void setLocale(Locale locale)
```

getInclude
```
public Include getInclude()
```

setInclude

public void setInclude(Include include)

getAttribute

public Object getAttribute(Object object)

setAttribute

public void setAttribute(Object key,
                Object value)

getSchemaFactory

public SchemaFactory getSchemaFactory()

setSchemaFactory

public void setSchemaFactory(SchemaFactory schemaFactory)

getCreateDefaults

public Map<String,Object> getCreateDefaults()

setCreateDefaults

public void setCreateDefaults(Map<String,Object> createDefaults)

getExceptions

public List<Throwable> getExceptions()

getOptions

public Map<String,String> getOptions()

getStaticResourceBase
```
public String getStaticResourceBase()
```

setStaticResourceBase

public void setStaticResourceBase(String staticResourceBase)

getSubContext
```
public String getSubContext()
```

setSubContext

public void setSubContext(String subContext)

Class ApiRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApiRequest

ApiRequest

Method Detail

reset

getInputStream

getOutputStream

proxyRequestObject

getType

setType

getId

setId

getLink

setLink

getMethod

setMethod

isCommitted

getResponseCode

setResponseCode

getResponseObject

setResponseObject

getRequestObject

setRequestObject

getAction

setAction

getRequestParams

setRequestParams

getClientIp

setClientIp

getRequestUrl

setRequestUrl

getResponseUrlBase

setResponseUrlBase

getRequestVersion

setRequestVersion

getResponseFormat

setResponseFormat

setResponseContentType

getResponseContentType

getQueryString

setQueryString

getServletContext

setRequestServletContext

getStartTime

commit

getUrlBuilder

setUrlBuilder

getApiVersion

setApiVersion

getConditions

setConditions

getSort

setSort

getPagination

setPagination

getLocale

setLocale

getInclude

setInclude

getAttribute

setAttribute

getSchemaFactory

setSchemaFactory

getCreateDefaults

setCreateDefaults

getExceptions

getOptions

getStaticResourceBase

setStaticResourceBase

getSubContext

setSubContext