jade.core
Class Profile

java.lang.Object
  |
  +--jade.core.Profile

Direct Known Subclasses:

ProfileImpl

public abstract class Profile

extends java.lang.Object

This class allows retrieving configuration-dependent classes.

Version:

1.0, 22/11/00

Author:

Federico Bergenti, Giovanni Caire - TILAB

Field Summary

static java.lang.String	ACLCODECS This constant is the key of the property whose value contains the list of ACLCODECSs that have to be launched at bootstrap time.
static java.lang.String	AGENTS This constant is the name of the property whose value contains the list of agents that have to be launched at bootstrap time
static java.lang.String	CONTAINER_NAME This constant is the key of the property whose value contains the desired name of the container.
static java.lang.String	FILE_DIR This constant is the key of the property whose value contains the name of the directory where all the files generated by JADE should be put.
static java.lang.String	IMTP This constant is the key of the property whose value identifies the IMTP Manager to be created by ProfileImpl
static java.lang.String	LOCAL_HOST This constant is the name of the property whise value contains the host name the container must bind on.
static java.lang.String	LOCAL_PORT This constant is the name of the TCP port the container node must listen to for incoming IMTP messages.
static java.lang.String	LOCAL_SERVICE_MANAGER This constant is the name of the property whose Boolean value tells whether a local Service Manager is exported by this container (only when using JADE support for fault-tolerant platform configurations).
static java.lang.String	MAIN This constant is the name of the property whose value contains a boolean indicating if this is the Main Container or a peripheral container.
static java.lang.String	MAIN_HOST This constant is the name of the property whose value is the name (or the IP address) of the network host where the JADE Main Container is running.
static java.lang.String	MAIN_PORT This constant is the name of the property whose value contains an integer representing the port number where the Main Container is listening for container registrations.
static java.lang.String	MAIN_PROTO This constant is the name of the property whose value is a String indicating the protocol to use to connect to the Main Container.
static java.lang.String	MTPS This constant is the key of the property whose value contains the list of MTPs that have to be launched at bootstrap time.
static java.lang.String	PERSISTENT_DELIVERY_BASEDIR This constant is the name of the property whose value contains the root of the directory tree that is used to persist undelivered ACL messages (only when using JADE Persistent-Delivery kernel service with the file storage method).
static java.lang.String	PERSISTENT_DELIVERY_FILTER This constant is the name of the property whose value contains the name of the application-specific class that will be installed on the local container as a filter for undelivered ACL messages(only when using JADE Persistent-Delivery kernel service).
static java.lang.String	PERSISTENT_DELIVERY_SENDFAILUREPERIOD This constant is the name of the property whose value contains an integer representing how often (in milliseconds) JADE will try to send again previously undelivered ACL messages which have been buffered (only when using JADE Persistent-Delivery kernel service).
static java.lang.String	PERSISTENT_DELIVERY_STORAGEMETHOD This constant is the name of the property whose value contains the storage method used to persist undelivered ACL messages (only when using JADE Persistent-Delivery kernel service).
static java.lang.String	PLATFORM_ID This constant is the name of the property whose value contains the unique platform ID of a JADE platform.
static java.lang.String	REMOTE_SERVICE_MANAGER_ADDRESSES This constant is the name of the property whose value contains the list of addresses through which the platform Service Manager can be reached.
static java.lang.String	SERVICES This constants is the name of the property whose value contains the list of kernel-level services that have to be launched at bootstrap time

Constructor Summary

Profile()

Method Summary

abstract boolean	getParameter(java.lang.String key, boolean aDefault) Retrieve a boolean value for a configuration property.
abstract java.lang.String	getParameter(java.lang.String key, java.lang.String aDefault) Retrieve a String value from the configuration properties.
abstract List	getSpecifiers(java.lang.String key) Retrieve a list of Specifiers from the configuration properties.
abstract void	setParameter(java.lang.String key, java.lang.String value) Assign the given value to the given property name.
abstract void	setSpecifiers(java.lang.String key, List value) Assign the given value to the given property name.

Methods inherited from class java.lang.Object

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

Field Detail

MAIN

public static final java.lang.String MAIN

This constant is the name of the property whose value contains a boolean indicating if this is the Main Container or a peripheral container.

See Also:

Constant Field Values

MAIN_PROTO

public static final java.lang.String MAIN_PROTO

This constant is the name of the property whose value is a String indicating the protocol to use to connect to the Main Container.

See Also:

Constant Field Values

MAIN_HOST

public static final java.lang.String MAIN_HOST

This constant is the name of the property whose value is the name (or the IP address) of the network host where the JADE Main Container is running.

See Also:

Constant Field Values

MAIN_PORT

public static final java.lang.String MAIN_PORT

This constant is the name of the property whose value contains an integer representing the port number where the Main Container is listening for container registrations.

See Also:

Constant Field Values

LOCAL_HOST

public static final java.lang.String LOCAL_HOST

This constant is the name of the property whise value contains the host name the container must bind on. The host name must refer to the local machine, and is generally needed only when multiple network interfaces are present or a non-default name is desired.

See Also:

Constant Field Values

LOCAL_PORT

public static final java.lang.String LOCAL_PORT

This constant is the name of the TCP port the container node must listen to for incoming IMTP messages.

See Also:

Constant Field Values

LOCAL_SERVICE_MANAGER

public static final java.lang.String LOCAL_SERVICE_MANAGER

