RYRequestFactory.RYApplinkRequest (Requirement Yogi 2.5.3 API)

java.lang.Object
- com.playsql.utils.applinks.RYRequestFactory.RYApplinkRequest

All Implemented Interfaces:

com.atlassian.applinks.api.ApplicationLinkRequest, com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>

Enclosing class:

RYRequestFactory
```
public static class RYRequestFactory.RYApplinkRequest
extends Object
implements com.atlassian.applinks.api.ApplicationLinkRequest
```
This class intercepts the original Applink requests for 2 reasons: - To add convenience methods, - To intercept the fields and log them, if logging is wanted

Nested Class Summary
- Nested classes/interfaces inherited from interface com.atlassian.sal.api.net.Request
  com.atlassian.sal.api.net.Request.MethodType

Field Summary

Fields
Modifier and Type	Field and Description
`private Integer`	`connectionTimeout`
`private com.atlassian.applinks.api.ApplicationLinkRequest`	`delegate`
`private RYRequestFactory`	`factory`
`private org.apache.log4j.Logger`	`log`
`private com.atlassian.sal.api.net.Request.MethodType`	`methodType`
`private String`	`requestBodyAbbreviated`
`private Integer`	`soTimeout`
`private String`	`url`
`private Supplier<String>`	`webpageUrl`

Constructor Summary

Constructors
Constructor and Description
`RYApplinkRequest(org.apache.log4j.Logger log, com.atlassian.applinks.api.ApplicationLinkRequest request, RYRequestFactory factory, com.atlassian.sal.api.net.Request.MethodType methodType, String url)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RYRequestFactory.RYApplinkRequest`	`addBasicAuthentication(String hostname, String username, String password)`
`RYRequestFactory.RYApplinkRequest`	`addHeader(String headerName, String headerValue)`
`RYRequestFactory.RYApplinkRequest`	`addRequestParameters(String... params)`
`String`	`execute()`
`<R> R`	`execute(com.atlassian.applinks.api.ApplicationLinkResponseHandler<R> responseHandler)`
`void`	`execute(com.atlassian.sal.api.net.ResponseHandler<? super com.atlassian.sal.api.net.Response> responseHandler)`
`String`	`execute2()`
`<T> T`	`executeAndParseJson(Class<T> classOfT)` Executes the request and manages 200-OK and Json parsing.
`<RET> RET`	`executeAndReturn(com.atlassian.sal.api.net.ReturningResponseHandler<? super com.atlassian.sal.api.net.Response,RET> responseHandler)`
`Map<String,List<String>>`	`getHeaders()`
`private void`	`logThisRequest()`
`com.atlassian.applinks.api.ApplicationLinkRequest`	`setConnectionTimeout(int connectionTimeout)`
`RYRequestFactory.RYApplinkRequest`	`setEntity(Object entity)`
`RYRequestFactory.RYApplinkRequest`	`setFiles(List<com.atlassian.sal.api.net.RequestFilePart> files)`
`RYRequestFactory.RYApplinkRequest`	`setFollowRedirects(boolean follow)`
`RYRequestFactory.RYApplinkRequest`	`setHeader(String headerName, String headerValue)`
`RYRequestFactory.RYApplinkRequest`	`setRequestBody(String requestBody)`
`RYRequestFactory.RYApplinkRequest`	`setRequestBody(String requestBody, String contentType)`
`com.atlassian.applinks.api.ApplicationLinkRequest`	`setSoTimeout(int soTimeout)`
`com.atlassian.applinks.api.ApplicationLinkRequest`	`setUrl(String url)`
`RYRequestFactory.RYApplinkRequest`	`setWebpageUrl(Supplier<String> webpageUrl)`

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

Field Detail

log

private final org.apache.log4j.Logger log

delegate

private final com.atlassian.applinks.api.ApplicationLinkRequest delegate

factory
```
private final RYRequestFactory factory
```

methodType

private final com.atlassian.sal.api.net.Request.MethodType methodType

webpageUrl
```
private Supplier<String> webpageUrl
```

url
```
private String url
```

connectionTimeout
```
private Integer connectionTimeout
```

soTimeout
```
private Integer soTimeout
```

requestBodyAbbreviated
```
private String requestBodyAbbreviated
```

Constructor Detail

RYApplinkRequest

public RYApplinkRequest(org.apache.log4j.Logger log,
                        com.atlassian.applinks.api.ApplicationLinkRequest request,
                        RYRequestFactory factory,
                        com.atlassian.sal.api.net.Request.MethodType methodType,
                        String url)

