org.apache.directory.kerberos.client

Class ClientRequestOptions

java.lang.Object

org.apache.directory.kerberos.client.ClientRequestOptions

public class ClientRequestOptions
extends Object

Parameters for controlling a connection to a Kerberos server (KDC). 3.1.1. Generation of KRB_AS_REQ Message The client may specify a number of options in the initial request.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static int	DAY The number of milliseconds in a day.
static int	MINUTE The number of milliseconds in a minute.
static int	WEEK The number of milliseconds in a week.

Constructor Summary

Constructors

Constructor and Description
ClientRequestOptions() Creates a new instance of KdcControls.

Method Summary

Methods

Modifier and Type	Method and Description
long	getAllowedClockSkew() Returns the allowed clock skew.
Set<InetAddress>	getClientAddresses() Returns the client addresses.
Set<EncryptionType>	getEncryptionTypes() Returns the encryption types.
long	getLifeTime()
long	getRenewableLifetime()
Date	getStartTime() Returns the start time.
int	getUdpPreferenceLimit()
boolean	isAllowPostdate() Returns whether postdating is allowed.
boolean	isForwardable() Returns whether to request a forwardable ticket.
boolean	isForwarded() Returns whether to request a forwarded ticket.
boolean	isProxiable() Returns whether to request a proxiable ticket.
boolean	isProxy() Returns whether to request a proxy ticket.
boolean	isRenewableOk() Returns whether renewable tickets are OK.
boolean	isUsePaEncTimestamp() Returns whether pre-authentication by encrypted timestamp is to be performed.
void	setAllowedClockSkew(long allowedClockSkew)
void	setAllowPostdate(boolean isAllowPostdate) Sets whether postdating is allowed.
void	setClientAddresses(Set<InetAddress> clientAddresses) Sets the client addresses.
void	setEncryptionTypes(Set<EncryptionType> encryptionTypes)
void	setForwardable(boolean isForwardable) Sets whether to request a forwardable ticket.
void	setForwarded(boolean isForwarded) Sets whether to request a forwarded ticket.
void	setLifeTime(long lifeTime) Requests a ticket with the specified lifetime.
void	setProxiable(boolean isProxiable) Sets whether to request a proxiable ticket.
void	setProxy(boolean isProxy) Sets whether to request a proxy ticket.
void	setRenewableLifetime(long renewableLifetime) Requests a ticket with the specified total lifetime.
void	setRenewableOk(boolean isRenewableOk) Sets whether renewable tickets are OK.
void	setStartTime(Date startTime) Request a postdated ticket, valid starting at the specified start time.
void	setUdpPreferenceLimit(int udpPreferenceLimit) Default is UDP.
void	setUsePaEncTimestamp(boolean usePaEncTimestamp)

Methods inherited from class java.lang.Object

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

Field Detail

MINUTE

public static final int MINUTE

The number of milliseconds in a minute.

See Also:

Constant Field Values

DAY

public static final int DAY

The number of milliseconds in a day.

See Also:

Constant Field Values

WEEK

public static final int WEEK

The number of milliseconds in a week.

See Also:

Constant Field Values

Constructor Detail

ClientRequestOptions

public ClientRequestOptions()

Creates a new instance of KdcControls.

Method Detail

getAllowedClockSkew

public long getAllowedClockSkew()

Returns the allowed clock skew.

Returns:

The allowed clock skew.

setAllowedClockSkew

public void setAllowedClockSkew(long allowedClockSkew)

Parameters:

allowedClockSkew - The allowedClockSkew to set.

isUsePaEncTimestamp

public boolean isUsePaEncTimestamp()

Returns whether pre-authentication by encrypted timestamp is to be performed.

Returns:

Whether pre-authentication by encrypted timestamp is to be performed.

setUsePaEncTimestamp

public void setUsePaEncTimestamp(boolean usePaEncTimestamp)

Parameters:

usePaEncTimestamp - Whether to use encrypted timestamp pre-authentication.

getUdpPreferenceLimit

public int getUdpPreferenceLimit()

Returns:

The udpPreferenceLimit.

setUdpPreferenceLimit

public void setUdpPreferenceLimit(int udpPreferenceLimit)

Default is UDP. Set to 1 to use TCP.

Parameters:

udpPreferenceLimit -

getStartTime

public Date getStartTime()

Returns the start time.

Returns:

The start time.

setStartTime

public void setStartTime(Date startTime)

Request a postdated ticket, valid starting at the specified start time. Postdated tickets are issued in an invalid state and must be validated by the KDC before use.

Parameters:

startTime -

isForwardable

public boolean isForwardable()

Returns whether to request a forwardable ticket.

Returns:

true if the request is for a forwardable ticket.

setForwardable

public void setForwardable(boolean isForwardable)

Sets whether to request a forwardable ticket.

Parameters:

isForwardable -

isForwarded

public boolean isForwarded()

Returns whether to request a forwarded ticket.

Returns:

true if the request is for a forwarded ticket.

setForwarded

public void setForwarded(boolean isForwarded)

Sets whether to request a forwarded ticket.

Parameters:

isForwarded -

isProxiable

public boolean isProxiable()

Returns whether to request a proxiable ticket.

Returns:

true if the request is for a proxiable ticket.

setProxiable

public void setProxiable(boolean isProxiable)

Sets whether to request a proxiable ticket.

Parameters:

isProxiable -

isProxy

public boolean isProxy()

Returns whether to request a proxy ticket.

Returns:

true if the request is for a proxy ticket.

setProxy

public void setProxy(boolean isProxy)

Sets whether to request a proxy ticket.

Parameters:

isProxy -

getLifeTime

public long getLifeTime()

Returns:

The lifetime in milliseconds.

setLifeTime

public void setLifeTime(long lifeTime)

Requests a ticket with the specified lifetime. The value for lifetime is in milliseconds. Constants are provided for MINUTE, DAY, and WEEK.

Parameters:

lifeTime - The lifetime to set.

getRenewableLifetime

public long getRenewableLifetime()

Returns:

The renewable lifetime.

setRenewableLifetime

public void setRenewableLifetime(long renewableLifetime)

Requests a ticket with the specified total lifetime. The value for lifetime is in milliseconds. Constants are provided for MINUTE, DAY, and WEEK.

Parameters:

renewableLifetime - The renewable lifetime to set.

getEncryptionTypes

public Set<EncryptionType> getEncryptionTypes()

Returns the encryption types.

Returns:

The encryption types.

setEncryptionTypes

public void setEncryptionTypes(Set<EncryptionType> encryptionTypes)

Parameters:

encryptionTypes - The encryption types to set.

getClientAddresses

public Set<InetAddress> getClientAddresses()

Returns the client addresses.

Returns:

The client addresses.

setClientAddresses

public void setClientAddresses(Set<InetAddress> clientAddresses)

Sets the client addresses.

Parameters:

clientAddresses -

isAllowPostdate

public boolean isAllowPostdate()

Returns whether postdating is allowed.

Returns:

true if postdating is allowed.

setAllowPostdate

public void setAllowPostdate(boolean isAllowPostdate)

Sets whether postdating is allowed.

Parameters:

isAllowPostdate - Whether postdating is allowed.

isRenewableOk

public boolean isRenewableOk()

Returns whether renewable tickets are OK.

Returns:

true if renewable tickets are OK.

setRenewableOk

public void setRenewableOk(boolean isRenewableOk)

Sets whether renewable tickets are OK.

Parameters:

isRenewableOk - Whether renewable tickets are OK.