KerberosClient (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.ws.security.kerberos.KerberosClient

All Implemented Interfaces:

Configurable
```
public class KerberosClient
extends Object
implements Configurable
```
A class that obtains a ticket from a KDC and wraps it in a SecurityToken object.

Constructor Summary

Constructors
Constructor and Description

KerberosClient()

KerberosClient(Bus b)
Deprecated.

Constructors
Constructor and Description
`KerberosClient()`
`KerberosClient(Bus b)` Deprecated.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getBeanName()` Get the configurable object's Bean name
`CallbackHandler`	`getCallbackHandler()` Get the CallbackHandler to use with the LoginContext
`String`	`getContextName()` Get the JAAS Login context name to use.
`String`	`getJaasLoginModuleName()` Deprecated. Get the JAAS Login module name to use.
`String`	`getServiceName()` Get the name of the service to use when contacting the KDC.
`boolean`	`isRequestCredentialDelegation()`
`boolean`	`isUseDelegatedCredential()`
`boolean`	`isUsernameServiceNameForm()`
`SecurityToken`	`requestSecurityToken()`
`void`	`setCallbackHandler(CallbackHandler callbackHandler)` Set the CallbackHandler to use with the LoginContext.
`void`	`setContextName(String contextName)` Set the JAAS Login context name to use.
`void`	`setJaasLoginModuleName(String jaasLoginModuleName)` Deprecated. Set the JAAS Login module name to use.
`void`	`setRequestCredentialDelegation(boolean requestCredentialDelegation)`
`void`	`setServiceName(String serviceName)` The name of the service to use when contacting the KDC.
`void`	`setUseDelegatedCredential(boolean useDelegatedCredential)`
`void`	`setUsernameServiceNameForm(boolean usernameServiceNameForm)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KerberosClient
```
@Deprecated
public KerberosClient(Bus b)
```
    Deprecated.
  - KerberosClient
```
public KerberosClient()
```
- Method Detail
  - getBeanName
```
public String getBeanName()
```
    Description copied from interface: Configurable
    
    Get the configurable object's Bean name
    
    Specified by:
    
    getBeanName in interface Configurable
    
    Returns:
    the bean name
  - getContextName
```
public String getContextName()
```
    Get the JAAS Login context name to use.
    
    Returns:
    the JAAS Login context name to use
  - setContextName
```
public void setContextName(String contextName)
```
    Set the JAAS Login context name to use.
    
    Parameters:
    contextName - the JAAS Login context name to use
  - getJaasLoginModuleName
```
public String getJaasLoginModuleName()
```
    Deprecated. Get the JAAS Login module name to use.
    
    Returns:
    the JAAS Login module name to use
  - setJaasLoginModuleName
```
public void setJaasLoginModuleName(String jaasLoginModuleName)
```
    Deprecated. Set the JAAS Login module name to use.
    
    Parameters:
    jaasLoginModuleName - the JAAS Login module name to use
  - getCallbackHandler
```
public CallbackHandler getCallbackHandler()
```
    Get the CallbackHandler to use with the LoginContext
    
    Returns:
    the CallbackHandler to use with the LoginContext
  - setCallbackHandler
```
public void setCallbackHandler(CallbackHandler callbackHandler)
```
    Set the CallbackHandler to use with the LoginContext. It can be null.
    
    Parameters:
    callbackHandler - the CallbackHandler to use with the LoginContext
  - setServiceName
```
public void setServiceName(String serviceName)
```
    The name of the service to use when contacting the KDC.
    
    Parameters:
    serviceName - the name of the service to use when contacting the KDC
  - getServiceName
```
public String getServiceName()
```
    Get the name of the service to use when contacting the KDC.
    
    Returns:
    the name of the service to use when contacting the KDC
  - requestSecurityToken
```
public SecurityToken requestSecurityToken()
                                   throws Exception
```
    Throws:
    
    Exception
  - isUsernameServiceNameForm
```
public boolean isUsernameServiceNameForm()
```
  - setUsernameServiceNameForm
```
public void setUsernameServiceNameForm(boolean usernameServiceNameForm)
```
  - isRequestCredentialDelegation
```
public boolean isRequestCredentialDelegation()
```
  - setRequestCredentialDelegation
```
public void setRequestCredentialDelegation(boolean requestCredentialDelegation)
```
  - isUseDelegatedCredential
```
public boolean isUseDelegatedCredential()
```
  - setUseDelegatedCredential
```
public void setUseDelegatedCredential(boolean useDelegatedCredential)
```

Class KerberosClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KerberosClient

KerberosClient

Method Detail

getBeanName

getContextName

setContextName

getJaasLoginModuleName

setJaasLoginModuleName

getCallbackHandler

setCallbackHandler

setServiceName

getServiceName

requestSecurityToken

isUsernameServiceNameForm

setUsernameServiceNameForm

isRequestCredentialDelegation

setRequestCredentialDelegation

isUseDelegatedCredential

setUseDelegatedCredential