Property Detail

• static final java.lang.String CHAR_ENCODING

• static final java.lang.String DEFAULT_API_KEY_HEADER

• static final java.lang.String DEFAULT_AUTH_HEADER

• static final int DEFAULT_TIMEOUT_MILLIS

• static final java.nio.charset.Charset UTF_8

• au.org.ala.web.AuthService authService

• java.lang.Object grailsApplication

• @org.springframework.beans.factory.annotation.Autowired TokenService tokenService

Constructor Detail

• WebService()

Method Detail

• static org.grails.web.json.JSONElement decodeJSON(org.apache.http.HttpResponse httpResponse)

  Decode an Apache HTTP Response as JSON using the Grails JSON support

  Parameters:

  httpResponse - The HTTP Response to decode as JSON

  Returns:

  A Grails JSONElement

• java.util.Map delete(java.lang.String url, java.util.Map params, groovyx.net.http.ContentType contentType, boolean includeApiKey, boolean includeUser, java.util.Map customHeaders)

  Sends a HTTP DELETE request to the specified URL. The URL must already be URL-encoded (if necessary). Note: by default, the Accept header will be set to the same content type as the ContentType provided. To override this default behaviour, include an 'Accept' header in the 'customHeaders' parameter.

  Parameters:

  url - The url-encoded url to send the request to

  params - Map of parameters to be appended to the query string. Parameters will be URL-encoded automatically.

  contentType - the desired content type for the request. Defaults to application/json

  includeApiKey - true to include the service's API Key in the request headers (uses property 'service.apiKey'). If using JWTs, instead sends a JWT Bearer tokens Default = true.

  includeUser - true to include the userId and email in the request headers and the ALA-Auth cookie. If using JWTs sends the current user's access token, if false only sends a ClientCredentials grant token for this apps client id Default = true.

  customHeaders - Map of [headerName:value] for any extra HTTP headers to be sent with the request. Default = [:].

  Returns:

  [statusCode: int, resp: [:]] on success, or [statusCode: int, error: string] on error

• static java.lang.String enc(java.lang.String str)

• static org.apache.http.HttpEntity encodeJSON(java.lang.Object model, java.lang.Object contentType)

  Use Grails JSON to encode an object as JSON. If the object is a String, assume that it's already a well formed JSON document and return it as such. Otherwise, convert the object to JSON using `o as JSON` and then return an entity that will write the result to an OutputStream.

  Parameters:

  model - The model to convert to JSON

  contentType - The content type. Could be anything.

  Returns:

  The HTTP Entity that will write the model to an outputstream as JSON

• java.util.Map get(java.lang.String url, java.util.Map params, groovyx.net.http.ContentType contentType, boolean includeApiKey, boolean includeUser, java.util.Map customHeaders)

  Sends an HTTP GET request to the specified URL. The URL must already be URL-encoded (if necessary). Note: by default, the Accept header will be set to the same content type as the ContentType provided. To override this default behaviour, include an 'Accept' header in the 'customHeaders' parameter.

  Parameters:

  url - The url-encoded URL to send the request to

  params - Map of parameters to be appended to the query string. Parameters will be URL-encoded automatically.

  contentType - the desired content type for the request. Defaults to application/json

  includeApiKey - true to include the service's API Key in the request headers (uses property 'service.apiKey'). If using JWTs, instead sends a JWT Bearer tokens Default = true.

  includeUser - true to include the userId and email in the request headers and the ALA-Auth cookie. If using JWTs sends the current user's access token, if false only sends a ClientCredentials grant token for this apps client id Default = true.

  customHeaders - Map of [headerName:value] for any extra HTTP headers to be sent with the request. Default = [:].

  Returns:

  [statusCode: int, resp: [:]] on success, or [statusCode: int, error: string] on error

• void includeAuthTokens(java.lang.Boolean includeUser, java.lang.Boolean includeApiKey, au.org.ala.web.UserDetails user, java.net.URLConnection conn)

• void includeAuthTokensJwt(java.lang.Object includeUser, java.lang.Object includeApiKey, java.lang.Object user, java.lang.Object headerSetter)

• void includeAuthTokensLegacy(java.lang.Object includeUser, java.lang.Object includeApiKey, java.lang.Object user, java.lang.Object headerSetter)

• groovyx.net.http.HTTPBuilder newHttpBuilder(java.lang.String url, groovyx.net.http.ContentType contentType)

• java.util.Map post(java.lang.String url, java.util.Map body, java.util.Map params, groovyx.net.http.ContentType contentType, boolean includeApiKey, boolean includeUser, java.util.Map customHeaders)

  Sends an HTTP POST request to the specified URL. The URL must already be URL-encoded (if necessary). Note: by default, the Accept header will be set to the same content type as the ContentType provided. To override this default behaviour, include an 'Accept' header in the 'customHeaders' parameter. The body map will be sent as the body of the request (i.e. use request.getJSON() on the receiving end).

  Parameters:

  url - The url-encoded url to send the request to

  body - Map containing the data to be sent as the post body

  params - Map of parameters to be appended to the query string. Parameters will be URL-encoded automatically.

  contentType - the desired content type for the request. Defaults to application/json

  includeApiKey - true to include the service's API Key in the request headers (uses property 'service.apiKey'). If using JWTs, instead sends a JWT Bearer tokens Default = true.

  includeUser - true to include the userId and email in the request headers and the ALA-Auth cookie. If using JWTs sends the current user's access token, if false only sends a ClientCredentials grant token for this apps client id Default = true.

  customHeaders - Map of [headerName:value] for any extra HTTP headers to be sent with the request. Default = [:].

  Returns:

  [statusCode: int, resp: [:]] on success, or [statusCode: int, error: string] on error

