cn.trinea.android.common.entity

Class HttpResponse

java.lang.Object

cn.trinea.android.common.entity.HttpResponse

public class HttpResponse
extends java.lang.Object

HttpResponse

Constructor
• HttpResponse()
• HttpResponse(String)

Get
• getResponseBody()
• getUrl()
• getExpiresInMillis() expires time
• getExpiresHeader()
• getCacheControlMaxAge()

Setting
• setUrl(String)
• setResponseBody(String)
• setResponseHeader(String, String)
• setResponseHeaders(Map)

Author:

Trinea 2013-5-12

Constructor Summary

Constructors

Constructor and Description
HttpResponse()
HttpResponse(java.lang.String url)
HttpResponse(java.lang.String url, java.lang.String response)

Method Summary

Methods

Modifier and Type	Method and Description
int	getCacheControlMaxAge() http cache-control in reponse header
long	getExpiredTime() get expired time in millis if current time is bigger than expired time, it means this response is dirty
java.lang.String	getExpiresHeader() http expires in reponse header
long	getExpiresInMillis() get expires
java.lang.String	getResponseBody()
int	getResponseCode() get reponse code
int	getType() get type type to mark this response, default is 0 it will be used in HttpCache#HttpCache(android.content.Context, int)
java.lang.String	getUrl()
boolean	isExpired() whether this response has expired
boolean	isInCache() get isInCache, this is a client mark, whethero is in client cache
void	setExpiredTime(long expiredTime) set expired time in millis
HttpResponse	setInCache(boolean isInCache) set isInCache, this is a client mark, whethero is in client cache
void	setResponseBody(java.lang.String responseBody)
void	setResponseCode(int responseCode)
void	setResponseHeader(java.lang.String field, java.lang.String newValue) set response header
void	setResponseHeaders(java.util.Map<java.lang.String,java.lang.Object> responseHeaders)
void	setType(int type) set type type to mark this response, default is 0, cannot be smaller than 0.
void	setUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponse

public HttpResponse(java.lang.String url)

HttpResponse

public HttpResponse(java.lang.String url,
            java.lang.String response)

HttpResponse

public HttpResponse()

Method Detail

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

getResponseBody

public java.lang.String getResponseBody()

setResponseBody

public void setResponseBody(java.lang.String responseBody)

getResponseCode

public int getResponseCode()

get reponse code

Returns:

An int representing the three digit HTTP Status-Code.

• 1xx: Informational
• 2xx: Success
• 3xx: Redirection
• 4xx: Client Error
• 5xx: Server Error
• -1: http error

setResponseCode

public void setResponseCode(int responseCode)

setResponseHeaders

public void setResponseHeaders(java.util.Map<java.lang.String,java.lang.Object> responseHeaders)

getType

public int getType()

get type

• type to mark this response, default is 0
• it will be used in HttpCache#HttpCache(android.content.Context, int)

Returns:

the type

setType

public void setType(int type)

set type

• type to mark this response, default is 0, cannot be smaller than 0.
• it will be used in HttpCache#HttpCache(android.content.Context, int)

Parameters:

type - the type to set

setExpiredTime

public void setExpiredTime(long expiredTime)

set expired time in millis

Parameters:

expiredTime -

getExpiredTime

public long getExpiredTime()

get expired time in millis

• if current time is bigger than expired time, it means this response is dirty

Returns:

• if max-age in cache-control is exists, return current time plus it
• else return expires
• if something error, return -1

isExpired

public boolean isExpired()

whether this response has expired

Returns:

isInCache

public boolean isInCache()

get isInCache, this is a client mark, whethero is in client cache

Returns:

the isInCache

setInCache

public HttpResponse setInCache(boolean isInCache)

set isInCache, this is a client mark, whethero is in client cache

Parameters:

isInCache - the isInCache to set

Returns:

getExpiresHeader

public java.lang.String getExpiresHeader()

http expires in reponse header

Returns:

null represents http error or no expires in response headers

getCacheControlMaxAge

public int getCacheControlMaxAge()

http cache-control in reponse header

Returns:

-1 represents http error or no cache-control in response headers, or max-age in seconds

getExpiresInMillis

public long getExpiresInMillis()

get expires

Returns:

• if max-age in cache-control is exists, return current time plus it
• else return expires
• if something error, return -1

setResponseHeader

public void setResponseHeader(java.lang.String field,
                     java.lang.String newValue)

set response header

Parameters:

field -

newValue -