com.xatkit.core.server

Class HttpEntityHelper

java.lang.Object

com.xatkit.core.server.HttpEntityHelper

public class HttpEntityHelper
extends Object

Contains utility methods to manipulate and create HttpEntity instances.

Constructor Summary

Constructors

Constructor and Description
HttpEntityHelper()

Method Summary

Modifier and Type	Method and Description
static org.apache.http.HttpEntity	createErrorEntity(RestHandlerException e) Creates an HttpEntity representing the error wrapped in the provided RestHandlerException.
static org.apache.http.HttpEntity	createHttpEntity(Object object) Creates an HttpEntity from the provided object.
static com.google.gson.JsonElement	getJsonElementFromHttpEntity(org.apache.http.HttpEntity entity) Returns a JsonElement extracted from the content of the provided entity.
static String	getStringFromHttpEntity(org.apache.http.HttpEntity entity) Returns the String representation of the content of the provided entity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpEntityHelper

public HttpEntityHelper()

Method Detail

getStringFromHttpEntity

public static String getStringFromHttpEntity(@Nonnull
                                             org.apache.http.HttpEntity entity)

Returns the String representation of the content of the provided entity.

Parameters:

entity - the HttpEntity to return a String from

Returns:

the String extracted from the content of the provided entity

Throws:

NullPointerException - if the provided entity is null

XatkitException - if an error occurred when processing the provided entity

getJsonElementFromHttpEntity

public static com.google.gson.JsonElement getJsonElementFromHttpEntity(@Nonnull
                                                                       org.apache.http.HttpEntity entity)

Returns a JsonElement extracted from the content of the provided entity.

Parameters:

entity - the HttpEntity to return a JsonElement from

Returns:

the JsonElement extracted from the content of the provided entity

Throws:

NullPointerException - if the provided entity is null

com.google.gson.JsonSyntaxException - if the provided entity does not contain a valid JSON element

XatkitException - if an error occurred when processing the provided entity

createHttpEntity

public static org.apache.http.HttpEntity createHttpEntity(@Nonnull
                                                          Object object)

Creates an HttpEntity from the provided object.

Parameters:

object - the Object to translate to an HttpEntity

Returns:

the created HttpEntity

Throws:

NullPointerException - if the provided object is null

XatkitException - if the provided object's type is not supported

createErrorEntity

public static org.apache.http.HttpEntity createErrorEntity(@Nonnull
                                                           RestHandlerException e)

Creates an HttpEntity representing the error wrapped in the provided RestHandlerException.

The created HttpEntity contains a Json element with the following content:

 
  {
      "error" : <e.getMessage()>
  }
 
 

Parameters:

e - the RestHandlerException to transform into an error HttpEntity

Returns:

the created HttpEntity

Throws:

NullPointerException - if the provided RestHandlerException is null