GrouperHttpClient (Grouper API 2.5.0-SNAPSHOT Java API.)

java.lang.Object
- edu.internet2.middleware.grouper.util.GrouperHttpClient

public class GrouperHttpClient
extends Object

HTTP call. Use this for all HTTP calls as a client

 import edu.internet2.middleware.grouper.util.*;
 GrouperHttpClient grouperHttpCall = new GrouperHttpClient();
 grouperHttpCall.assignUrl(url);
 grouperHttpCall.assignGrouperHttpMethod("POST");
 grouperHttpCall.addHeader("Content-Type", "application/json");
 grouperHttpCall.addHeader("Authorization", "Bearer " + bearerToken);
 grouperHttpCall.assignBody(body);
 grouperHttpCall.executeRequest();
 if (grouperHttpCall.getResponseCode() != 200) {
   throw new RuntimeException("Error connecting to '" + url + "': " + grouperHttpCall.getResponseCode());
 }
 String json = grouperHttpCall.getResponseBody();

Constructor Summary

Constructors
Constructor and Description

GrouperHttpClient()

Constructors
Constructor and Description
`GrouperHttpClient()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GrouperHttpClient`	`addBodyParameter(String key, String value)` Add a parameter to the BODY for a POST body form.
`GrouperHttpClient`	`addFileToSend(String filename, File file)`
`GrouperHttpClient`	`addHeader(String key, String value)` Adds a parameter to the header.
`GrouperHttpClient`	`addUrlParameter(String key, String value)` Add a parameter to the URL.
`GrouperHttpClient`	`assignBody(String _body)` Sets the body to send.
`GrouperHttpClient`	`assignBodyBytes(byte[] _body)` Sets the body to send.
`GrouperHttpClient`	`assignGrouperHttpMethod(GrouperHttpMethod grouperHttpMethod)`
`GrouperHttpClient`	`assignGrouperHttpMethod(String grouperHttpMethodType)`
`GrouperHttpClient`	`assignHttpMultipartMode(org.apache.http.entity.mime.HttpMultipartMode _httpMultipartMode)` Use to override HttpMultipartMode.BROWSER_COMPATIBLE which is the default.
`GrouperHttpClient`	`assignHttpResponseBodyCallback(GrouperHttpResponseBodyCallback httpResponseBodyCallback)`
`GrouperHttpClient`	`assignPassword(String _password)` Sets the password for basic auth.
`GrouperHttpClient`	`assignResponseAsFile(boolean _responseAsFile)` Whether you want the response as a file as opposed to a string in memory.
`GrouperHttpClient`	`assignResponseCode(int _responseCode)` The response code of the call.
`GrouperHttpClient`	`assignResponseFile(File _responseFile)` If getting the reponse body as a file, this is the file.
`GrouperHttpClient`	`assignResponseFileName(String _responseFileName)` The filename to use for the response, if the response is retrieved as a file.
`GrouperHttpClient`	`assignResponseHeaders(Map<String,String> _responseHeaders)` Any headers sent back in the resopnse.
`GrouperHttpClient`	`assignTrust(boolean _trust)` Trust regardless of cert; ONLY use when you KNOW the endpoint.
`GrouperHttpClient`	`assignTrustStore(File _trustStore)` Truststore (.jks) to add dynamically to list of truststores.
`GrouperHttpClient`	`assignTrustStorePassword(String _trustStoreKey)` Password for truststore.
`GrouperHttpClient`	`assignUrl(String _url)` Sets the url being called.
`GrouperHttpClient`	`assignUser(String _user)` Sets the user for basic auth.
`static String`	`basicAuthenticationString(String login, String password)` Create a basic authentication string.
`void`	`executeRequest()` Execute a post with the given parameters, set teh code and the response into the call.
`String`	`getResponseBody()` Get the response body of the call.
`int`	`getResponseCode()` Get the response code.
`File`	`getResponseFile()` If getting the reponse body as a file, this is the file.
`String`	`getResponseFileName()` The filename to use for the response, if the response is retrieved as a file.
`Map<String,String>`	`getResponseHeaders()` Any headers sent back in the resopnse.
`static GrouperHttpClientLog`	`logCurrent()` get the current log log start
`static String`	`logEnd()` stop a debug log in a finally block
`static void`	`logStart(GrouperHttpClientLog grouperHttpCallLog)` start a static debug log log start
`static String`	`responseBodyAsString(org.apache.http.client.methods.CloseableHttpResponse closeableHttpResponse)` Get the body of the response as a string.
`static String`	`responseBodyAsString(org.apache.commons.httpclient.HttpMethod httpMethod)` Get the body of the response as a string.

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

