Top Description Inners Fields Constructors Methods
org.apache.hc.client5.http.auth

public Class KerberosConfig

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Annotations
@Deprecated
@Contract
threading:IMMUTABLE
Imports
org.apache.hc.core5.annotation.Contract, .ThreadingBehavior

Deprecated

Do not use. The GGS based experimental authentication schemes are no longer supported. Consider using Basic or Bearer authentication with TLS instead.

Immutable class encapsulating Kerberos configuration options.
Since
4.6

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static enum

Field Summary

Modifier and TypeField and Description
public static final KerberosConfig
DEFAULT

Deprecated as a consequence of KerberosConfig being deprecated.
private final KerberosConfig.Option
private final KerberosConfig.Option
private final KerberosConfig.Option

Constructor Summary

AccessConstructor and Description
protected
KerberosConfig()

Intended for CDI compatibility

pack-priv
KerberosConfig(final KerberosConfig.Option stripPort, final KerberosConfig.Option useCanonicalHostname, final KerberosConfig.Option requestDelegCreds)

Method Summary

Modifier and TypeMethod and Description
protected KerberosConfig
clone()

Overrides java.lang.Object.clone.

Deprecated as a consequence of KerberosConfig being deprecated.
Creates and returns a copy of this object.
public static KerberosConfig.Builder
copy(final KerberosConfig config)

Deprecated as a consequence of KerberosConfig being deprecated.
public static KerberosConfig.Builder
public KerberosConfig.Option
public KerberosConfig.Option
public KerberosConfig.Option
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

DEFAULTback to summary
public static final KerberosConfig DEFAULT

Deprecated

as a consequence of KerberosConfig being deprecated. See corresponding docs for further information.

requestDelegCredsback to summary
private final KerberosConfig.Option requestDelegCreds
stripPortback to summary
private final KerberosConfig.Option stripPort
useCanonicalHostnameback to summary
private final KerberosConfig.Option useCanonicalHostname

Constructor Detail

KerberosConfigback to summary
protected KerberosConfig()

Intended for CDI compatibility

KerberosConfigback to summary
pack-priv KerberosConfig(final KerberosConfig.Option stripPort, final KerberosConfig.Option useCanonicalHostname, final KerberosConfig.Option requestDelegCreds)

Method Detail

cloneback to summary
protected KerberosConfig clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Deprecated

as a consequence of KerberosConfig being deprecated. See corresponding docs for further information.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:KerberosConfig

a clone of this instance.

Annotations
@Override
Exceptions
CloneNotSupportedException:
if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.
copyback to summary
public static KerberosConfig.Builder copy(final KerberosConfig config)

Deprecated

as a consequence of KerberosConfig being deprecated. See corresponding docs for further information.

customback to summary
public static KerberosConfig.Builder custom()
getRequestDelegCredsback to summary
public KerberosConfig.Option getRequestDelegCreds()
getStripPortback to summary
public KerberosConfig.Option getStripPort()
getUseCanonicalHostnameback to summary
public KerberosConfig.Option getUseCanonicalHostname()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
org.apache.hc.client5.http.auth back to summary

public Class KerberosConfig.Builder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private KerberosConfig.Option
private KerberosConfig.Option
private KerberosConfig.Option

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public KerberosConfig
build()

Deprecated as a consequence of KerberosConfig being deprecated.
public KerberosConfig.Builder
setRequestDelegCreds(final KerberosConfig.Option requestDelegCreds)

public KerberosConfig.Builder
public KerberosConfig.Builder
setStripPort(final boolean stripPort)

public KerberosConfig.Builder
setUseCanonicalHostname(final KerberosConfig.Option useCanonicalHostname)

public KerberosConfig.Builder
setUseCanonicalHostname(final boolean useCanonicalHostname)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

requestDelegCredsback to summary
private KerberosConfig.Option requestDelegCreds
stripPortback to summary
private KerberosConfig.Option stripPort
useCanonicalHostnameback to summary
private KerberosConfig.Option useCanonicalHostname

Constructor Detail

Builderback to summary
pack-priv Builder()

Method Detail

buildback to summary
public KerberosConfig build()

Deprecated

as a consequence of KerberosConfig being deprecated. See corresponding docs for further information.

setRequestDelegCredsback to summary
public KerberosConfig.Builder setRequestDelegCreds(final KerberosConfig.Option requestDelegCreds)
setStripPortback to summary
public KerberosConfig.Builder setStripPort(final KerberosConfig.Option stripPort)
setStripPortback to summary
public KerberosConfig.Builder setStripPort(final boolean stripPort)
setUseCanonicalHostnameback to summary
public KerberosConfig.Builder setUseCanonicalHostname(final KerberosConfig.Option useCanonicalHostname)
setUseCanonicalHostnameback to summary
public KerberosConfig.Builder setUseCanonicalHostname(final boolean useCanonicalHostname)
org.apache.hc.client5.http.auth back to summary

public final Enum KerberosConfig.Option

extends Enum<KerberosConfig.Option>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final KerberosConfig.Option
public static final KerberosConfig.Option
public static final KerberosConfig.Option

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static KerberosConfig.Option
public static KerberosConfig.Option[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DEFAULTback to summary
public static final KerberosConfig.Option DEFAULT
DISABLEback to summary
public static final KerberosConfig.Option DISABLE
ENABLEback to summary
public static final KerberosConfig.Option ENABLE

Constructor Detail

Optionback to summary
private Option()

Method Detail

valueOfback to summary
public static KerberosConfig.Option valueOf(String name)
valuesback to summary
public static KerberosConfig.Option[] values()