uk.ac.ed.epcc.webapp.http

Interface HttpService

All Superinterfaces:

AppContextCleanup, AppContextService<HttpService>

All Known Implementing Classes:

DefaultHttpService

public interface HttpService
extends AppContextService<HttpService>

A simple AppContextService to handle http client operaitons This is implemented as a service to allow substitution for mock testing.

Method Summary

Modifier and Type	Method and Description
default void	addBasicAuth(java.util.Map<java.lang.String,java.lang.String> props, java.lang.String username, java.lang.String password) Add an encoded Basic Authorization header
MimeStreamData	fetch(java.net.URL url, java.util.Map<java.lang.String,java.lang.String> props) fetch data from a URL
default java.lang.Class<HttpService>	getType() Returns the type of service the class should be registered under.
MimeStreamData	post(java.net.URL url, java.util.Map<java.lang.String,java.lang.String> props, MimeStreamData input) post data to a URL This is intended to post a single object rather than encoded form data.

Methods inherited from interface uk.ac.ed.epcc.webapp.AppContextCleanup

cleanup

Method Detail

fetch

MimeStreamData fetch(java.net.URL url,
                     java.util.Map<java.lang.String,java.lang.String> props)
              throws HttpException

fetch data from a URL

Parameters:

url - URL to fetch from

props - additional request headers to set

Returns:

MimeStreamData

Throws:

HttpException

post

MimeStreamData post(java.net.URL url,
                    java.util.Map<java.lang.String,java.lang.String> props,
                    MimeStreamData input)
             throws HttpException

post data to a URL This is intended to post a single object rather than encoded form data.

Parameters:

url - URL to post to

props - additional request headers to set

input - MimeStreamData to post

Returns:

MimeStreamData

Throws:

HttpException

addBasicAuth

default void addBasicAuth(java.util.Map<java.lang.String,java.lang.String> props,
                          java.lang.String username,
                          java.lang.String password)

Add an encoded Basic Authorization header

Parameters:

props -

username -

password -

getType

default java.lang.Class<HttpService> getType()

Description copied from interface: AppContextService

Returns the type of service the class should be registered under.

Specified by:

getType in interface AppContextService<HttpService>

Returns:

registration type