- Constructor Detail
  - GrouperHttpClient
```
public GrouperHttpClient()
```
- Method Detail
  - assignGrouperHttpMethod
```
public GrouperHttpClient assignGrouperHttpMethod(GrouperHttpMethod grouperHttpMethod)
```
  - assignGrouperHttpMethod
```
public GrouperHttpClient assignGrouperHttpMethod(String grouperHttpMethodType)
```
  - assignUrl
```
public GrouperHttpClient assignUrl(String _url)
```
    Sets the url being called.
    
    Parameters:
    
    _url - the new url being called
  - assignUser
```
public GrouperHttpClient assignUser(String _user)
```
    Sets the user for basic auth.
    
    Parameters:
    
    _user - the new user for basic auth
  - assignPassword
```
public GrouperHttpClient assignPassword(String _password)
```
    Sets the password for basic auth.
    
    Parameters:
    
    _password - the new password for basic auth
  - addBodyParameter
```
public GrouperHttpClient addBodyParameter(String key,
                                          String value)
```
    Add a parameter to the BODY for a POST body form.
    
    Parameters:
    
    key - is the name.
    
    value - is the value.
  - addUrlParameter
```
public GrouperHttpClient addUrlParameter(String key,
                                         String value)
```
    Add a parameter to the URL.
    
    Parameters:
    
    key - is the name.
    
    value - is the value.
  - addHeader
```
public GrouperHttpClient addHeader(String key,
                                   String value)
```
    Adds a parameter to the header.
    
    Parameters:
    
    key - is the name.
    
    value - is the value.
  - assignBodyBytes
```
public GrouperHttpClient assignBodyBytes(byte[] _body)
```
    Sets the body to send.
    
    Parameters:
    
    _body - the body to send
  - assignBody
```
public GrouperHttpClient assignBody(String _body)
```
    Sets the body to send.
    
    Parameters:
    
    _body - the body to send
  - getResponseBody
```
public String getResponseBody()
```
    Get the response body of the call.
    
    Returns:
    
    the responseBodyHolder
  - getResponseCode
```
public int getResponseCode()
```
    Get the response code.
    
    Returns:
    
    the responseCode
  - assignResponseCode
```
public GrouperHttpClient assignResponseCode(int _responseCode)
```
    The response code of the call.
    
    Parameters:
    
    _responseCode - the responseCode to set
  - assignTrustStore
```
public GrouperHttpClient assignTrustStore(File _trustStore)
```
    Truststore (.jks) to add dynamically to list of truststores.
    
    Parameters:
    
    _trustStore - the trustStore to set.
  - assignTrustStorePassword
```
public GrouperHttpClient assignTrustStorePassword(String _trustStoreKey)
```
    Password for truststore.
    
    Parameters:
    
    _trustStoreKey - the trustStoreKey to set.
  - assignHttpResponseBodyCallback
```
public GrouperHttpClient assignHttpResponseBodyCallback(GrouperHttpResponseBodyCallback httpResponseBodyCallback)
```
  - addFileToSend
```
public GrouperHttpClient addFileToSend(String filename,
                                       File file)
```
    Parameters:
    
    filename - The name of the file to send.
    
    file - The file to send.
  - getResponseHeaders
```
public Map<String,String> getResponseHeaders()
```
    Any headers sent back in the resopnse.
    
    Returns:
    
    the responseHeaders
  - assignResponseHeaders
