kaos.core.csi
Interface KAoSActor

All Known Implementing Classes:

BasicKAoSActorImpl, BLIKExample, BLIKNotifyEnforcerExample, HistoryAgent, KAoSActorImpl, LoginSimulationAgent

public interface KAoSActor

Defines the operations to access information about a KAoS Actor.

Method Summary

java.util.List	getCapabilities() Obtain the collection of AgentCapabilities of this KAoSActor.
java.lang.String	getConceptMappingName() Get the name of the concept mapping between the entity system's ontological concepts and KAoS ontology.
java.util.List	getDomainNames() Returns a List of String containing the names of domains the actor is registered in.
java.util.Enumeration	getEntityOntologicalTypeNames() Obtain the collection of just names of ontological types of KAoS entity described by this KAoSActorDescription.
java.util.Map	getEntityOntologicalTypes() Obtain the collection of ontological types of this KAoSActorDescription.
java.lang.String	getGUID() Obtain the actor's globally unique identifier.
java.lang.String	getName() Obtain the actor's name.
java.util.Hashtable	getProperties() Returns a Hashtable containing a mapping of actor properties.
Property	getProperty(java.lang.String name) Return the property, whose name is specified
java.lang.Object	getPropertyValue(Property property) Return the value of the given property
Transport	getTransport(java.lang.String name) Return the Transport, whose name is specified.
java.util.List	getTransports() Return the List of valid Transports.
boolean	isGuarded() Obtain guarded/unguarded status of this KAoSActor.
boolean	isRegistered() Obtain registered/unregistered status of this KAoSActor.
void	receiveMessage(java.io.Serializable messageContent, KAoSActor sender) Receive the specified message content from the given KAoSActor.
void	sendMessage(java.io.Serializable messageContent, KAoSActor receiver) Send the specified message content to the given KAoSActor.
void	setRegistered(boolean registered) Set the registered/unregistered status of this KAoSActor.

Method Detail

getConceptMappingName

java.lang.String getConceptMappingName()

Get the name of the concept mapping between the entity system's ontological concepts and KAoS ontology.

Returns:

String specifying the name of the mapping to be used to translate ontological names from the entity system to KAoS ontologies. The default name is "KAoS" indicating KAoS ontologies to be used, no translation necessary.

getDomainNames

java.util.List getDomainNames()

Returns a List of String containing the names of domains the actor is registered in. Note: When the actor first registers with the DS, this List is checked and, if not empty, the actor will be registered in the specified domains. Subsequently, if the actor wants to register in additional domains, then the actor has to lookup the desired domain and register in it via the Domain.registerAgent() method, which will update this List after successful registration.

Returns:

List of domain names contained by this KAoSActorDescription.

getGUID

java.lang.String getGUID()

Obtain the actor's globally unique identifier.

Returns:

String representing the actor's guid.

getName

java.lang.String getName()

Obtain the actor's name.

Returns:

String representing the actor's name.

getEntityOntologicalTypes

java.util.Map getEntityOntologicalTypes()

Obtain the collection of ontological types of this KAoSActorDescription. Presently, the types are defined by constants in kaos.ontology.vocabulary.ActorConcepts.

Returns:

Map containing mappings of ontological type names -> OWL descriptions of the types or null, if ontological types have not been set.

getEntityOntologicalTypeNames

java.util.Enumeration getEntityOntologicalTypeNames()

Obtain the collection of just names of ontological types of KAoS entity described by this KAoSActorDescription. Presently, the types are defined by constants in kaos.ontology.jena.ActorConcepts.

Returns:

Enumeration containing names of ontological types or null, if there no types specified in the KAoSActorDescription.

isGuarded

boolean isGuarded()

Obtain guarded/unguarded status of this KAoSActor.

Returns:

boolean indicating whether the KAoSActor is guarded.

isRegistered

boolean isRegistered()

Obtain registered/unregistered status of this KAoSActor.

Returns:

boolean indicating whether the KAoSActor has been registered in the KAoS DS.

setRegistered

void setRegistered(boolean registered)

Set the registered/unregistered status of this KAoSActor.

Parameters:

registered - boolean indicating whether the KAoSActor has been registered in the KAoS DS.

getCapabilities

java.util.List getCapabilities()

Obtain the collection of AgentCapabilities of this KAoSActor.

Returns:

List of AgentCapability describing the capabilities of the actor.

getProperties

java.util.Hashtable getProperties()

Returns a Hashtable containing a mapping of actor properties. The key is the Property name, the value is the Property. These properties are stored in the Directory Service.

Returns:

Hashtable of actor's properties.

getProperty

Property getProperty(java.lang.String name)

Return the property, whose name is specified

Parameters:

name - String containing the name of the property to be returned.

getPropertyValue

java.lang.Object getPropertyValue(Property property)

Return the value of the given property

Parameters:

property - Property, whose value is to be returned.

Returns:

Object containing the given Property value.

sendMessage

void sendMessage(java.io.Serializable messageContent,
                 KAoSActor receiver)
                 throws NotLocatableException,
                        TransportFailure

Send the specified message content to the given KAoSActor.

Parameters:

messageContent - Serializable containing the message to be sent out.

receiverdesc - KAoSAgentDescription containing the description of the receiver.

Throws:

NotLocatableException - when the receiver cannot be located.

TransportFailureto - when the transport system fails.

TransportFailure

receiveMessage

void receiveMessage(java.io.Serializable messageContent,
                    KAoSActor sender)

Receive the specified message content from the given KAoSActor.

Parameters:

messageContent - Serializable containing the received message.

senderDesc - KAoSAgentDescription containing the description of the sender.

getTransports

java.util.List getTransports()

Return the List of valid Transports.

Returns:

List containing the supported Transport.

getTransport

Transport getTransport(java.lang.String name)

Return the Transport, whose name is specified.

Parameters:

name - String containing the Transport name to be retrieved.

Returns:

Transport whose name was specified.