org.apache.kerby.kerberos.kerb.identity.backend

Class AbstractIdentityBackend

java.lang.Object

org.apache.kerby.config.Configured

org.apache.kerby.kerberos.kerb.identity.backend.AbstractIdentityBackend

All Implemented Interfaces:

Configurable, IdentityBackend, IdentityService

Direct Known Subclasses:

MemoryIdentityBackend

public abstract class AbstractIdentityBackend
extends Configured
implements IdentityBackend

An abstract identity backend that provides default behaviors and 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 persistent storage by specific backend, like memory, file, SQL DB, LDAP, and etc.

Constructor Summary

Constructors

Constructor and Description
AbstractIdentityBackend()

Method Summary

Methods

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
protected abstract KrbIdentity	doAddIdentity(KrbIdentity identity) Add an identity, invoked by addIdentity, and return added identity.
protected abstract void	doDeleteIdentity(String principalName) Delete an identity, invoked by deleteIndentity.
protected abstract Iterable<String>	doGetIdentities() Perform the real work to get identities.
protected abstract KrbIdentity	doGetIdentity(String principalName) Add an identity, invoked by addIdentity.
protected AuthorizationData	doGetIdentityAuthorizationData(KdcClientRequest kdcClientRequest, EncTicketPart encTicketPart) Get an identity's Authorization Data, invoked by getIdentityAuthorizationData.
protected void	doInitialize() Perform the real initialization work for the backend.
protected void	doRelease() Perform the real release work for the backend.
protected void	doStart() Perform the real start work for the backend.
protected void	doStop() Perform the real stop work for the backend.
protected abstract KrbIdentity	doUpdateIdentity(KrbIdentity identity) Update an identity, invoked by updateIdentity, and return updated identity.
protected BackendConfig	getBackendConfig() Get the Backend Config.
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.
void	initialize() Init work for the backend can be done here.
void	release() Release the backend associated resources like connection.
void	start() Start the backend and return soon after the backend or the connection to it is well prepared and ready for KDC to use.
BatchTrans	startBatchTrans() Start a transaction.
void	stop() Stop the backend.
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

Methods inherited from interface org.apache.kerby.config.Configurable

getConfig, setConfig

Constructor Detail

AbstractIdentityBackend

public AbstractIdentityBackend()

Method Detail

getBackendConfig

protected BackendConfig getBackendConfig()

Get the Backend Config.

Returns:

The backend config

initialize

public void initialize()
                throws KrbException

Init work for the backend can be done here.

Specified by:

initialize in interface IdentityBackend

Throws:

KrbException - e

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

doInitialize

protected void doInitialize()
                     throws KrbException

Perform the real initialization work for the backend.

Throws:

KrbException - e

start

public void start()

Start the backend and return soon after the backend or the connection to it is well prepared and ready for KDC to use. Will be called during KDC startup.

Specified by:

start in interface IdentityBackend

doStart

protected void doStart()

Perform the real start work for the backend.

stop

public void stop()
          throws KrbException

Stop the backend. Will be called during KDC stop.

Specified by:

stop in interface IdentityBackend

Throws:

KrbException - e

doStop

protected void doStop()
               throws KrbException

Perform the real stop work for the backend.

Throws:

KrbException - e

release

public void release()

Release the backend associated resources like connection. Will be called during KDC shutdown.

Specified by:

release in interface IdentityBackend

doRelease

protected void doRelease()

Perform the real release work for the backend.

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

doGetIdentities

protected abstract Iterable<String> doGetIdentities()
                                             throws KrbException

Perform the real work to get identities.

Returns:

The identities

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

doGetIdentity

protected abstract KrbIdentity doGetIdentity(String principalName)
                                      throws KrbException

Add an identity, invoked by addIdentity.

Parameters:

principalName - The principal name

Returns:

The added identity

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

doGetIdentityAuthorizationData

protected AuthorizationData doGetIdentityAuthorizationData(KdcClientRequest kdcClientRequest,
                                               EncTicketPart encTicketPart)
                                                    throws KrbException

Get an identity's Authorization Data, invoked by getIdentityAuthorizationData.

Parameters:

kdcClientRequest - The KdcClientRequest

encTicketPart - The EncTicketPart being built for the KrbIdentity

Returns:

The Authorization Data

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

doAddIdentity

protected abstract KrbIdentity doAddIdentity(KrbIdentity identity)
                                      throws KrbException

Add an identity, invoked by addIdentity, and return added identity.

Parameters:

identity - The identity to be added

Returns:

The added 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

doUpdateIdentity

protected abstract KrbIdentity doUpdateIdentity(KrbIdentity identity)
                                         throws KrbException

Update an identity, invoked by updateIdentity, and return updated identity.

Parameters:

identity - The origin identity

Returns:

The updated 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

doDeleteIdentity

protected abstract void doDeleteIdentity(String principalName)
                                  throws KrbException

Delete an identity, invoked by deleteIndentity.

Parameters:

principalName - The principal name

Throws:

KrbException - e