XDIHttpClient (xdi2-client 0.7.2 API)

java.lang.Object
- xdi2.client.XDIAbstractClient
- - xdi2.client.http.XDIHttpClient

All Implemented Interfaces:

XDIClient
```
public class XDIHttpClient
extends XDIAbstractClient
implements XDIClient
```
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`
`protected boolean`	`followRedirects`
`static String`	`KEY_endpointUrl`
`static String`	`KEY_FOLLOWREDIRECTS`
`static String`	`KEY_RECVMIMETYPE`
`static String`	`KEY_SENDMIMETYPE`
`static String`	`KEY_USERAGENT`
`protected static org.slf4j.Logger`	`log`
`protected xdi2.core.io.MimeType`	`recvMimeType`
`protected xdi2.core.io.MimeType`	`sendMimeType`
`protected String`	`userAgent`
`protected URL`	`xdiEndpointUrl`

Constructor Summary

Constructors
Constructor and Description
`XDIHttpClient()`
`XDIHttpClient(Properties parameters)`
`XDIHttpClient(String xdiEndpointUrl)`
`XDIHttpClient(URL xdiEndpointUrl)`
`XDIHttpClient(URL xdiEndpointUrl, xdi2.core.io.MimeType sendMimeType, xdi2.core.io.MimeType recvMimeType)`
`XDIHttpClient(URL xdiEndpointUrl, xdi2.core.io.MimeType sendMimeType, xdi2.core.io.MimeType recvMimeType, String userAgent)`
`XDIHttpClient(URL xdiEndpointUrl, xdi2.core.io.MimeType sendMimeType, xdi2.core.io.MimeType recvMimeType, String userAgent, Boolean followRedirects)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Shuts down the client.
`boolean`	`getFollowRedirects()`
`xdi2.core.io.MimeType`	`getRecvMimeType()`
`xdi2.core.io.MimeType`	`getSendMimeType()`
`String`	`getUserAgent()`
`URL`	`getXdiEndpointUrl()`
`MessageResult`	`send(MessageEnvelope messageEnvelope, MessageResult messageResult)` Sends an XDI message envelope to an XDI endpoint and retrieves the results.
`void`	`setFollowRedirects(boolean followRedirects)`
`void`	`setRecvMimeType(xdi2.core.io.MimeType recvMimeFormat)`
`void`	`setSendMimeType(xdi2.core.io.MimeType sendMimeType)`
`void`	`setUserAgent(String userAgent)`
`void`	`setXdiEndpointUrl(URL xdiEndpointUrl)`
`String`	`toString()`

Methods inherited from class xdi2.client.XDIAbstractClient
addClientListener, fireDiscoverEvent, fireSendEvent, removeClientListener

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

Field Detail

KEY_endpointUrl

public static final String KEY_endpointUrl

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

log

protected static final org.slf4j.Logger log

xdiEndpointUrl
```
protected URL xdiEndpointUrl
```

sendMimeType

protected xdi2.core.io.MimeType sendMimeType

recvMimeType

protected xdi2.core.io.MimeType recvMimeType

userAgent
```
protected String userAgent
```

followRedirects
```
protected boolean followRedirects
```

Constructor Detail

XDIHttpClient
```
public XDIHttpClient()
```

XDIHttpClient

public XDIHttpClient(URL xdiEndpointUrl,
             xdi2.core.io.MimeType sendMimeType,
             xdi2.core.io.MimeType recvMimeType,
             String userAgent,
             Boolean followRedirects)

XDIHttpClient

public XDIHttpClient(URL xdiEndpointUrl,
             xdi2.core.io.MimeType sendMimeType,
             xdi2.core.io.MimeType recvMimeType,
             String userAgent)

XDIHttpClient

public XDIHttpClient(URL xdiEndpointUrl,
             xdi2.core.io.MimeType sendMimeType,
             xdi2.core.io.MimeType recvMimeType)

XDIHttpClient

public XDIHttpClient(URL xdiEndpointUrl)

XDIHttpClient

public XDIHttpClient(String xdiEndpointUrl)

XDIHttpClient

public XDIHttpClient(Properties parameters)
              throws Exception

Throws:: Exception

Method Detail

send
```
public MessageResult send(MessageEnvelope messageEnvelope,
                 MessageResult messageResult)
                   throws Xdi2ClientException
```
Description copied from interface: XDIClient

Sends an XDI message envelope to an XDI endpoint and retrieves the results.

Specified by:

send in interface XDIClient

Parameters:
messageEnvelope - The XDI message envelope to send.
messageResult - The message result that will hold results of the message. If this is null, a new message result will be created.

Returns:
The message result.

Throws:

Xdi2ClientException

close
```
public void close()
```
Description copied from interface: XDIClient

Shuts down the client.

Specified by:

close in interface XDIClient

getXdiEndpointUrl
```
public URL getXdiEndpointUrl()
```

setXdiEndpointUrl

public void setXdiEndpointUrl(URL xdiEndpointUrl)

getSendMimeType

public xdi2.core.io.MimeType getSendMimeType()

setSendMimeType

public void setSendMimeType(xdi2.core.io.MimeType sendMimeType)

getRecvMimeType

public xdi2.core.io.MimeType getRecvMimeType()

setRecvMimeType

public void setRecvMimeType(xdi2.core.io.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

Class XDIHttpClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class xdi2.client.XDIAbstractClient

Methods inherited from class java.lang.Object

Methods inherited from interface xdi2.client.XDIClient

Field Detail

KEY_endpointUrl

KEY_SENDMIMETYPE

KEY_RECVMIMETYPE

KEY_USERAGENT

KEY_FOLLOWREDIRECTS

DEFAULT_SENDMIMETYPE

DEFAULT_RECVMIMETYPE

DEFAULT_USERAGENT

DEFAULT_FOLLOWREDIRECTS

log

xdiEndpointUrl

sendMimeType

recvMimeType

userAgent

followRedirects

Constructor Detail

XDIHttpClient

XDIHttpClient

XDIHttpClient

XDIHttpClient

XDIHttpClient

XDIHttpClient

XDIHttpClient

Method Detail

send

close

getXdiEndpointUrl

setXdiEndpointUrl

getSendMimeType

setSendMimeType

getRecvMimeType

setRecvMimeType

getUserAgent

setUserAgent

getFollowRedirects

setFollowRedirects

toString