org.jasig.cas.util
Class HttpClient

java.lang.Object
  org.jasig.cas.util.HttpClient

All Implemented Interfaces:

Serializable, org.springframework.beans.factory.DisposableBean

public final class HttpClient
extends Object
implements Serializable, org.springframework.beans.factory.DisposableBean

Since:

3.1

Version:

$Revision$ $Date$

Author:

Scott Battaglia

See Also:

Serialized Form

Constructor Summary

HttpClient()

Method Summary

void	destroy()
boolean	isValidEndPoint(String url)
boolean	isValidEndPoint(URL url)
boolean	sendMessageToEndPoint(String url, String message, boolean async) Sends a message to a particular endpoint.
void	setAcceptableCodes(int[] acceptableCodes) Set the acceptable HTTP status codes that we will use to determine if the response from the URL was correct.
void	setConnectionTimeout(int connectionTimeout)
void	setExecutorService(ExecutorService executorService) Note that changing this executor will affect all httpClients.
void	setFollowRedirects(boolean follow) Determines the behavior on receiving 3xx responses from HTTP endpoints.
void	setReadTimeout(int readTimeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClient

public HttpClient()

Method Detail

setExecutorService

public void setExecutorService(ExecutorService executorService)

Note that changing this executor will affect all httpClients. While not ideal, this change was made because certain ticket registries were persisting the HttpClient and thus getting serializable exceptions.

Parameters:

executorService -

sendMessageToEndPoint

public 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

public boolean isValidEndPoint(String url)

isValidEndPoint

public boolean isValidEndPoint(URL url)

setAcceptableCodes

public final void setAcceptableCodes(int[] acceptableCodes)

Set the acceptable HTTP status codes that we will use to determine if the response from the URL was correct.

Parameters:

acceptableCodes - an array of status code integers.

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

setReadTimeout

public void setReadTimeout(int readTimeout)

setFollowRedirects

public void setFollowRedirects(boolean follow)

Determines the behavior on receiving 3xx responses from HTTP endpoints.

Parameters:

follow - True to follow 3xx redirects (default), false otherwise.

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception