kaos.core.service.directory
Interface KAoSEntityDescription

All Known Subinterfaces:

KAoSAgentContainerDescription, KAoSAgentDescription, KAoSGuardDescription

All Known Implementing Classes:

DefaultKAoSAgentContainerDescription, DefaultKAoSAgentDescription, DefaultKAoSEntityDescription, DefaultKAoSGuardDescription

public interface KAoSEntityDescription

Defines the operations to access information about a KAoS entity. The information includes the host name/address, the domain names the entity is member of, the entity type (GUARD or AGENT), and the ID of the execution environmnet the entity is running in.

Field Summary

static java.lang.String	CONCEPT_MAPPING_NAME
static java.lang.String	ENTITY_DAML_S_TYPES
static java.lang.String	ENTITY_DOMAIN_NAMES
static java.lang.String	ENTITY_HOST_ADDRESS
static java.lang.String	ENTITY_HOST_NAME
static java.lang.String	ENTITY_ONTOLOGICAL_TYPE_NAMES
static java.lang.String	ENTITY_ONTOLOGICAL_TYPES
static java.lang.String	ENTITY_TYPE
static java.lang.String	EXECUTION_ENVIRONMENT
static java.lang.String	FULL_SEARCH
static java.lang.String	IS_ENTITY_POLICY_SUBJECT
static java.lang.String	IS_ENTITY_RUNNING
static java.lang.String	SEARCH_PARAMS

Method Summary

void	addDomainName(java.lang.String name) Add a domain name to the collection of domain names held by the KAoSEntityDescription.
void	addEntityDAMLSType(java.lang.String type, java.lang.String damlSInterface) Add DAML-S type to the collection of DAML-S types held by the KAoSEntityDescription.
void	addEntityOntologicalType(java.lang.String type, java.lang.String damlDesc) Add an ontological type to the collection of types held by the KAoSEntityDescription.
void	clearLocators() Clear the locators property contained by this KAoSEntityDescription.
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() Obtain the names of the domains a given entity is member of.
java.util.Enumeration	getEntityDAMLSTypeNames() Obtain the collection of just names of DAML-S types of KAoS entity described by this KAoSEntityDescription.
java.util.Map	getEntityDAMLSTypes() Obtain the collection of DAML-S types of KAoS entity described by this KAoSEntityDescription.
java.lang.String	getEntityNameAsString() Obtain the entity's name as String.
java.lang.String	getEntityOntologicalType() Obtain the ontological type of KAoS entity described by this KAoSEntityDescription.
java.util.Enumeration	getEntityOntologicalTypeNames() Obtain the collection of just names of ontological types of KAoS entity described by this KAoSEntityDescription.
java.util.Map	getEntityOntologicalTypes() Obtain the collection of ontological types of KAoS entity described by this KAoSEntityDescription.
java.lang.String	getEntityType() Obtain the type of entity that is described by this KAoSEntityDescription.
java.lang.String	getExecutionEnv() Obtain the id of the execution environment of this entity.
java.lang.String	getHostAddress() Obtain the host address property contained by this the KAoSEntityDescription.
java.lang.String	getHostName() Obtain the host name property contained by this KAoSEntityDescription.
boolean	isEntityPolicySubject() Obtain the info whether the entity is a subject of policies.
boolean	isEntityRunning() Obtain the info whether the entity is running or not (virtual).
void	modifyProperties(java.util.List propertiesToModify) Modify key-value pairs of this KAoSEntityDescription as specified by the Property objects containted in the given list.
boolean	removeDomainName(java.lang.String name) Remove a domain name from the collection of domain names held by the KAoSEntityDescription.
boolean	removeEntityDAMLSType(java.lang.String type) Remove a DAML-S type from the collection of DAML-S types held by the KAoSEntityDescription.
boolean	removeEntityOntologicalType(java.lang.String type) Remove an ontological type from the collection of types held by the KAoSEntityDescription.
java.lang.String	removeExecutionEnv() Remove the id of the execution environment property contained by this KAoSAgentDescription.
java.lang.String	removeHostAddress() Remove the address of the host.
java.lang.String	removeHostName() Remove the host name property contained by this KAoSEntityDescription.
void	setConceptMappingName(java.lang.String mappingName) Set the name of the concept mapping between the entity system's ontological concepts and KAoS ontology.
void	setDomainNames(java.util.List domainNames) Set names of the domains a given entity is member of.
void	setEntityDAMLSTypes(java.util.Map types) Set the DAML-S types of KAoS entity.
void	setEntityNameAsString(java.lang.String name) Set the name of the entity as String, which is the String representation of AgentName.
void	setEntityOntologicalType(java.lang.String type) Set the ontological type of KAoS entity.
void	setEntityOntologicalTypes(java.util.Map types) Set the ontological types of KAoS entity.
void	setEntityType(java.lang.String name) Set the type of KAoS entity.
void	setExecutionEnv(java.lang.String executionEnv) Set the execution environment the entity is running in.
void	setHostAddress(java.lang.String address) Set the address of the host the entity is running on.
void	setHostName(java.lang.String name) Set the name of the host the entity is running on.
void	setIsEntityPolicySubject(boolean isPolicySubject) Set the indicator of whether the entity will/will not be a policy subject.
void	setIsEntityRunning(boolean isEntityRunning) Set the indicator of whether the entity is running.

