org.jasig.cas.util

Interface HttpClient

All Known Implementing Classes:

SimpleHttpClient

public interface HttpClient

Define the behaviour of a HTTP client.

Since:

4.0

Author:

Jerome Leleu

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isValidEndPoint(String url) Make a synchronous HTTP(S) call to ensure that the url is reachable.
boolean	isValidEndPoint(URL url) Make a synchronous HTTP(S) call to ensure that the url is reachable.
boolean	sendMessageToEndPoint(String url, String message, boolean async) Sends a message to a particular endpoint.

Method Detail

sendMessageToEndPoint

boolean sendMessageToEndPoint(String url,
                            String message,
                            boolean async)

Sends a message to a particular endpoint. Option of sending it without waiting to ensure a response was returned.

This is useful when it doesn't matter about the response as you'll perform no action based on the response.

Parameters:

url - the url to send the message to

message - the message itself

async - true if you don't want to wait for the response, false otherwise.

Returns:

boolean if the message was sent, or async was used. false if the message failed.

isValidEndPoint

boolean isValidEndPoint(String url)

Make a synchronous HTTP(S) call to ensure that the url is reachable.

Parameters:

url - the url to call

Returns:

whether the url is valid

isValidEndPoint

boolean isValidEndPoint(URL url)

Make a synchronous HTTP(S) call to ensure that the url is reachable.

Parameters:

url - the url to call

Returns:

whether the url is valid