kaos.core.service.directory
Interface KAoSAgentDescription

All Superinterfaces:

KAoSEntityDescription

All Known Implementing Classes:

DefaultKAoSAgentDescription

public interface KAoSAgentDescription
extends KAoSEntityDescription

Defines the operations to access information about a KAoS agent. The information includes the ids of Guards guarding the agent, the id of the container the agent is running in, the agent's nickname, security status, and whether the agent supports conversations.

Field Summary

static java.lang.String	AGENT_CAPABILITIES
static java.lang.String	AGENT_CONTAINER
static java.lang.String	AGENT_GUARD_IDS
static java.lang.String	AGENT_NICKNAME
static java.lang.String	AGENT_SECURITY_STATUS
static java.lang.String	AGENT_SUPPORTS_CONVERSATIONS
static java.lang.String	BasicAgentDescription_LOCATORS
static java.lang.String	BasicAgentDescription_NAME
static java.lang.String[]	HIDDEN_KEY_NAMES
static java.lang.String	IS_GOVERNABLE

Fields inherited from interface kaos.core.service.directory.KAoSEntityDescription

CONCEPT_MAPPING_NAME, ENTITY_DAML_S_TYPES, ENTITY_DOMAIN_NAMES, ENTITY_HOST_ADDRESS, ENTITY_HOST_NAME, ENTITY_ONTOLOGICAL_TYPE_NAMES, ENTITY_ONTOLOGICAL_TYPES, ENTITY_TYPE, EXECUTION_ENVIRONMENT, FULL_SEARCH, IS_ENTITY_POLICY_SUBJECT, IS_ENTITY_RUNNING, SEARCH_PARAMS

Method Summary

void	addCapability(AgentCapability capability) Add an AgentCapability to this description.
void	addGuardID(java.lang.String id) Set the id of a Guard that is guarding the agent's execution environment.
java.lang.String	getAgentContainer() Obtain the id of agent's container.
java.lang.String	getAgentNickname() Obtain the agent's nickname property contained by this KAoSAgentDescription.
java.util.List	getCapabilities() Obtain the collection of AgentCapabilities of this agent.
java.util.List	getGuardIDs() Obtain the ids of the Guards that are guarding the agent's execution environment.
java.lang.String	getSecurityStatus() Obtain the GUARDED/UNGUARDED security status of the agent.
boolean	getSupportsConversations() Obtain the property indicating whether the agent supports KAoS conversations.
boolean	removeCapability(AgentCapability capability) Remove the specified AgentCapability from the collection of this agent's capabilities.
boolean	removeGuardID(java.lang.String id) Remove an id of a Guard from the collection of Guard ids held by the KAoSAgentDescription.
void	setAgentContainer(java.lang.String container) Set the container id the agent is running in.
void	setAgentNickname(java.lang.String name) Set the agent's nickname.
void	setCapabilities(java.util.List capabilities) Set the collection of AgentCapabilities of this agent.
void	setSecurityStatus(java.lang.String status) Set agent's security status.
void	setSupportsConversations(boolean supports) Set the property telling whether the agent supports conversations.

Methods inherited from interface kaos.core.service.directory.KAoSEntityDescription

addDomainName, addEntityDAMLSType, addEntityOntologicalType, clearLocators, getConceptMappingName, getDomainNames, getEntityDAMLSTypeNames, getEntityDAMLSTypes, getEntityNameAsString, getEntityOntologicalType, getEntityOntologicalTypeNames, getEntityOntologicalTypes, getEntityType, getExecutionEnv, getHostAddress, getHostName, isEntityPolicySubject, isEntityRunning, modifyProperties, removeDomainName, removeEntityDAMLSType, removeEntityOntologicalType, removeExecutionEnv, removeHostAddress, removeHostName, setConceptMappingName, setDomainNames, setEntityDAMLSTypes, setEntityNameAsString, setEntityOntologicalType, setEntityOntologicalTypes, setEntityType, setExecutionEnv, setHostAddress, setHostName, setIsEntityPolicySubject, setIsEntityRunning

Field Detail

IS_GOVERNABLE

