org.apache.kerby.kerberos.kerb.identity

Class CacheableIdentityService

java.lang.Object

org.apache.kerby.config.Configured

org.apache.kerby.kerberos.kerb.identity.CacheableIdentityService

All Implemented Interfaces:

Configurable, IdentityService

public class CacheableIdentityService
extends Configured
implements IdentityService

A cacheable identity backend that provides a cache with FIFO and size limit. Note only limited recently active identities are kept in the cache, and other identities are meant to be loaded from the underlying backend like memory, file, SQL DB, LDAP, and etc.

Constructor Summary

Constructors

Constructor and Description
CacheableIdentityService(Config config, IdentityService underlying)

Method Summary

Modifier and Type	Method and Description
KrbIdentity	addIdentity(KrbIdentity identity) Add an identity, and return the newly created result.
void	deleteIdentity(String principalName) Delete the identity specified by principal name
Iterable<String>	getIdentities() Get all of the identity principal names.
KrbIdentity	getIdentity(String principalName) Get the identity account specified by name.
AuthorizationData	getIdentityAuthorizationData(KdcClientRequest kdcClientRequest, EncTicketPart encTicketPart) Get an identity's Authorization Data.
BatchTrans	startBatchTrans() Start a transaction.
boolean	supportBatchTrans() Query to know if xtrans is supported or not.
KrbIdentity	updateIdentity(KrbIdentity identity) Update an identity, and return the updated result.

Methods inherited from class org.apache.kerby.config.Configured

getConfig, setConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheableIdentityService

public CacheableIdentityService(Config config,
                                IdentityService underlying)

Method Detail

supportBatchTrans

public boolean supportBatchTrans()

Query to know if xtrans is supported or not.

Specified by:

supportBatchTrans in interface IdentityService

Returns:

true if supported, false otherwise

startBatchTrans

public BatchTrans startBatchTrans()
                           throws KrbException

Start a transaction.

Specified by:

startBatchTrans in interface IdentityService

Returns:

xtrans The batch trans

Throws:

KrbException - e

getIdentities

public Iterable<String> getIdentities()
                               throws KrbException

Get all of the identity principal names. Note it's ordered by principal name.

Specified by:

getIdentities in interface IdentityService

Returns:

principal names

Throws:

KrbException - e

getIdentity

public KrbIdentity getIdentity(String principalName)
                        throws KrbException

Get the identity account specified by name.

Specified by:

getIdentity in interface IdentityService

Parameters:

principalName - The principal name

Returns:

identity

Throws:

KrbException - e

addIdentity

public KrbIdentity addIdentity(KrbIdentity identity)
                        throws KrbException

Add an identity, and return the newly created result.

Specified by:

addIdentity in interface IdentityService

Parameters:

identity - The identity

Returns:

identity

Throws:

KrbException - e

updateIdentity

public KrbIdentity updateIdentity(KrbIdentity identity)
                           throws KrbException

Update an identity, and return the updated result.

Specified by:

updateIdentity in interface IdentityService

Parameters:

identity - The identity

Returns:

identity

Throws:

KrbException - e

deleteIdentity

public void deleteIdentity(String principalName)
                    throws KrbException

Delete the identity specified by principal name

Specified by:

deleteIdentity in interface IdentityService

Parameters:

principalName - The principal name

Throws:

KrbException - e

getIdentityAuthorizationData

public AuthorizationData getIdentityAuthorizationData(KdcClientRequest kdcClientRequest,
                                                      EncTicketPart encTicketPart)
                                               throws KrbException

Get an identity's Authorization Data.

Specified by:

getIdentityAuthorizationData in interface IdentityService

Parameters:

kdcClientRequest - The KdcClientRequest

encTicketPart - The EncTicketPart being built for the KrbIdentity

Returns:

The Authorization Data

Throws:

KrbException - e