@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen", date="2017-03-06T16:42:36.211-08:00") public class ApiClient extends Object
| Constructor and Description |
|---|
ApiClient() |
ApiClient(String basePath) |
ApiClient(String oAuthBasePath,
String authName)
Basic constructor for single auth name
|
ApiClient(String oAuthBasePath,
String[] authNames) |
ApiClient(String oAuthBasePath,
String authName,
String clientId,
String secret)
Helper constructor for OAuth2
|
| Modifier and Type | Method and Description |
|---|---|
void |
addAuthorization(String authName,
Authentication auth) |
ApiClient |
addDefaultHeader(String key,
String value)
Add a default header.
|
void |
configureAuthorizationFlow(String clientId,
String clientSecret,
String redirectURI)
Helper method to configure the OAuth accessCode/implicit flow parameters
|
String |
escapeString(String str)
Escape the given string to be used as URL query value.
|
String |
formatDate(Date date)
Format the given Date object into string.
|
Authentication |
getAuthentication(String authName)
Get authentication for the given name.
|
Map<String,Authentication> |
getAuthentications()
Get authentications (key: authentication name, value: authentication).
|
org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder |
getAuthorizationEndPoint()
Helper method to configure authorization endpoint of the first oauth found in the authentications (there should be only one)
|
String |
getAuthorizationUri() |
String |
getBasePath() |
int |
getConnectTimeout()
Connect timeout (in milliseconds).
|
DateFormat |
getDateFormat()
Get the date format used to parse/format date parameters.
|
Map<String,List<String>> |
getResponseHeaders()
Gets the response headers of the previous request
|
int |
getStatusCode()
Gets the status code of the previous request
|
org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder |
getTokenEndPoint()
Helper method to configure the token endpoint of the first oauth found in the authentications (there should be only one)
|
<T> T |
invokeAPI(String path,
String method,
List<Pair> queryParams,
Object body,
Map<String,String> headerParams,
Map<String,Object> formParams,
String accept,
String contentType,
String[] authNames,
com.sun.jersey.api.client.GenericType<T> returnType)
Invoke API by sending HTTP request with the given options.
|
boolean |
isDebugging()
Check that whether debugging is enabled for this API client.
|
boolean |
isJsonMime(String mime)
Check if the given MIME is a JSON MIME.
|
List<Pair> |
parameterToPairs(String collectionFormat,
String name,
Object value) |
String |
parameterToString(Object param)
Format the given parameter object into string.
|
Date |
parseDate(String str)
Parse the given string into Date object.
|
void |
registerAccessTokenListener(OAuth.AccessTokenListener accessTokenListener)
Configures a listener which is notified when a new access token is received.
|
String |
selectHeaderAccept(String[] accepts)
Select the Accept header's value from the given accepts array:
if JSON exists in the given array, use it;
otherwise use all of them (joining into a string)
|
String |
selectHeaderContentType(String[] contentTypes)
Select the Content-Type header's value from the given array:
if JSON exists in the given array, use it;
otherwise use the first one of the array.
|
Object |
serialize(Object obj,
String contentType,
Map<String,Object> formParams)
Serialize the given Java object into string according the given
Content-Type (only JSON is supported for now).
|
void |
setAccessToken(String accessToken,
Long expiresIn)
Helper method to preset the OAuth access token of the first OAuth found in the apiAuthorizations (there should be only one)
|
void |
setApiKey(String apiKey)
Helper method to set API key value for the first API key authentication.
|
void |
setApiKeyPrefix(String apiKeyPrefix)
Helper method to set API key prefix for the first API key authentication.
|
ApiClient |
setBasePath(String basePath) |
ApiClient |
setConnectTimeout(int connectionTimeout)
Set the connect timeout (in milliseconds).
|
ApiClient |
setDateFormat(DateFormat dateFormat)
Set the date format used to parse/format date parameters.
|
ApiClient |
setDebugging(boolean debugging)
Enable/disable debugging for this API client.
|
void |
setPassword(String password)
Helper method to set password for the first HTTP basic authentication.
|
ApiClient |
setUserAgent(String userAgent)
Set the User-Agent header's value (by adding to the default header map).
|
void |
setUsername(String username)
Helper method to set username for the first HTTP basic authentication.
|
void |
updateAccessToken() |
public ApiClient()
public ApiClient(String basePath)
public ApiClient(String oAuthBasePath, String authName)
authName - public String getBasePath()
public int getStatusCode()
public Map<String,List<String>> getResponseHeaders()
public Map<String,Authentication> getAuthentications()
public Authentication getAuthentication(String authName)
authName - The authentication namepublic void addAuthorization(String authName, Authentication auth)
public void setUsername(String username)
public void setPassword(String password)
public void setApiKey(String apiKey)
public void setApiKeyPrefix(String apiKeyPrefix)
public ApiClient setUserAgent(String userAgent)
public void updateAccessToken()
public void setAccessToken(String accessToken, Long expiresIn)
accessToken - OAuth access tokenexpiresIn - Validity period in secondspublic ApiClient addDefaultHeader(String key, String value)
key - The header's keyvalue - The header's valuepublic boolean isDebugging()
public ApiClient setDebugging(boolean debugging)
debugging - To enable (true) or disable (false) debuggingpublic int getConnectTimeout()
public ApiClient setConnectTimeout(int connectionTimeout)
Integer.MAX_VALUE.public DateFormat getDateFormat()
public ApiClient setDateFormat(DateFormat dateFormat)
public org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuilder getTokenEndPoint()
public org.apache.oltu.oauth2.client.request.OAuthClientRequest.AuthenticationRequestBuilder getAuthorizationEndPoint()
public void configureAuthorizationFlow(String clientId, String clientSecret, String redirectURI)
clientId - OAuth2 client IDclientSecret - OAuth2 client secretredirectURI - OAuth2 redirect uripublic String getAuthorizationUri() throws org.apache.oltu.oauth2.common.exception.OAuthSystemException
org.apache.oltu.oauth2.common.exception.OAuthSystemExceptionpublic void registerAccessTokenListener(OAuth.AccessTokenListener accessTokenListener)
accessTokenListener - public String parameterToString(Object param)
public List<Pair> parameterToPairs(String collectionFormat, String name, Object value)
public boolean isJsonMime(String mime)
public String selectHeaderAccept(String[] accepts)
accepts - The accepts array to select frompublic String selectHeaderContentType(String[] contentTypes)
contentTypes - The Content-Type array to select frompublic String escapeString(String str)
public Object serialize(Object obj, String contentType, Map<String,Object> formParams) throws ApiException
ApiExceptionpublic <T> T invokeAPI(String path, String method, List<Pair> queryParams, Object body, Map<String,String> headerParams, Map<String,Object> formParams, String accept, String contentType, String[] authNames, com.sun.jersey.api.client.GenericType<T> returnType) throws ApiException
path - The sub-path of the HTTP URLmethod - The request method, one of "GET", "POST", "PUT", and "DELETE"queryParams - The query parametersbody - The request body object - if it is not binary, otherwise nullheaderParams - The header parametersformParams - The form parametersaccept - The request's Accept headercontentType - The request's Content-Type headerauthNames - The authentications to applyApiExceptionCopyright © 2017. All rights reserved.