static final java.lang.String IS_GOVERNABLE

See Also:

Constant Field Values

AGENT_CONTAINER

static final java.lang.String AGENT_CONTAINER

See Also:

Constant Field Values

AGENT_NICKNAME

static final java.lang.String AGENT_NICKNAME

See Also:

Constant Field Values

AGENT_GUARD_IDS

static final java.lang.String AGENT_GUARD_IDS

See Also:

Constant Field Values

AGENT_SECURITY_STATUS

static final java.lang.String AGENT_SECURITY_STATUS

See Also:

Constant Field Values

AGENT_SUPPORTS_CONVERSATIONS

static final java.lang.String AGENT_SUPPORTS_CONVERSATIONS

See Also:

Constant Field Values

AGENT_CAPABILITIES

static final java.lang.String AGENT_CAPABILITIES

See Also:

Constant Field Values

BasicAgentDescription_NAME

static final java.lang.String BasicAgentDescription_NAME

See Also:

Constant Field Values

BasicAgentDescription_LOCATORS

static final java.lang.String BasicAgentDescription_LOCATORS

See Also:

Constant Field Values

HIDDEN_KEY_NAMES

static final java.lang.String[] HIDDEN_KEY_NAMES

Method Detail

setAgentContainer

void setAgentContainer(java.lang.String container)

Set the container id the agent is running in.

Parameters:

container - The id of the container in which the agent is running.

getAgentContainer

java.lang.String getAgentContainer()

Obtain the id of agent's container.

Returns:

String representing container the agent is running in.

setAgentNickname

void setAgentNickname(java.lang.String name)

Set the agent's nickname.

Parameters:

name - The nickname the agent is using in addition to its name (GUID).

getAgentNickname

java.lang.String getAgentNickname()

Obtain the agent's nickname property contained by this KAoSAgentDescription.

Returns:

String representing the agent's nickname.

addGuardID

void addGuardID(java.lang.String id)

Set the id of a Guard that is guarding the agent's execution environment. (Agent may be guarded by more than one Guard).

Parameters:

id - The id of one of the agent's Guard.

getGuardIDs

java.util.List getGuardIDs()

Obtain the ids of the Guards that are guarding the agent's execution environment.

Returns:

List containing the ids of Guards guarding the agent.

removeGuardID

boolean removeGuardID(java.lang.String id)

Remove an id of a Guard from the collection of Guard ids held by the KAoSAgentDescription.

Parameters:

name - The id of a Guard to be removed from the collection of Guard ids.

Returns:

true if the collection of Guard ids contained the specified id; otherwise return false.

setSupportsConversations

void setSupportsConversations(boolean supports)

Set the property telling whether the agent supports conversations.

Parameters:

supports - The supports argument indicates whether the agent supports KAoS conversations.

getSupportsConversations

boolean getSupportsConversations()

Obtain the property indicating whether the agent supports KAoS conversations.

Returns:

true if the agents supports conversations; otherwise return false.

setSecurityStatus

void setSecurityStatus(java.lang.String status)

Set agent's security status.

Parameters:

status - The GUARDED/UNGUARDED security status of the agent.

getSecurityStatus

java.lang.String getSecurityStatus()

Obtain the GUARDED/UNGUARDED security status of the agent.

Returns:

String containing the agent's security status.

addCapability

void addCapability(AgentCapability capability)

Add an AgentCapability to this description.

Parameters:

capability - AgentCapability describing individual capability of this agent.

removeCapability

boolean removeCapability(AgentCapability capability)

Remove the specified AgentCapability from the collection of this agent's capabilities.

Parameters:

capability - The AgentCapability to be added to the collection of this agent's capabilities.

Returns:

true if the collection of ontological types contained the specified type; otherwise return false.

setCapabilities

void setCapabilities(java.util.List capabilities)

Set the collection of AgentCapabilities of this agent. This will replace the existing List of capabilities.

Parameters:

capabilities - List containing the AgentCapabilities of this agent.

getCapabilities

java.util.List getCapabilities()

Obtain the collection of AgentCapabilities of this agent.

Returns:

List of AgentCapability describing the capabilities of the agent.