org.apereo.cas.util.http

Class SimpleHttpClient

java.lang.Object

org.apereo.cas.util.http.SimpleHttpClient

All Implemented Interfaces:

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

public class SimpleHttpClient
extends java.lang.Object
implements HttpClient, java.io.Serializable, org.springframework.beans.factory.DisposableBean

Implementation of CAS HttpClient which delegates requests to a httpClient instance.

Since:

3.1

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	destroy() Shutdown the executor service and close the http client.
org.apache.http.client.HttpClient	getWrappedHttpClient() Gets wrapped http client.
boolean	isValidEndPoint(java.lang.String url) Make a synchronous HTTP(S) call to ensure that the url is reachable.
boolean	isValidEndPoint(java.net.URL url) Make a synchronous HTTP(S) call to ensure that the url is reachable.
boolean	sendMessageToEndPoint(HttpMessage message) Sends a message to a particular endpoint.
HttpMessage	sendMessageToEndPoint(java.net.URL url) Contact the URL endpoint as a GET and return the resulting http message.

Methods inherited from class java.lang.Object

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

Method Detail

sendMessageToEndPoint

public boolean sendMessageToEndPoint(HttpMessage message)

Description copied from interface: HttpClient

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:

message - The message that should be sent to the http endpoint

Returns:

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

sendMessageToEndPoint

public HttpMessage sendMessageToEndPoint(java.net.URL url)

Description copied from interface: HttpClient

Contact the URL endpoint as a GET and return the resulting http message.

Specified by:

sendMessageToEndPoint in interface HttpClient

Parameters:

url - the url

Returns:

the http message

isValidEndPoint

public boolean isValidEndPoint(java.lang.String url)

Description copied from interface: HttpClient

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(java.net.URL url)

Description copied from interface: HttpClient

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

destroy

public void destroy()
             throws java.lang.Exception

Shutdown the executor service and close the http client.

Specified by:

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

Throws:

java.lang.Exception - if the executor cannot properly shut down

getWrappedHttpClient

public org.apache.http.client.HttpClient getWrappedHttpClient()

Description copied from interface: HttpClient

Gets wrapped http client.

Specified by:

getWrappedHttpClient in interface HttpClient

Returns:

the wrapped http client