xdi2.client.impl.http

Class XDIHttpClient

java.lang.Object

xdi2.client.impl.XDIAbstractClient<TransportMessagingResponse>

xdi2.client.impl.http.XDIHttpClient

All Implemented Interfaces:

Closeable, AutoCloseable, XDIClient<TransportMessagingResponse>

public class XDIHttpClient
extends XDIAbstractClient<TransportMessagingResponse>
implements XDIClient<TransportMessagingResponse>

An XDI client that can send XDI messages over HTTP and receive results. It supports the following parameters (passed to the init method):

• endpointUrl - The URL of the XDI endpoint to talk to.
• sendMimeType - The mime type to use to send the XDI messages to the endpoint. The Content-type header will be set accordingly.
• recvMimeType - The mime type in which we want to receive the results from the endpoint. The Accept header will be set accordingly. If the endpoint replies in some other mime type than requested, we will still try to read it.
• useragent - The User-Agent HTTP header to use.

Author:

markus

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FOLLOWREDIRECTS
static String	DEFAULT_RECVMIMETYPE
static String	DEFAULT_SENDMIMETYPE
static String	DEFAULT_USERAGENT
static String	KEY_ENDPOINTURI
static String	KEY_FOLLOWREDIRECTS
static String	KEY_RECVMIMETYPE
static String	KEY_SENDMIMETYPE
static String	KEY_USERAGENT

Constructor Summary

Constructors

Constructor and Description
XDIHttpClient()
XDIHttpClient(HttpURLConnection httpURLConnection)
XDIHttpClient(HttpURLConnection httpURLConnection, Properties parameters)
XDIHttpClient(HttpURLConnection httpURLConnection, String xdiEndpointUri)
XDIHttpClient(HttpURLConnection httpURLConnection, URI xdiEndpointUri)
XDIHttpClient(HttpURLConnection httpURLConnection, URI xdiEndpointUri, MimeType sendMimeType, MimeType recvMimeType)
XDIHttpClient(HttpURLConnection httpURLConnection, URI xdiEndpointUri, MimeType sendMimeType, MimeType recvMimeType, String userAgent)
XDIHttpClient(HttpURLConnection httpURLConnection, URI xdiEndpointUri, MimeType sendMimeType, MimeType recvMimeType, String userAgent, Boolean followRedirects)
XDIHttpClient(Properties parameters)
XDIHttpClient(String xdiEndpointUri)
XDIHttpClient(URI xdiEndpointUri)
XDIHttpClient(URI xdiEndpointUri, MimeType sendMimeType, MimeType recvMimeType)
XDIHttpClient(URI xdiEndpointUri, MimeType sendMimeType, MimeType recvMimeType, String userAgent)
XDIHttpClient(URI xdiEndpointUri, MimeType sendMimeType, MimeType recvMimeType, String userAgent, Boolean followRedirects)

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down the client.
boolean	getFollowRedirects()
HttpURLConnection	getHttpURLConnection()
MimeType	getRecvMimeType()
MimeType	getSendMimeType()
String	getUserAgent()
URI	getXdiEndpointUri()
protected TransportMessagingResponse	sendInternal(MessageEnvelope messageEnvelope)
void	setFollowRedirects(boolean followRedirects)
void	setHttpURLConnection(HttpURLConnection httpURLConnection)
void	setRecvMimeType(MimeType recvMimeFormat)
void	setSendMimeType(MimeType sendMimeType)
void	setUserAgent(String userAgent)
void	setXdiEndpointUri(URI xdiEndpointUri)
String	toString()

Methods inherited from class xdi2.client.impl.XDIAbstractClient

addClientListener, createManipulationContext, fireDiscoverEvent, fireSendEvent, getManipulators, getXDIAbstractClient, putXDIAbstractClient, removeClientListener, send, setManipulators

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdi2.client.XDIClient

addClientListener, fireDiscoverEvent, fireSendEvent, removeClientListener, send

Field Detail

KEY_ENDPOINTURI

public static final String KEY_ENDPOINTURI

See Also:

Constant Field Values

KEY_SENDMIMETYPE

public static final String KEY_SENDMIMETYPE

See Also:

Constant Field Values

