jade.core

Class ProfileImpl

java.lang.Object

jade.core.Profile

jade.core.ProfileImpl

public class ProfileImpl
extends Profile

This class allows the JADE core to retrieve configuration-dependent classes and boot parameters.

Take care of using different instances of this class when launching different containers/main-containers on the same JVM otherwise they would conflict!

Version:

1.0, 22/11/00

Author:

Federico Bergenti, Giovanni Rimassa - Universita' di Parma, Giovanni Caire - TILAB

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	bootProps

Fields inherited from class jade.core.Profile

ACCEPT_FOREIGN_AGENTS, ACLCODECS, AGENT_TAG, AGENTS, CONTAINER_NAME, DEFAULT_PORT, DETECT_MAIN, DUMP_OPTIONS, EXPORT_HOST, EXPORT_PORT, FILE_DIR, GUI, IMTP, IP_VERSION, IPV4, IPV6, LEAP_IMTP, LOCAL_HOST, LOCAL_PORT, LOCAL_SERVICE_MANAGER, LOCALHOST_CONSTANT, LOOPBACK_ADDRESS_CONSTANT, MAIN, MAIN_HOST, MAIN_PORT, MAIN_PROTO, MTPS, NO_DISPLAY, NO_MTP, PLATFORM_ID, PRIVILEDGE_LOGICAL_NAME, REMOTE_SERVICE_MANAGER_ADDRESSES, RMI_IMTP, SERVICES, STYLE_3_X, USERAUTH_KEY

Constructor Summary

Constructors

Constructor and Description
ProfileImpl() This is equivalent to ProfileImpl(true)
ProfileImpl(boolean isMain) Creates a Profile implementation with the following default configuration: if isMain is true, then the profile is configured to launch a main-container on the localhost, RMI internal Message Transport Protocol, port number 1099, HTTP MTP.
ProfileImpl(Properties aProp) Creates a Profile implementation using the given properties to configure the platform startup process.
ProfileImpl(java.lang.String fileName) Create a Profile object initialized with the settings specified in a given property file
ProfileImpl(java.lang.String host, int port, java.lang.String platformID) This constructor creates a default Profile for launching a platform (i.e. a main container!!
ProfileImpl(java.lang.String host, int port, java.lang.String platformID, boolean isMain) This constructor creates a default Profile for launching a main (or non-main) container (depending on the value of isMain)

Method Summary

Modifier and Type	Method and Description
boolean	getBooleanProperty(java.lang.String aKey, boolean aDefault) Retrieve a boolean value for a configuration property.
Properties	getBootProperties() Retrieve the configuration properties as they were passed to this Profile object, i.e. without internal initializations automatically performed by the Profile class.
java.lang.String	getParameter(java.lang.String key, java.lang.String aDefault) Retrieve a String value from the configuration properties.
Properties	getProperties() Return the underlying properties collection.
List	getSpecifiers(java.lang.String key) Retrieve a list of Specifiers from the configuration properties.
void	setParameter(java.lang.String key, java.lang.String value) Assign the given value to the given property name.
void	setSpecifiers(java.lang.String key, List value) Assign the given property value to the given property name
java.lang.String	toString() Creates a string representation of this profile.

Methods inherited from class jade.core.Profile

compareHostNames, compareTransportAddresses, compareTransportAddresses, getDefaultNetworkName, getDefaultNetworkName, isBackupMain, isLocalHost, isMain, isMasterMain

Methods inherited from class java.lang.Object

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

Field Detail

bootProps

protected Properties bootProps

Constructor Detail

ProfileImpl

public ProfileImpl(Properties aProp)

Creates a Profile implementation using the given properties to configure the platform startup process.

Parameters:

aProp - The names and values of the configuration properties to use.

ProfileImpl

public ProfileImpl(boolean isMain)

Creates a Profile implementation with the following default configuration:
if isMain is true, then the profile is configured to launch a main-container on the localhost, RMI internal Message Transport Protocol, port number 1099, HTTP MTP.
if isMain is false, then the profile is configured to launch a remote container on the localhost, connecting to the main-container on the localhost through RMI internal Message Transport Protocol, port number 1099.

ProfileImpl

public ProfileImpl()

This is equivalent to ProfileImpl(true)

ProfileImpl

public ProfileImpl(java.lang.String fileName)
            throws ProfileException

Create a Profile object initialized with the settings specified in a given property file

Throws:

ProfileException

ProfileImpl

public ProfileImpl(java.lang.String host,
                   int port,
                   java.lang.String platformID)

This constructor creates a default Profile for launching a platform (i.e. a main container!!).

Parameters:

host - is the name of the host where the main-container should be listen to. A null value means use the default (i.e. localhost)

port - is the port number where the main-container should be listen for other containers. A negative value should be used for using the default port number.

platformID - is the symbolic name of the platform, if different from default. A null value means use the default (i.e. localhost)

ProfileImpl

public ProfileImpl(java.lang.String host,
                   int port,
                   java.lang.String platformID,
                   boolean isMain)

This constructor creates a default Profile for launching a main (or non-main) container (depending on the value of isMain)

Parameters:

host - is the name of the host where the main-container should be listen to. A null value means use the default (i.e. localhost)

port - is the port number where the main-container should be listen for other containers. A negative value should be used for using the default port number.

platformID - is the symbolic name of the platform, if different from default. A null value means use the default (i.e. localhost)

isMain - if isMain is false, then the profile is configured to launch a remote container, if true a main-container

Method Detail

getProperties

public Properties getProperties()

Return the underlying properties collection.

Returns:

Properties The properties collection.

getBootProperties

public Properties getBootProperties()

Retrieve the configuration properties as they were passed to this Profile object, i.e. without internal initializations automatically performed by the Profile class.

Specified by:

getBootProperties in class Profile

setParameter

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

Assign the given value to the given property name.

Specified by:

setParameter in class Profile

Parameters:

key - is the property name

value - is the property value

setSpecifiers

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

Assign the given property value to the given property name

Specified by:

setSpecifiers in class Profile

Parameters:

key - is the property name

value - is the property value

getParameter

public 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, aDefault is returned.

Specified by:

getParameter in class Profile

Parameters:

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

aDefault - The value that is returned if the specified key is not found

getSpecifiers

public 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.

Specified by:

getSpecifiers in class Profile

Parameters:

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

Throws:

ProfileException

getBooleanProperty

public boolean getBooleanProperty(java.lang.String aKey,
                                  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.

Specified by:

getBooleanProperty in class Profile

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.

toString

public java.lang.String toString()

Creates a string representation of this profile. The returned string has the format

(profile name1=value1 name2=value2 ... )

Overrides:

toString in class java.lang.Object

Returns:

A string containing a readable representation of this profile object.