Field Detail

CONCEPT_MAPPING_NAME

static final java.lang.String CONCEPT_MAPPING_NAME

See Also:

Constant Field Values

ENTITY_DOMAIN_NAMES

static final java.lang.String ENTITY_DOMAIN_NAMES

See Also:

Constant Field Values

ENTITY_TYPE

static final java.lang.String ENTITY_TYPE

See Also:

Constant Field Values

ENTITY_ONTOLOGICAL_TYPES

static final java.lang.String ENTITY_ONTOLOGICAL_TYPES

See Also:

Constant Field Values

ENTITY_ONTOLOGICAL_TYPE_NAMES

static final java.lang.String ENTITY_ONTOLOGICAL_TYPE_NAMES

See Also:

Constant Field Values

ENTITY_DAML_S_TYPES

static final java.lang.String ENTITY_DAML_S_TYPES

See Also:

Constant Field Values

EXECUTION_ENVIRONMENT

static final java.lang.String EXECUTION_ENVIRONMENT

See Also:

Constant Field Values

ENTITY_HOST_NAME

static final java.lang.String ENTITY_HOST_NAME

See Also:

Constant Field Values

ENTITY_HOST_ADDRESS

static final java.lang.String ENTITY_HOST_ADDRESS

See Also:

Constant Field Values

IS_ENTITY_POLICY_SUBJECT

static final java.lang.String IS_ENTITY_POLICY_SUBJECT

See Also:

Constant Field Values

IS_ENTITY_RUNNING

static final java.lang.String IS_ENTITY_RUNNING

See Also:

Constant Field Values

FULL_SEARCH

static final java.lang.String FULL_SEARCH

See Also:

Constant Field Values

SEARCH_PARAMS

static final java.lang.String SEARCH_PARAMS

See Also:

Constant Field Values

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.

setConceptMappingName

void setConceptMappingName(java.lang.String mappingName)

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

Parameters:

mappingName - The name of the mapping to be used to translate ontological names from the entity system to KAoS ontologies.

getDomainNames

java.util.List getDomainNames()

Obtain the names of the domains a given entity is member of.

Returns:

List of domain names contained by this KAoSEntityDescription.

setDomainNames

void setDomainNames(java.util.List domainNames)

Set names of the domains a given entity is member of.

Parameters:

domainNames - The domainNames containing a List of all names of domains a given entity is registered in.

addDomainName

void addDomainName(java.lang.String name)

Add a domain name to the collection of domain names held by the KAoSEntityDescription.

Parameters:

name - The name of a domain to be added to the collection of domain names.

removeDomainName

boolean removeDomainName(java.lang.String name)

Remove a domain name from the collection of domain names held by the KAoSEntityDescription.

Parameters:

name - The name of a domain to be removed from the collection of domain names.

Returns:

true if the collection of domain names contained the specified name; otherwise return false.

setExecutionEnv

void setExecutionEnv(java.lang.String executionEnv)

Set the execution environment the entity is running in.

Parameters:

executionEnv - The execution environment in which the entity is running.

getExecutionEnv

java.lang.String getExecutionEnv()

Obtain the id of the execution environment of this entity.

Returns:

String contaoining the id of the execution environment the entity is running in.

removeExecutionEnv

java.lang.String removeExecutionEnv()

Remove the id of the execution environment property contained by this KAoSAgentDescription.

Returns:

String containing the removed id of the execution environment.

setHostAddress

void setHostAddress(java.lang.String address)

Set the address of the host the entity is running on.

Parameters:

address - The address of the host where the enitity is running.

getHostAddress

java.lang.String getHostAddress()

Obtain the host address property contained by this the KAoSEntityDescription.

Returns:

String representing the address of the host the entity is running on.

removeHostAddress

java.lang.String removeHostAddress()

Remove the address of the host.

Returns:

String containing the removed host address.

setHostName

void setHostName(java.lang.String name)

Set the name of the host the entity is running on.

Parameters:

name - The name of the host where the entity is running.

getHostName

java.lang.String getHostName()

Obtain the host name property contained by this KAoSEntityDescription.

Returns:

String representing the name of the host the entity is running on.

removeHostName

java.lang.String removeHostName()

Remove the host name property contained by this KAoSEntityDescription.

Returns:

String containing the removed name of the host.

getEntityNameAsString

java.lang.String getEntityNameAsString()

Obtain the entity's name as String.

Returns:

String representing the entity's name.

setEntityNameAsString

void setEntityNameAsString(java.lang.String name)

Set the name of the entity as String, which is the String representation of AgentName.

Parameters:

name - The name of entity represented as String.

setEntityType

void setEntityType(java.lang.String name)

