org.oddjob.jetty

Class JettyHttpClient

java.lang.Object

org.oddjob.jetty.JettyHttpClient

All Implemented Interfaces:

java.util.concurrent.Callable<java.lang.Integer>

public class JettyHttpClient
extends java.lang.Object
implements java.util.concurrent.Callable<java.lang.Integer>

Description

Execute an HTTP client request.

This is a very simple wrapper around Jetty's HTTPClient. Only PUT and GET requests are supported. Basic Authentication is supported, and so are SSL connections.

Example

Get the content of a URL using a parameter.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <properties>
                    <values>
                        <value key="some.url" value="http://www.google.com/search"/>
                    </values>
                </properties>
                <web:client id="request" url="${some.url}" xmlns:web="oddjob:web">
                    <parameters>
                        <map>
                            <values>
                                <value key="q" value="gold fish"/>
                            </values>
                        </map>
                    </parameters>
                </web:client>
                <echo>${request.content}</echo>
            </jobs>
        </sequential>
    </job>
</oddjob>

Example

Basic Authentication.

<oddjob id="oddjob">
    <job>
        <web:client id="client" url="http://localhost:${server.port}" xmlns:web="oddjob:web">
            <basicAuthentication>
                <is username="alice" password="secret"/>
            </basicAuthentication>
        </web:client>
    </job>
</oddjob>

Example

Download to a file.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <properties>
                    <values>
                        <value key="some.url" value="http://ipv4.download.thinkbroadband.com/1GB.zip"/>
                        <value key="some.file" value="download.zip"/>
                    </values>
                </properties>
                <web:client id="request" name="Download Example" url="${some.url}" xmlns:web="oddjob:web">
                    <output>
                        <file file="${some.file}"/>
                    </output>
                </web:client>
            </jobs>
        </sequential>
    </job>
</oddjob>

Author:

rob

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JettyHttpClient.RequestMethod
static class	JettyHttpClient.UsernamePassword

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TIMEOUT_SECONDS

Constructor Summary

Constructors

Constructor and Description
JettyHttpClient()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	call()
JettyHttpClient.UsernamePassword	getBasicAuthentication()
java.lang.String	getContent()
long	getContentLength()
java.lang.String	getContentType()
long	getDownloadCount()
JettyHttpClient.RequestMethod	getMethod()
java.lang.String	getName()
java.io.OutputStream	getOutput()
java.util.Map<java.lang.String,java.lang.String>	getParameters()
Progress	getProgress()
java.lang.String	getRequestBody()
java.lang.String	getResponseBody()
ClientSslProvider	getSsl()
int	getStatus()
long	getTimeout()
java.lang.String	getUrl()
void	setBasicAuthentication(JettyHttpClient.UsernamePassword basicAuthentication)
void	setContent(java.lang.String content)
void	setContentType(java.lang.String contentType)
void	setMethod(JettyHttpClient.RequestMethod method)
void	setName(java.lang.String name)
void	setOutput(java.io.OutputStream output)
void	setParameters(java.util.Map<java.lang.String,java.lang.String> properties)
void	setRequestBody(java.lang.String requestBody)
void	setSsl(ClientSslProvider ssl)
void	setTimeout(long timeout)
void	setUrl(java.lang.String url)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT_SECONDS

public static final int DEFAULT_TIMEOUT_SECONDS

See Also:

Constant Field Values

Constructor Detail

JettyHttpClient

public JettyHttpClient()

Method Detail

call

public java.lang.Integer call()
                       throws java.lang.Exception

Specified by:

call in interface java.util.concurrent.Callable<java.lang.Integer>

Throws:

java.lang.Exception

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

setUrl

public void setUrl(java.lang.String url)

getUrl

public java.lang.String getUrl()

getStatus

public int getStatus()

getContent

public java.lang.String getContent()

Property: content

Description: The request body to send or the response body received. This maps to requestBody and responseBody as a convenience but is confusing so should probably be deprecated.

Required: No.

setContent

public void setContent(java.lang.String content)

getRequestBody

public java.lang.String getRequestBody()

setRequestBody

public void setRequestBody(java.lang.String requestBody)

getResponseBody

public java.lang.String getResponseBody()

getMethod

public JettyHttpClient.RequestMethod getMethod()

setMethod

public void setMethod(JettyHttpClient.RequestMethod method)

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> properties)

getContentType

public java.lang.String getContentType()

setContentType

public void setContentType(java.lang.String contentType)

getBasicAuthentication

public JettyHttpClient.UsernamePassword getBasicAuthentication()

setBasicAuthentication

public void setBasicAuthentication(JettyHttpClient.UsernamePassword basicAuthentication)

getSsl

public ClientSslProvider getSsl()

setSsl

public void setSsl(ClientSslProvider ssl)

getProgress

public Progress getProgress()

getContentLength

public long getContentLength()

getDownloadCount

public long getDownloadCount()

getOutput

public java.io.OutputStream getOutput()

setOutput

public void setOutput(java.io.OutputStream output)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object