org.apache.oltu.oauth2.client.response

Class OAuthClientResponse

java.lang.Object

org.apache.oltu.oauth2.client.response.OAuthClientResponse

Direct Known Subclasses:

OAuthAccessTokenResponse, OAuthAuthzResponse, OAuthResourceResponse

public abstract class OAuthClientResponse
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	body
protected String	contentType
protected Map<String,List<String>>	headers
protected Map<String,Object>	parameters
protected int	responseCode
protected OAuthClientValidator	validator

Constructor Summary

Constructors

Constructor and Description
OAuthClientResponse()

Method Summary

Methods

Modifier and Type	Method and Description
String	getParam(String param)
int	getResponseCode()
protected void	init(InputStream body, String contentType, int responseCode, Map<String,List<String>> headers) Default implementation that converts the body InputStream to a String and delegates to init(String, String, int).
protected void	init(String body, String contentType, int responseCode)
protected void	init(String body, String contentType, int responseCode, Map<String,List<String>> headers)
protected void	setBody(InputStream body) Allows setting the response body to an InputStream value.
protected void	setBody(String body) Allows setting the response body to a String value.
protected abstract void	setContentType(String contentType)
void	setHeaders(Map<String,List<String>> headers)
protected abstract void	setResponseCode(int responseCode)
protected void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

body

protected String body

contentType

protected String contentType

responseCode

protected int responseCode

headers

protected Map<String,List<String>> headers

validator

protected OAuthClientValidator validator

parameters

protected Map<String,Object> parameters

Constructor Detail

OAuthClientResponse

public OAuthClientResponse()

Method Detail

getParam

public String getParam(String param)

getResponseCode

public int getResponseCode()

setHeaders

public void setHeaders(Map<String,List<String>> headers)

setBody

protected void setBody(String body)
                throws org.apache.oltu.oauth2.common.exception.OAuthProblemException

Allows setting the response body to a String value.

Parameters:

body - A String representing the response body.

Throws:

org.apache.oltu.oauth2.common.exception.OAuthProblemException

UnsupportedOperationException - for subclasses that only support InputStream as body

setBody

protected void setBody(InputStream body)
                throws org.apache.oltu.oauth2.common.exception.OAuthProblemException

Allows setting the response body to an InputStream value.

Parameters:

body - An InputStream representing the response body.

Throws:

org.apache.oltu.oauth2.common.exception.OAuthProblemException

UnsupportedOperationException - for subclasses that only support String as body

setContentType

protected abstract void setContentType(String contentType)

setResponseCode

protected abstract void setResponseCode(int responseCode)

init

protected void init(String body,
        String contentType,
        int responseCode,
        Map<String,List<String>> headers)
             throws org.apache.oltu.oauth2.common.exception.OAuthProblemException

Throws:

org.apache.oltu.oauth2.common.exception.OAuthProblemException

init

protected void init(String body,
        String contentType,
        int responseCode)
             throws org.apache.oltu.oauth2.common.exception.OAuthProblemException

Throws:

org.apache.oltu.oauth2.common.exception.OAuthProblemException

init

protected void init(InputStream body,
        String contentType,
        int responseCode,
        Map<String,List<String>> headers)
             throws org.apache.oltu.oauth2.common.exception.OAuthProblemException

Default implementation that converts the body InputStream to a String and delegates to init(String, String, int).
This implementation ensures backwards compatibility, as many subclasses expect String type bodies. At the same time it can be overridden to also deal with binary InputStreams.

Parameters:

body - an InputStream representing the response body

contentType - the content type of the response.

responseCode - the HTTP response code of the response.

headers - The HTTP response headers

Throws:

org.apache.oltu.oauth2.common.exception.OAuthProblemException

validate

protected void validate()
                 throws org.apache.oltu.oauth2.common.exception.OAuthProblemException

Throws:

org.apache.oltu.oauth2.common.exception.OAuthProblemException