KEY_RECVMIMETYPE

public static final String KEY_RECVMIMETYPE

See Also:

Constant Field Values

KEY_USERAGENT

public static final String KEY_USERAGENT

See Also:

Constant Field Values

KEY_FOLLOWREDIRECTS

public static final String KEY_FOLLOWREDIRECTS

See Also:

Constant Field Values

DEFAULT_SENDMIMETYPE

public static final String DEFAULT_SENDMIMETYPE

See Also:

Constant Field Values

DEFAULT_RECVMIMETYPE

public static final String DEFAULT_RECVMIMETYPE

See Also:

Constant Field Values

DEFAULT_USERAGENT

public static final String DEFAULT_USERAGENT

See Also:

Constant Field Values

DEFAULT_FOLLOWREDIRECTS

public static final String DEFAULT_FOLLOWREDIRECTS

See Also:

Constant Field Values

Constructor Detail

XDIHttpClient

public XDIHttpClient(HttpURLConnection httpURLConnection,
                     URI xdiEndpointUri,
                     MimeType sendMimeType,
                     MimeType recvMimeType,
                     String userAgent,
                     Boolean followRedirects)

XDIHttpClient

public XDIHttpClient(HttpURLConnection httpURLConnection,
                     URI xdiEndpointUri,
                     MimeType sendMimeType,
                     MimeType recvMimeType,
                     String userAgent)

XDIHttpClient

public XDIHttpClient(HttpURLConnection httpURLConnection,
                     URI xdiEndpointUri,
                     MimeType sendMimeType,
                     MimeType recvMimeType)

XDIHttpClient

public XDIHttpClient(HttpURLConnection httpURLConnection,
                     URI xdiEndpointUri)

XDIHttpClient

public XDIHttpClient(HttpURLConnection httpURLConnection,
                     String xdiEndpointUri)

XDIHttpClient

public XDIHttpClient(HttpURLConnection httpURLConnection,
                     Properties parameters)

XDIHttpClient

public XDIHttpClient(HttpURLConnection httpURLConnection)

XDIHttpClient

public XDIHttpClient(URI xdiEndpointUri,
                     MimeType sendMimeType,
                     MimeType recvMimeType,
                     String userAgent,
                     Boolean followRedirects)

XDIHttpClient

public XDIHttpClient(URI xdiEndpointUri,
                     MimeType sendMimeType,
                     MimeType recvMimeType,
                     String userAgent)

XDIHttpClient

public XDIHttpClient(URI xdiEndpointUri,
                     MimeType sendMimeType,
                     MimeType recvMimeType)

XDIHttpClient

public XDIHttpClient(URI xdiEndpointUri)

XDIHttpClient

public XDIHttpClient(String xdiEndpointUri)

XDIHttpClient

public XDIHttpClient(Properties parameters)

XDIHttpClient

public XDIHttpClient()

Method Detail

sendInternal

protected TransportMessagingResponse sendInternal(MessageEnvelope messageEnvelope)
                                           throws Xdi2ClientException

Specified by:

sendInternal in class XDIAbstractClient<TransportMessagingResponse>

Throws:

Xdi2ClientException

close

public void close()

Description copied from interface: XDIClient

Shuts down the client.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface XDIClient<TransportMessagingResponse>

getHttpURLConnection

public HttpURLConnection getHttpURLConnection()

setHttpURLConnection

public void setHttpURLConnection(HttpURLConnection httpURLConnection)

getXdiEndpointUri

public URI getXdiEndpointUri()

setXdiEndpointUri

public void setXdiEndpointUri(URI xdiEndpointUri)

getSendMimeType

public MimeType getSendMimeType()

setSendMimeType

public void setSendMimeType(MimeType sendMimeType)

getRecvMimeType

public MimeType getRecvMimeType()

setRecvMimeType

public void setRecvMimeType(MimeType recvMimeFormat)

getUserAgent

public String getUserAgent()

setUserAgent

public void setUserAgent(String userAgent)

getFollowRedirects

public boolean getFollowRedirects()

setFollowRedirects

public void setFollowRedirects(boolean followRedirects)

toString

public String toString()

Overrides:

toString in class Object