This constant is the name of the property whose Boolean value tells whether a local Service Manager is exported by this container (only when using JADE support for fault-tolerant platform configurations).

See Also:

Constant Field Values

PERSISTENT_DELIVERY_FILTER

public static final java.lang.String PERSISTENT_DELIVERY_FILTER

This constant is the name of the property whose value contains the name of the application-specific class that will be installed on the local container as a filter for undelivered ACL messages(only when using JADE Persistent-Delivery kernel service).

See Also:

Constant Field Values

PERSISTENT_DELIVERY_SENDFAILUREPERIOD

public static final java.lang.String PERSISTENT_DELIVERY_SENDFAILUREPERIOD

This constant is the name of the property whose value contains an integer representing how often (in milliseconds) JADE will try to send again previously undelivered ACL messages which have been buffered (only when using JADE Persistent-Delivery kernel service).

See Also:

Constant Field Values

PERSISTENT_DELIVERY_STORAGEMETHOD

public static final java.lang.String PERSISTENT_DELIVERY_STORAGEMETHOD

This constant is the name of the property whose value contains the storage method used to persist undelivered ACL messages (only when using JADE Persistent-Delivery kernel service). The supported values for this profile parameter are:

• file - A directory tree on the local filesystem is used.

If this property is not specified when starting the Persistent-Delivery kernel service, undelivered ACL messages ae kept in memory and not persisted at all.

See Also:

Constant Field Values

PERSISTENT_DELIVERY_BASEDIR

public static final java.lang.String PERSISTENT_DELIVERY_BASEDIR

This constant is the name of the property whose value contains the root of the directory tree that is used to persist undelivered ACL messages (only when using JADE Persistent-Delivery kernel service with the file storage method).

See Also:

Constant Field Values

PLATFORM_ID

public static final java.lang.String PLATFORM_ID

This constant is the name of the property whose value contains the unique platform ID of a JADE platform. Agent GUIDs in JADE are made by a platform-unique nickname, the '@' character and the platform ID.

See Also:

Constant Field Values

AGENTS

public static final java.lang.String AGENTS

This constant is the name of the property whose value contains the list of agents that have to be launched at bootstrap time

See Also:

Constant Field Values

SERVICES

public static final java.lang.String SERVICES

This constants is the name of the property whose value contains the list of kernel-level services that have to be launched at bootstrap time

See Also:

Constant Field Values

REMOTE_SERVICE_MANAGER_ADDRESSES

public static final java.lang.String REMOTE_SERVICE_MANAGER_ADDRESSES

This constant is the name of the property whose value contains the list of addresses through which the platform Service Manager can be reached.

See Also:

Constant Field Values

MTPS

public static final java.lang.String MTPS

This constant is the key of the property whose value contains the list of MTPs that have to be launched at bootstrap time. This list must be retrieved via the getSpecifiers(MTPS) method.

See Also:

Constant Field Values

IMTP

public static final java.lang.String IMTP

This constant is the key of the property whose value identifies the IMTP Manager to be created by ProfileImpl

See Also:

Constant Field Values

CONTAINER_NAME

public static final java.lang.String CONTAINER_NAME

This constant is the key of the property whose value contains the desired name of the container. If this container name exists already, then a default name is assigned by the platform. The name of the main-container is always assigned by the platform and cannot be changed.

See Also:

Constant Field Values

ACLCODECS

public static final java.lang.String ACLCODECS

This constant is the key of the property whose value contains the list of ACLCODECSs that have to be launched at bootstrap time. This list must be retrieved via the getSpecifiers(ACLCODECS) method.

See Also:

Constant Field Values

FILE_DIR

public static final java.lang.String FILE_DIR

This constant is the key of the property whose value contains the name of the directory where all the files generated by JADE should be put. The defaul value is the current directory.

See Also:

Constant Field Values

Constructor Detail

Profile

public Profile()

Method Detail

getParameter

public abstract java.lang.String getParameter(java.lang.String key,
                                              java.lang.String aDefault)

Retrieve a String value from the configuration properties. If no parameter corresponding to the specified key is found, return the provided default.

Parameters:

key - The key identifying the parameter to be retrieved among the configuration properties.

aDefault - The value to return when there is no property set for the given key.

getParameter

public abstract boolean getParameter(java.lang.String key,
                                     boolean aDefault)

Retrieve a boolean value for a configuration property. If no corresponding property is found or if its string value cannot be converted to a boolean one, a default value is returned.

Parameters:

key - The key identifying the parameter to be retrieved among the configuration properties.

aDefault - The value to return when there is no property set for the given key, or its value cannot be converted to a boolean value.

getSpecifiers

public abstract List getSpecifiers(java.lang.String key)
                            throws ProfileException

Retrieve a list of Specifiers from the configuration properties. Agents, MTPs and other items are specified among the configuration properties in this way. If no list of Specifiers corresponding to the specified key is found, an empty list is returned.

Parameters:

key - The key identifying the list of Specifires to be retrieved among the configuration properties.

ProfileException

setParameter

public abstract void setParameter(java.lang.String key,
                                  java.lang.String value)

Assign the given value to the given property name.

Parameters:

key - is the property name

value - is the property value

setSpecifiers

public abstract void setSpecifiers(java.lang.String key,
                                   List value)

Assign the given value to the given property name.

Parameters:

key - is the property name

value - is the property value