orca.shirako.container.api
Interface IShirakoContainerDatabase

All Superinterfaces:

IContainerDatabase, IInitialize, ISerialize

All Known Subinterfaces:

IContainerManagementDatabase

All Known Implementing Classes:

LdapShirakoContainerDatabase, MySqlContainerManagementDatabase, MySqlShirakoContainerDatabase

public interface IShirakoContainerDatabase
extends IContainerDatabase, IInitialize, ISerialize

Interface for container-level databases. Defines the functions necessary for bootstrapping and recovering a shirako container.

Method Summary

void	addActor(IActor actor) Adds a new actor record to the database
void	addProtocols(java.util.Properties p) Adds the protocols record to the database
void	addTime(java.util.Properties p) Adds the time record to the database
java.util.Vector<java.util.Properties>	getActor(java.lang.String name) Retrieves the specified actor record
java.util.Vector<java.util.Properties>	getActors() Retrieves the actors defined in this container
java.util.Vector<java.util.Properties>	getActors(java.lang.String name, int type) Retrieves the actors defined in this container
java.util.Vector<java.util.Properties>	getProtocols() Retrieves the protocols record from the database
java.util.Vector<java.util.Properties>	getTime() Retrieves the time record from the database
void	removeActor(java.lang.String actorName) Removes the specified actor record
void	removeActorDatabase(java.lang.String actorName) Destroy the database for this actor.
void	updateActor(IActor actor) Updates the actor's database record

Methods inherited from interface orca.container.api.IContainerDatabase

addContainerProperties, getContainerProperties, getLogger, initialize, setLogger, setResetState, updateContainerProperties

Methods inherited from interface orca.shirako.api.IInitialize

initialize

Methods inherited from interface orca.shirako.api.ISerialize

reset, save, save

Method Detail

getActors

java.util.Vector<java.util.Properties> getActors()
                                                 throws java.lang.Exception

Retrieves the actors defined in this container

Throws:

java.lang.Exception

getActors

java.util.Vector<java.util.Properties> getActors(java.lang.String name,
                                                 int type)
                                                 throws java.lang.Exception

Retrieves the actors defined in this container

Parameters:

name - actor name query string

type - actor type (seed AbstractActor.Type*)

Returns:

Throws:

java.lang.Exception

getActor

java.util.Vector<java.util.Properties> getActor(java.lang.String name)
                                                throws java.lang.Exception

Retrieves the specified actor record

Parameters:

name - actor name

Throws:

java.lang.Exception

addActor

void addActor(IActor actor)
              throws java.lang.Exception

Adds a new actor record to the database

Parameters:

actor - actor to be added

Throws:

java.lang.Exception

removeActor

void removeActor(java.lang.String actorName)
                 throws java.lang.Exception

Removes the specified actor record

Parameters:

actorName - actor name

Throws:

java.lang.Exception

removeActorDatabase

void removeActorDatabase(java.lang.String actorName)
                         throws java.lang.Exception

Destroy the database for this actor. Applies to actors storing their database on the same database server as the container database.

Parameters:

actorName - actor name

Throws:

java.lang.Exception

updateActor

void updateActor(IActor actor)
                 throws java.lang.Exception

Updates the actor's database record

Parameters:

actor -

Throws:

java.lang.Exception

addTime

void addTime(java.util.Properties p)
             throws java.lang.Exception

Adds the time record to the database

Parameters:

p -

Throws:

java.lang.Exception

getTime

java.util.Vector<java.util.Properties> getTime()
                                               throws java.lang.Exception

Retrieves the time record from the database

Returns:

Throws:

java.lang.Exception

addProtocols

void addProtocols(java.util.Properties p)
                  throws java.lang.Exception

Adds the protocols record to the database

Parameters:

p -

Throws:

java.lang.Exception

getProtocols

java.util.Vector<java.util.Properties> getProtocols()
                                                    throws java.lang.Exception

Retrieves the protocols record from the database

Returns:

Throws:

java.lang.Exception