• java.util.Map postMultipart(java.lang.String url, java.util.Map body, java.util.Map params, java.util.List files, groovyx.net.http.ContentType partContentType, boolean includeApiKey, boolean includeUser, java.util.Map customHeaders)

  Sends a multipart HTTP POST request to the specified URL. The URL must already be URL-encoded (if necessary). Note: by default, the Accept header will be set to the same content type as the ContentType provided. To override this default behaviour, include an 'Accept' header in the 'customHeaders' parameter. Each item in the body map will be sent as a separate Part in the Multipart Request. To send the entire map as a single part, you will need too use the format [data: body]. Files can be one of the following types:

  • byte[]
  • CommonsMultipartFile
  • InputStream
  • File
  • Anything that supports the .bytes accessor

  Parameters:

  url - The url-encoded url to send the request to

  body - Map containing the data to be sent as the post body

  params - Map of parameters to be appended to the query string. Parameters will be URL-encoded automatically.

  files - List of 0 or more files to be included in the multipart request (note: if files is null, then the request will NOT be multipart)

  partContentType - the desired content type for the request PARTS (the request itself will always be sent as multipart/form-data). Defaults to application/json. All non-file parts will have the same content type.

  includeApiKey - true to include the service's API Key in the request headers (uses property 'service.apiKey'). If using JWTs, instead sends a JWT Bearer tokens Default = true.

  includeUser - true to include the userId and email in the request headers and the ALA-Auth cookie. If using JWTs sends the current user's access token, if false only sends a ClientCredentials grant token for this apps client id Default = true.

  customHeaders - Map of [headerName:value] for any extra HTTP headers to be sent with the request. Default = [:].

  Returns:

  [statusCode: int, resp: [:]] on success, or [statusCode: int, error: string] on error

• void proxyGetRequest(javax.servlet.http.HttpServletResponse response, java.lang.String url, boolean includeApiKey, boolean includeUser)

  Proxies a request URL but doesn't assume the response is text based. Used for operations like proxying a download request from one application to another.

  Parameters:

  response - The HttpServletResponse of the calling request: the response from the proxied request will be written to this object

  url - The URL of the service to proxy to

  includeApiKey - true to include the service's API Key in the request headers (uses property 'service.apiKey'). If using JWTs, instead sends a JWT Bearer tokens Default = true.

  includeUser - true to include the userId and email in the request headers and the ALA-Auth cookie. If using JWTs sends the current user's access token, if false only sends a ClientCredentials grant token for this apps client id Default = true.

• void proxyPostRequest(javax.servlet.http.HttpServletResponse response, java.lang.String url, java.lang.Object postBody, groovyx.net.http.ContentType contentType, boolean includeApiKey, boolean includeUser, java.util.Map cookies)

  Proxies a request URL with post data but doesn't assume the response is text based.

  Parameters:

  response - The HttpServletResponse of the calling request: the response from the proxied request will be written to this object

  url - The URL of the service to proxy to

  postBody - The POST data to send with the proxied request. If it is a Collection, then it will be converted to JSON, otherwise it will be sent as a String.

  contentType - the desired content type for the request. Defaults to application/json.

  includeApiKey - true to include the service's API Key in the request headers (uses property 'service.apiKey'). If using JWTs, instead sends a JWT Bearer tokens Default = true.

  includeUser - true to include the userId and email in the request headers and the ALA-Auth cookie. If using JWTs sends the current user's access token, if false only sends a ClientCredentials grant token for this apps client id Default = true.

• java.util.Map put(java.lang.String url, java.util.Map body, java.util.Map params, groovyx.net.http.ContentType contentType, boolean includeApiKey, boolean includeUser, java.util.Map customHeaders)

  Sends an HTTP PUT request to the specified URL. The URL must already be URL-encoded (if necessary). Note: by default, the Accept header will be set to the same content type as the ContentType provided. To override this default behaviour, include an 'Accept' header in the 'customHeaders' parameter. The body map will be sent as the JSON body of the request (i.e. use request.getJSON() on the receiving end).

  Parameters:

  url - The url-encoded url to send the request to

  body - Map containing the data to be sent as the post body

  params - Map of parameters to be appended to the query string. Parameters will be URL-encoded automatically.

  contentType - the desired content type for the request. Defaults to application/json

  includeApiKey - true to include the service's API Key in the request headers (uses property 'service.apiKey'). If using JWTs, instead sends a JWT Bearer tokens Default = true.

  includeUser - true to include the userId and email in the request headers and the ALA-Auth cookie. If using JWTs sends the current user's access token, if false only sends a ClientCredentials grant token for this apps client id Default = true.

  customHeaders - Map of [headerName:value] for any extra HTTP headers to be sent with the request. Default = [:].

  Returns:

  [statusCode: int, resp: [:]] on success, or [statusCode: int, error: string] on error