ball.http.ant.taskdefs

Class HTTPTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

ball.http.ant.taskdefs.HTTPTask

All Implemented Interfaces:

AnnotatedAntTask, AntTaskLogMethods, AntTaskMixIn, ClasspathDelegateAntTask, ConfigurableAntTask, Cloneable, HttpRequestInterceptor, HttpResponseInterceptor

Direct Known Subclasses:

HDHRPrimeClientTask, HTTPTask.Request, SDClientTask

public abstract class HTTPTask
extends Task
implements AnnotatedAntTask, ClasspathDelegateAntTask, ConfigurableAntTask, HttpRequestInterceptor, HttpResponseInterceptor

Abstract Ant base Task for web API client tasks.

<HTTPTask buffer="boolean" classname="String" classpathref="Reference" description="String" taskname="String">
  <classpath .../>
</HTTPTask>

Version:

$Revision: 5285 $

Author:

Allen D. Ball

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPTask.Delete Ant Task to DELETE.
static class	HTTPTask.Get Ant Task to GET.
static class	HTTPTask.Head Ant Task to HEAD.
static class	HTTPTask.NameValuePairImpl StringAttributeType implementation that includes NameValuePair.
static class	HTTPTask.Options Ant Task to OPTIONS.
static class	HTTPTask.Patch Ant Task to PATCH.
static class	HTTPTask.Post Ant Task to POST.
static class	HTTPTask.Put Ant Task to PUT.
protected static class	HTTPTask.Request Abstract Ant base Task for DELETE, GET, POST, and PUT operations.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
HTTPTask()

Method Summary

Modifier and Type	Method and Description
protected HttpClientBuilder	builder() Method to allow subclasses to configure the HttpClientBuilder.
void	execute() Default implementation for Task subclasses.
void	init() Default implementation for Task subclasses.
protected void	log(HttpContext context) See Task.log(String).
protected void	log(HttpMessage message) See Task.log(String).
protected void	log(String type, HttpEntity entity) See Task.log(String).
void	process(HttpRequest request, HttpContext context)
void	process(HttpResponse response, HttpContext context)

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Methods inherited from interface ball.util.ant.taskdefs.AnnotatedAntTask

getAntTaskName

Methods inherited from interface ball.util.ant.taskdefs.AntTaskLogMethods

log, log, log, log, log, log, log, log, log, log, log

Methods inherited from interface ball.util.ant.taskdefs.ClasspathDelegateAntTask

createClasspath, delegate, delegate, getClassForName, getClassLoader, setClassname, setClasspathref

Methods inherited from interface ball.util.ant.taskdefs.ConfigurableAntTask

configure

Constructor Detail

HTTPTask

public HTTPTask()

Method Detail

init

public void init()
          throws BuildException

Description copied from interface: ClasspathDelegateAntTask

Default implementation for Task subclasses.

Specified by:

init in interface ClasspathDelegateAntTask

Specified by:

init in interface ConfigurableAntTask

Overrides:

init in class Task

Throws:

BuildException

execute

public void execute()
             throws BuildException

Description copied from interface: AnnotatedAntTask

Default implementation for Task subclasses. Check attributes annotated with AntTaskAttributeConstraint. See AnnotatedAntTaskConfigurationChecker.

Specified by:

execute in interface AnnotatedAntTask

Overrides:

execute in class Task

Throws:

BuildException - If a AntTaskAttributeConstraint.Checker fails.

builder

protected HttpClientBuilder builder()

Method to allow subclasses to configure the HttpClientBuilder.

Returns:

The HttpClientBuilder.

process

public void process(HttpRequest request,
                    HttpContext context)
             throws IOException

Specified by:

process in interface HttpRequestInterceptor

Throws:

IOException

process

public void process(HttpResponse response,
                    HttpContext context)
             throws IOException

Specified by:

process in interface HttpResponseInterceptor

Throws:

IOException

log

protected void log(HttpContext context)

See Task.log(String).

Parameters:

context - The HttpContext to log.

log

protected void log(HttpMessage message)

See Task.log(String).

Parameters:

message - The HttpMessage to log.

log

protected void log(String type,
                   HttpEntity entity)

See Task.log(String).

Parameters:

type - The entity Content-Type (if specified).

entity - The HttpEntity to log.