DBAgent (UnetStack 3.4.0 API)

org.arl.unet.c3.server.DBAgent

UnetC3 database agent base class.

Field Summary

Fields
Modifiers	Name	Description
`protected String`	`DBPASSWORD`	Password for the database connection.
`protected String`	`DBURL`	Database connection URL.
`protected String`	`DBUSERNAME`	Username for the database connection.
`static String`	`DEFAULT_DBPASSWORD`
`static String`	`DEFAULT_DBURL`	Default database URL for all DBAgents.
`static String`	`DEFAULT_DBUSERNAME`
`protected ExecutorService`	`executor`	Executor to process blocking operations.

Inherited fields
Fields inherited from class	Fields
`class Agent`	`NON_BLOCKING, BLOCKING`

Methods Summary

Methods
Type Params	Return Type	Name and description
`<T>`	`protected Future<T>`	`async(Callable<T> task)` Runs a long-running task asynchronously in a non-agent thread.
	`protected Future<?>`	`async(Runnable task)` Runs a long-running task asynchronously in a non-agent thread.
	`protected Connection`	`connect()` Gets a connection to the database.
	`protected String`	`getBuildInfo()` Gets the build string for a given class.
	`protected void`	`init()` Initialize the C3 database agent and its behaviors.
	`protected void`	`processMessage(Message msg)` An agent wishing to process all messages other than requests and queries may override this method to handle incoming messages.
	`protected boolean`	`processRequest(Message msg)` An agent supporting requests should override this method to handle incoming requests.
	`protected void`	`setup()` Called by DBAgent when the agent is being initialized.
	`protected void`	`shutdown()`
	`protected void`	`startup()` Called by DBAgent after all agents are fully initialized.
	`protected void`	`subscribeForService(String service)` Subscribe to all agents providing a specified service.
	`protected void`	`subscribeForService(Enum<?> service)` Subscribe to all agents providing a specified service.
	`protected boolean`	`tableExists(String table)` Checks if a table exists in the database.
	`protected void`	`unsubscribeForService(String service)` Unsubscribe from all agents providing a specified service.
	`protected void`	`unsubscribeForService(Enum<?> service)` Unsubscribe from all agents providing a specified service.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Agent`	send, receive, receive, receive, receive, receive, receive, receive, receive, setLogLevel, getPlatform, request, request, getStore, subscribe, deregister, deregister, getContainer, println, run, add, toString, register, register, clone, currentTimeMillis, nanoTime, getName, stop, getState, getAgentID, prepareRequest, platformSend, setQueueSize, unsubscribe, agentForService, agentForService, agentsForService, agentsForService, topic, topic, topic, topic, topic, topic, agent, wake, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll

- Field Detail
  - protected String DBPASSWORD
    
    Password for the database connection.
  - protected String DBURL
    
    Database connection URL. This may be modified by an agent at construction. The database connection is established just before setup, using this URL.
  - protected String DBUSERNAME
    
    Username for the database connection.
  - public static String DEFAULT_DBPASSWORD
  - public static String DEFAULT_DBURL
    
    Default database URL for all DBAgents. This may be setup in the initrc or equivalent as a global default. If an agent does not set DBURL at construction, this URL is used for a database connection just before setup.
  - public static String DEFAULT_DBUSERNAME
  - protected ExecutorService executor
    
    Executor to process blocking operations. This may be created by an agent during setup, or is automatically defaulted to use SingleThreadExecutor at first use. The executor should not be directly used, but instead via the async() method.
- Method Detail
  - <T> protected Future<T> async(Callable<T> task)
    
    Runs a long-running task asynchronously in a non-agent thread.
    Parameters:
    task - task to run
    Returns:
    a Future representing pending completion of the task
  - protected Future<?> async(Runnable task)
    
    Runs a long-running task asynchronously in a non-agent thread.
    Parameters:
    task - task to run
    Returns:
    a Future representing pending completion of the task
  - protected Connection connect()
    
    Gets a connection to the database.
  - protected String getBuildInfo()
    
    Gets the build string for a given class. The build information is extracted from the jar is available.
    Returns:
    build information string if available, null otherwise.
  - @Override protected void init()
    
    Initialize the C3 database agent and its behaviors.
  - protected void processMessage(Message msg)
    
    An agent wishing to process all messages other than requests and queries may override this method to handle incoming messages. This method should not block for any substantial amount of time. If any operation requires waiting, it may be spawned off to a separate thread using the executor service, or triggered on the agent's thread later using a behavior.
    Parameters:
    msg - incoming message.
  - protected boolean processRequest(Message msg)
    
    An agent supporting requests should override this method to handle incoming requests. This method should not block for any substantial amount of time. If any operation requires waiting, it may be spawned off to a separate thread using the executor service, or triggered on the agent's thread later using a behavior.
    Parameters:
    msg - incoming request.
    Returns:
    true if the requst is/will be processed, false otherwise.
  - protected void setup()
    
    Called by DBAgent when the agent is being initialized.
  - @Override protected void shutdown()
  - protected void startup()
    
    Called by DBAgent after all agents are fully initialized.
  - protected void subscribeForService(String service)
    
    Subscribe to all agents providing a specified service.
    Parameters:
    service - name of the service
  - protected void subscribeForService(Enum<?> service)
    
    Subscribe to all agents providing a specified service.
    Parameters:
    service - name of the service
  - protected boolean tableExists(String table)
    
    Checks if a table exists in the database.
    Parameters:
    table - name of the table
    Returns:
    true if it exists, false otherwise
  - protected void unsubscribeForService(String service)
    
    Unsubscribe from all agents providing a specified service.
    Parameters:
    service - name of the service
  - protected void unsubscribeForService(Enum<?> service)
    
    Unsubscribe from all agents providing a specified service.
    Parameters:
    service - name of the service

Summary:
Field
Method

| Detail:
Field
Method

[Java] Class DBAgent

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected String DBPASSWORD

protected String DBURL

protected String DBUSERNAME

public static String DEFAULT_DBPASSWORD

public static String DEFAULT_DBURL

public static String DEFAULT_DBUSERNAME

protected ExecutorService executor

Method Detail

<T> protected Future<T> async(Callable<T> task)

protected Future<?> async(Runnable task)

protected Connection connect()

protected String getBuildInfo()

@Override protected void init()

protected void processMessage(Message msg)

protected boolean processRequest(Message msg)

protected void setup()

@Override protected void shutdown()

protected void startup()

protected void subscribeForService(String service)

protected void subscribeForService(Enum<?> service)

protected boolean tableExists(String table)

protected void unsubscribeForService(String service)

protected void unsubscribeForService(Enum<?> service)