org.springframework.security.kerberos.client

Class KerberosRestTemplate

java.lang.Object

org.springframework.http.client.support.HttpAccessor

org.springframework.http.client.support.InterceptingHttpAccessor

org.springframework.web.client.RestTemplate

org.springframework.security.kerberos.client.KerberosRestTemplate

All Implemented Interfaces:

org.springframework.web.client.RestOperations

public class KerberosRestTemplate
extends org.springframework.web.client.RestTemplate

RestTemplate that is able to make kerberos SPNEGO authenticated REST requests. Under a hood this KerberosRestTemplate is using HttpClient to support Kerberos.

Generally this template can be configured in few different ways.

• Leave keyTabLocation and userPrincipal empty if you want to use cached ticket
• Use keyTabLocation and userPrincipal if you want to use keytab file
• Use loginOptions if you want to customise Krb5LoginModule options
• Use a customised httpClient

Author:

Janne Valkealahti

Field Summary

Fields inherited from class org.springframework.http.client.support.HttpAccessor

logger

Constructor Summary

Constructors

Constructor and Description
KerberosRestTemplate() Instantiates a new kerberos rest template.
KerberosRestTemplate(org.apache.http.client.HttpClient httpClient) Instantiates a new kerberos rest template.
KerberosRestTemplate(java.util.Map<java.lang.String,java.lang.Object> loginOptions) Instantiates a new kerberos rest template.
KerberosRestTemplate(java.util.Map<java.lang.String,java.lang.Object> loginOptions, org.apache.http.client.HttpClient httpClient) Instantiates a new kerberos rest template.
KerberosRestTemplate(java.lang.String keyTabLocation, java.lang.String userPrincipal) Instantiates a new kerberos rest template.
KerberosRestTemplate(java.lang.String keyTabLocation, java.lang.String userPrincipal, org.apache.http.client.HttpClient httpClient) Instantiates a new kerberos rest template.
KerberosRestTemplate(java.lang.String keyTabLocation, java.lang.String userPrincipal, java.util.Map<java.lang.String,java.lang.Object> loginOptions) Instantiates a new kerberos rest template.

Method Summary

Methods

Modifier and Type	Method and Description
protected <T> T	doExecute(java.net.URI url, org.springframework.http.HttpMethod method, org.springframework.web.client.RequestCallback requestCallback, org.springframework.web.client.ResponseExtractor<T> responseExtractor)

Methods inherited from class org.springframework.web.client.RestTemplate

acceptHeaderRequestCallback, delete, delete, delete, exchange, exchange, exchange, exchange, exchange, exchange, exchange, exchange, execute, execute, execute, getErrorHandler, getForEntity, getForEntity, getForEntity, getForObject, getForObject, getForObject, getMessageConverters, handleResponse, headersExtractor, headForHeaders, headForHeaders, headForHeaders, httpEntityCallback, httpEntityCallback, optionsForAllow, optionsForAllow, optionsForAllow, postForEntity, postForEntity, postForEntity, postForLocation, postForLocation, postForLocation, postForObject, postForObject, postForObject, put, put, put, responseEntityExtractor, setErrorHandler, setMessageConverters

Methods inherited from class org.springframework.http.client.support.InterceptingHttpAccessor

getInterceptors, getRequestFactory, setInterceptors

Methods inherited from class org.springframework.http.client.support.HttpAccessor

createRequest, setRequestFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

KerberosRestTemplate

public KerberosRestTemplate()

Instantiates a new kerberos rest template.

KerberosRestTemplate

public KerberosRestTemplate(org.apache.http.client.HttpClient httpClient)

Instantiates a new kerberos rest template.

Parameters:

httpClient - the http client

KerberosRestTemplate

public KerberosRestTemplate(java.lang.String keyTabLocation,
                    java.lang.String userPrincipal)

Instantiates a new kerberos rest template.

Parameters:

keyTabLocation - the key tab location

userPrincipal - the user principal

KerberosRestTemplate

public KerberosRestTemplate(java.lang.String keyTabLocation,
                    java.lang.String userPrincipal,
                    org.apache.http.client.HttpClient httpClient)

Instantiates a new kerberos rest template.

Parameters:

keyTabLocation - the key tab location

userPrincipal - the user principal

httpClient - the http client

KerberosRestTemplate

public KerberosRestTemplate(java.util.Map<java.lang.String,java.lang.Object> loginOptions)

Instantiates a new kerberos rest template.

Parameters:

loginOptions - the login options

KerberosRestTemplate

public KerberosRestTemplate(java.util.Map<java.lang.String,java.lang.Object> loginOptions,
                    org.apache.http.client.HttpClient httpClient)

Instantiates a new kerberos rest template.

Parameters:

loginOptions - the login options

httpClient - the http client

KerberosRestTemplate

public KerberosRestTemplate(java.lang.String keyTabLocation,
                    java.lang.String userPrincipal,
                    java.util.Map<java.lang.String,java.lang.Object> loginOptions)

Instantiates a new kerberos rest template.

Parameters:

keyTabLocation - the key tab location

userPrincipal - the user principal

loginOptions - the login options

Method Detail

doExecute

protected final <T> T doExecute(java.net.URI url,
              org.springframework.http.HttpMethod method,
              org.springframework.web.client.RequestCallback requestCallback,
              org.springframework.web.client.ResponseExtractor<T> responseExtractor)
                     throws org.springframework.web.client.RestClientException

Overrides:

doExecute in class org.springframework.web.client.RestTemplate

Throws:

org.springframework.web.client.RestClientException