org.jasig.cas.util

Class SimpleHttpClient

java.lang.Object

org.jasig.cas.util.SimpleHttpClient

All Implemented Interfaces:

Serializable, HttpClient, org.springframework.beans.factory.DisposableBean

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

Since:

3.1

Author:

Scott Battaglia

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimpleHttpClient()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Shutdown the executor service.
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.
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) Sets a specified timeout value, in milliseconds, to be used when opening the endpoint url.
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	setHostnameVerifier(HostnameVerifier verifier) Set the hostname verifier be used by the URL when submitting request to check for URL endpoint validity.
void	setReadTimeout(int readTimeout) Sets a specified timeout value, in milliseconds, to be used when reading from the endpoint url.
void	setSSLSocketFactory(SSLSocketFactory factory) Set the SSL socket factory be used by the URL when submitting request to check for URL endpoint validity.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleHttpClient

public SimpleHttpClient()

Method Detail

setExecutorService

public void setExecutorService(@NotNull
                      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 - The executor service to send messages to end points.

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.

Specified by:

sendMessageToEndPoint in interface HttpClient

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)

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

Specified by:

isValidEndPoint in interface HttpClient

Parameters:

url - the url to call

Returns:

whether the url is valid

isValidEndPoint

public boolean isValidEndPoint(URL url)

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

Specified by:

isValidEndPoint in interface HttpClient

Parameters:

url - the url to call

Returns:

whether the url is valid

setAcceptableCodes

public 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)

Sets a specified timeout value, in milliseconds, to be used when opening the endpoint url.

Parameters:

connectionTimeout - specified timeout value in milliseconds

setReadTimeout

public void setReadTimeout(int readTimeout)

Sets a specified timeout value, in milliseconds, to be used when reading from the endpoint url.

Parameters:

readTimeout - specified timeout value in milliseconds

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.

setSSLSocketFactory

public void setSSLSocketFactory(SSLSocketFactory factory)

Set the SSL socket factory be used by the URL when submitting request to check for URL endpoint validity.

Parameters:

factory - ssl socket factory instance to use

See Also:

isValidEndPoint(URL)

setHostnameVerifier

public void setHostnameVerifier(HostnameVerifier verifier)

Set the hostname verifier be used by the URL when submitting request to check for URL endpoint validity.

Parameters:

verifier - hostname verifier instance to use

See Also:

isValidEndPoint(URL)

destroy

public void destroy()
             throws Exception

Shutdown the executor service.

Specified by:

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

Throws:

Exception - if the executor cannot properly shut down