Method Detail
- setWebpageUrl
```
public RYRequestFactory.RYApplinkRequest setWebpageUrl(Supplier<String> webpageUrl)
```
- logThisRequest
```
private void logThisRequest()
```
- executeAndParseJson
```
public <T> T executeAndParseJson(Class<T> classOfT)
                          throws ApplinkException
```
  Executes the request and manages 200-OK and Json parsing.
  
  Parameters:
  
  classOfT - the type of JSON class in which the respnose should be parsed. JsonElement.class is a satisfying value.
  
  Returns:
  
  the JsonElement, or the body parsed as whatever class you've chosen
  
  Throws:
  
  ApplinkException
- execute
```
public <R> R execute(com.atlassian.applinks.api.ApplicationLinkResponseHandler<R> responseHandler)
              throws com.atlassian.sal.api.net.ResponseException
```
  Specified by:
  
  execute in interface com.atlassian.applinks.api.ApplicationLinkRequest
  
  Throws:
  
  com.atlassian.sal.api.net.ResponseException
- execute
```
public void execute(com.atlassian.sal.api.net.ResponseHandler<? super com.atlassian.sal.api.net.Response> responseHandler)
             throws com.atlassian.sal.api.net.ResponseException
```
  Specified by:
  
  execute in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
  
  Throws:
  
  com.atlassian.sal.api.net.ResponseException
- execute
```
public String execute()
               throws com.atlassian.sal.api.net.ResponseException
```
  Specified by:
  
  execute in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
  
  Throws:
  
  com.atlassian.sal.api.net.ResponseException
- execute2
```
public String execute2()
                throws ApplinkException
```
  Throws:
  
  ApplinkException
- executeAndReturn
```
public <RET> RET executeAndReturn(com.atlassian.sal.api.net.ReturningResponseHandler<? super com.atlassian.sal.api.net.Response,RET> responseHandler)
                           throws com.atlassian.sal.api.net.ResponseException
```
  Specified by:
  
  executeAndReturn in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
  
  Throws:
  
  com.atlassian.sal.api.net.ResponseException
- setConnectionTimeout
```
public com.atlassian.applinks.api.ApplicationLinkRequest setConnectionTimeout(int connectionTimeout)
```
  Specified by:
  
  setConnectionTimeout in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- setSoTimeout
```
public com.atlassian.applinks.api.ApplicationLinkRequest setSoTimeout(int soTimeout)
```
  Specified by:
  
  setSoTimeout in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- setUrl
```
public com.atlassian.applinks.api.ApplicationLinkRequest setUrl(String url)
```
  Specified by:
  
  setUrl in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- setRequestBody
```
public RYRequestFactory.RYApplinkRequest setRequestBody(String requestBody)
```
  Specified by:
  
  setRequestBody in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- setRequestBody
```
public RYRequestFactory.RYApplinkRequest setRequestBody(String requestBody,
                                                        String contentType)
```
  Specified by:
  
  setRequestBody in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- setFiles
```
public RYRequestFactory.RYApplinkRequest setFiles(List<com.atlassian.sal.api.net.RequestFilePart> files)
```
  Specified by:
  
  setFiles in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- setEntity
```
public RYRequestFactory.RYApplinkRequest setEntity(Object entity)
```
  Specified by:
  
  setEntity in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- addRequestParameters
```
public RYRequestFactory.RYApplinkRequest addRequestParameters(String... params)
```
  Specified by:
  
  addRequestParameters in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- addBasicAuthentication
```
public RYRequestFactory.RYApplinkRequest addBasicAuthentication(String hostname,
                                                                String username,
                                                                String password)
```
  Specified by:
  
  addBasicAuthentication in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- addHeader
```
public RYRequestFactory.RYApplinkRequest addHeader(String headerName,
                                                   String headerValue)
```
  Specified by:
  
  addHeader in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- setHeader
```
public RYRequestFactory.RYApplinkRequest setHeader(String headerName,
                                                   String headerValue)
```
  Specified by:
  
  setHeader in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- setFollowRedirects
```
public RYRequestFactory.RYApplinkRequest setFollowRedirects(boolean follow)
```
  Specified by:
  
  setFollowRedirects in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>
- getHeaders
```
public Map<String,List<String>> getHeaders()
```
  Specified by:
  
  getHeaders in interface com.atlassian.sal.api.net.Request<com.atlassian.applinks.api.ApplicationLinkRequest,com.atlassian.sal.api.net.Response>

Class RYRequestFactory.RYApplinkRequest

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.sal.api.net.Request

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

delegate

factory

methodType

webpageUrl

url

connectionTimeout

soTimeout

requestBodyAbbreviated

Constructor Detail

RYApplinkRequest

Method Detail

setWebpageUrl

logThisRequest

executeAndParseJson

execute

execute

execute

execute2

executeAndReturn

setConnectionTimeout

setSoTimeout

setUrl

setRequestBody

setRequestBody

setFiles

setEntity

addRequestParameters

addBasicAuthentication

addHeader

setHeader

setFollowRedirects

getHeaders