Set the type of KAoS entity. The type can be either a GUARD or an AGENT.

Parameters:

name - The type of the entity.

getEntityType

java.lang.String getEntityType()

Obtain the type of entity that is described by this KAoSEntityDescription.

Returns:

String describing either GUARD or AGENT type.

setEntityOntologicalType

void setEntityOntologicalType(java.lang.String type)

Set the ontological type of KAoS entity. Presently, the types are defined by constants in kaos.ontology.jena.ActorConcepts.

Parameters:

type - The ontological type of the entity this description is associated with.

getEntityOntologicalType

java.lang.String getEntityOntologicalType()

Obtain the ontological type of KAoS entity described by this KAoSEntityDescription. Presently, the types are defined by constants in kaos.ontology.jena.ActorConcepts.

Returns:

String describing one ontological type of entity, or null, if there isn't one set.

addEntityOntologicalType

void addEntityOntologicalType(java.lang.String type,
                              java.lang.String damlDesc)

Add an ontological type to the collection of types held by the KAoSEntityDescription. Presently, the types are defined by constants in kaos.ontology.jena.ActorConcepts.

Parameters:

type - String containing the name of ontological type of the entity described by this description.

damlDesc - String containing DAML description of the corresponding ontological type.

removeEntityOntologicalType

boolean removeEntityOntologicalType(java.lang.String type)

Remove an ontological type from the collection of types held by the KAoSEntityDescription.

Parameters:

type - The name of the ontological type to be removed from the collection of ontological types.

Returns:

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

setEntityOntologicalTypes

void setEntityOntologicalTypes(java.util.Map types)

Set the ontological types of KAoS entity. NOTE: The new types replace existing ones, if there were any set! Presently, the types are defined by constants in kaos.ontology.jena.ActorConcepts.

Parameters:

types - Map containing type name -> DAML description mapping of ontological types of the entity this description is associated with.

getEntityOntologicalTypes

java.util.Map getEntityOntologicalTypes()

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

Returns:

Map containing mappings of ontological type names -> DAML 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 KAoSEntityDescription. 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 KAoSEntityDescription.

addEntityDAMLSType

void addEntityDAMLSType(java.lang.String type,
                        java.lang.String damlSInterface)

Add DAML-S type to the collection of DAML-S types held by the KAoSEntityDescription.

Parameters:

type - String containing the name of DAML-S type of the entity described by this description.

damlDesc - String containing DAML-S interface as String of the corresponding DAML-S type.

removeEntityDAMLSType

boolean removeEntityDAMLSType(java.lang.String type)

Remove a DAML-S type from the collection of DAML-S types held by the KAoSEntityDescription.

Parameters:

type - The name of the DAML-S type to be removed from the collection of DAML-S types.

Returns:

true if the collection of DAML-S types contained the specified type; otherwise return false.

setEntityDAMLSTypes

void setEntityDAMLSTypes(java.util.Map types)

Set the DAML-S types of KAoS entity. NOTE: The new DAML-S types replace existing ones, if there were any set!

Parameters:

types - Map containing DAML-S name -> DAML-S interface mapping of the entity this description is associated with.

getEntityDAMLSTypes

java.util.Map getEntityDAMLSTypes()

Obtain the collection of DAML-S types of KAoS entity described by this KAoSEntityDescription.

Returns:

Map containing mappings of DAML-S names -> DAML-S interface String of the types or null, if ontological types have not been set.

getEntityDAMLSTypeNames

java.util.Enumeration getEntityDAMLSTypeNames()

Obtain the collection of just names of DAML-S types of KAoS entity described by this KAoSEntityDescription.

Returns:

Enumeration containing names of DAML-S types or null, if there no types specified in the KAoSEntityDescription.

isEntityPolicySubject

boolean isEntityPolicySubject()

Obtain the info whether the entity is a subject of policies.

Returns:

boolean indicating whether the entity will/will not be a subject of policies.

setIsEntityPolicySubject

void setIsEntityPolicySubject(boolean isPolicySubject)

Set the indicator of whether the entity will/will not be a policy subject.

Parameters:

isPolicySubject - The boolean indicating whether the entity will/will not be governed by policies.

isEntityRunning

boolean isEntityRunning()

Obtain the info whether the entity is running or not (virtual).

Returns:

boolean indicating whether the entity is running.

setIsEntityRunning

void setIsEntityRunning(boolean isEntityRunning)

Set the indicator of whether the entity is running. The default is true, the entity is running.

Parameters:

isEntityRunning - The boolean indicating whether the entity is running.

modifyProperties

void modifyProperties(java.util.List propertiesToModify)
                      throws ModificationException

Modify key-value pairs of this KAoSEntityDescription as specified by the Property objects containted in the given list.

Parameters:

propertiesToModify - List containing Property objects specifying the modifcations.

Throws:

ModificationException - containing Properties, whose modifications failed. Each failed property includes the description of the failure.

clearLocators

void clearLocators()

Clear the locators property contained by this KAoSEntityDescription.