```
public GrouperHttpClient assignResponseHeaders(Map<String,String> _responseHeaders)
```
    Any headers sent back in the resopnse.
    
    Parameters:
    
    _responseHeaders - the responseHeaders to set
  - assignHttpMultipartMode
```
public GrouperHttpClient assignHttpMultipartMode(org.apache.http.entity.mime.HttpMultipartMode _httpMultipartMode)
```
    Use to override HttpMultipartMode.BROWSER_COMPATIBLE which is the default.
    
    Parameters:
    
    _httpMultipartMode - the httpMultipartMode to set
  - assignResponseAsFile
```
public GrouperHttpClient assignResponseAsFile(boolean _responseAsFile)
```
    Whether you want the response as a file as opposed to a string in memory.
    
    Parameters:
    
    _responseAsFile - the responseAsFile to set,
  - getResponseFile
```
public File getResponseFile()
```
    If getting the reponse body as a file, this is the file.
    
    Returns:
    
    the responseFile.
  - assignResponseFile
```
public GrouperHttpClient assignResponseFile(File _responseFile)
```
    If getting the reponse body as a file, this is the file.
    
    Parameters:
    
    _responseFile - the responseFile to set.
  - getResponseFileName
```
public String getResponseFileName()
```
    The filename to use for the response, if the response is retrieved as a file.
    
    Returns:
    
    the responseFileName
  - assignResponseFileName
```
public GrouperHttpClient assignResponseFileName(String _responseFileName)
```
    The filename to use for the response, if the response is retrieved as a file.
    
    Parameters:
    
    _responseFileName - the responseFileName to set
  - assignTrust
```
public GrouperHttpClient assignTrust(boolean _trust)
```
    Trust regardless of cert; ONLY use when you KNOW the endpoint.
    
    Parameters:
    
    _trust - the trust to set
  - responseBodyAsString
```
public static String responseBodyAsString(org.apache.commons.httpclient.HttpMethod httpMethod)
```
    Get the body of the response as a string.
    
    Parameters:
    
    httpMethod - is the method.
    
    Returns:
    
    the string.
  - responseBodyAsString
```
public static String responseBodyAsString(org.apache.http.client.methods.CloseableHttpResponse closeableHttpResponse)
```
    Get the body of the response as a string.
    
    Parameters:
    
    closeableHttpResponse - is the response.
    
    Returns:
    
    the string.
  - basicAuthenticationString
```
public static String basicAuthenticationString(String login,
                                               String password)
```
    Create a basic authentication string.
    
    Parameters:
    
    login - is the login.
    
    password - is the password.
    
    Returns:
    
    "Basic login:password" where login:password is Base64 encoded.
  - executeRequest
```
public void executeRequest()
```
```
Execute a post with the given parameters, set teh code and the response into the call.
```
    Parameters:
    
    grouperHttpCall - is the configuration object.
  - logCurrent
```
public static GrouperHttpClientLog logCurrent()
```
    get the current log log start
  - logEnd
```
public static String logEnd()
```
    stop a debug log in a finally block
    
    Returns:
    
    the log message
  - logStart
```
public static void logStart(GrouperHttpClientLog grouperHttpCallLog)
```
    start a static debug log log start

Class GrouperHttpClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GrouperHttpClient

Method Detail

assignGrouperHttpMethod

assignGrouperHttpMethod

assignUrl

assignUser

assignPassword

addBodyParameter

addUrlParameter

addHeader

assignBodyBytes

assignBody

getResponseBody

getResponseCode

assignResponseCode

assignTrustStore

assignTrustStorePassword

assignHttpResponseBodyCallback

addFileToSend

getResponseHeaders

assignResponseHeaders

assignHttpMultipartMode

assignResponseAsFile

getResponseFile

assignResponseFile

getResponseFileName

assignResponseFileName

assignTrust

responseBodyAsString

responseBodyAsString

basicAuthenticationString

executeRequest

logCurrent

logEnd

logStart