|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DirectoryRegistration
Defines the operations to register and deregister entities and entity hosting environments in the KAoS Directory Service and operations to modify the registration information.
Method Summary | |
---|---|
KAoSAgentDescription |
createKAoSAgentDescription(java.lang.String guid,
java.lang.String nickname,
java.util.Vector domainNames,
java.lang.String transportName,
JasBean agentInitInfo)
Create an instance of the KAoSAgentDescription using the given parameters. |
void |
deregisterEntity(AgentDescription entityDescription)
Deregister the entity described by the given AgentDescription from the KAoS Directory Service. |
void |
deregisterEntityHostingEnv(EntityHostEnvDescription hostEnvDescription)
Deregister the entity hosting environment described by the given EntityHostEnvDescription from the KAoS Directory Service. |
void |
modifyEntityProperties(java.lang.String entityGUID,
java.util.List properties)
Modify properties of the entity identified by the given entityGUID. |
void |
modifyEntitySpatialProperties(java.lang.String entityGUID,
Location3D objectLocation,
Orientation3D objectOrientation,
Block3D objectOccupiedSpace)
Modify given spatial properties of the entity identified by the given entityGUID in the KAoS Directory Service *AND* the SpatialReasoner. |
void |
modifyObjectSpatialProperties(java.lang.String objectID,
Location3D objectLocation,
Orientation3D objectOrientation,
Block3D objectOccupiedSpace)
Modify spatial properties of the object identified by the given objectID in the SpatialReasoner. |
void |
registerDomain(java.lang.String domainName)
Register domain with the given name in the KAoS Directory Service. |
void |
registerEntity(AgentDescription entityDescription,
boolean guarded,
boolean replace)
Register the entity described by the given AgentDescription in the KAoS Directory Service. |
void |
registerEntityHostingEnv(EntityHostEnvDescription eheDescription,
boolean guarded,
boolean replace)
Register the entity hosting environment described by the given EntityHostEnvDescription in the KAoS Directory Service. |
void |
registerEntityWithProperties(AgentDescription entityDescription,
java.util.List properties,
boolean guarded,
boolean replace)
Register the entity described by the given AgentDescription and the List of Properties in the KAoS Directory Service. |
void |
registerEntityWithSpatialProperties(AgentDescription entityDescription,
Location3D objectLocation,
Orientation3D objectOrientation,
Block3D objectOccupiedSpace,
boolean guarded,
boolean replace)
Register the entity described by the given AgentDescription and the spatial properties in the KAoS Directory Service *AND* the SpatialReasoner. |
void |
registerObjectWithSpatialProperties(java.lang.String objectID,
java.util.Set objectOntologyType,
Location3D objectLocation,
Orientation3D objectOrientation,
Block3D objectOccupiedSpace)
Register object identified by the given objectID and its spatial properties in the SpatialReasoner. |
Method Detail |
---|
void registerDomain(java.lang.String domainName) throws DirectoryFailure, AlreadyRegisteredException
domainName
- String containing the name of domain to register.
DirectoryFailure
- if the connection to the DS cannot be established.
AlreadyRegisteredException
- if the registering domain has been already registered in the DSvoid registerEntity(AgentDescription entityDescription, boolean guarded, boolean replace) throws DirectoryFailure, AlreadyRegisteredException, GuardInstantiationException
entityDescription
- AgentDescription is the JAS AgentDescription, whose subclasses describe the various
types of entities to be registered in KAoS: agents, guards, domains, containers.
Those entities are subjects to policies or potential subjects to policies,
or the entities are using KAoS for messaging.guarded
- boolean indicating the guarded/unguarded status for agents and containers.
If the entity is to be guarded, the implementation of this method will instantiate a guard,
or check if a guard already exists and proceed with the registration via the guard.replace
- boolean indicating whether to replace existing AgentDescription.
DirectoryFailure
- if the connection to the DS cannot be established.
AlreadyRegisteredException
- if the registering entity has been already registered in the DS
(if the replace = false and there is already registration for the specified AgentDescription).
GuardInstantiationException
void registerEntityWithProperties(AgentDescription entityDescription, java.util.List properties, boolean guarded, boolean replace) throws DirectoryFailure, AlreadyRegisteredException, GuardInstantiationException
entityDescription
- AgentDescription is the JAS AgentDescription, whose subclasses describe the various
types of entities to be registered in KAoS: agents, guards, domains, containers.
Those entities are subjects to policies or potential subjects to policies,
or the entities are using KAoS for messaging.properties
- List of Property objects further describing the registering entity.guarded
- boolean indicating the guarded/unguarded status for agents and containers.
If the entity is to be guarded, the implementation of this method will instantiate a guard,
or check if a guard already exists and proceed with the registration via the guard.replace
- boolean indicating whether to replace existing AgentDescription.
DirectoryFailure
- if the connection to the DS cannot be established.
AlreadyRegisteredException
- if the registering entity has been already registered in the DS
(if the replace = false and there is already registration for the specified AgentDescription).
GuardInstantiationException
void registerEntityWithSpatialProperties(AgentDescription entityDescription, Location3D objectLocation, Orientation3D objectOrientation, Block3D objectOccupiedSpace, boolean guarded, boolean replace) throws DirectoryFailure, AlreadyRegisteredException, GuardInstantiationException
entityDescription
- AgentDescription is the JAS AgentDescription, whose subclasses describe the various
types of entities to be registered in KAoS: agents, guards, domains, containers.
Those entities are subjects to policies or potential subjects to policies,
or the entities are using KAoS for messaging.objectLocation
- Location3D containing the X,Y,Z coordinates of the registering entity.objectOrientation
- Orientation3D containing the X,Y,Z radius of the registering entity.objectOccupiedSpace
- Block3D containing corner locations determining the occupied space of the registering entity.guarded
- boolean indicating the guarded/unguarded status for agents and containers.
If the entity is to be guarded, the implementation of this method will instantiate a guard,
or check if a guard already exists and proceed with the registration via the guard.replace
- boolean indicating whether to replace existing AgentDescription.
DirectoryFailure
- if the connection to the DS cannot be established.
AlreadyRegisteredException
- if the registering entity has been already registered in the DS
(if the replace = false and there is already registration for the specified AgentDescription).
GuardInstantiationException
void registerObjectWithSpatialProperties(java.lang.String objectID, java.util.Set objectOntologyType, Location3D objectLocation, Orientation3D objectOrientation, Block3D objectOccupiedSpace) throws DirectoryFailure, AlreadyRegisteredException
objectID
- String uniquely identifying registering object in the SpatialReasoner.objectOntologyType
- Set containing Strings describing the ontological types of the registering object in the SpatialReasoner.objectLocation
- Location3D containing the X,Y,Z coordinates of the registering object.objectOrientation
- Orientation3D containing the X,Y,Z radius of the registering object.objectOccupiedSpace
- Block3D containing corner locations determining the occupied space of the registering object.
DirectoryFailure
- if the connection to the SpatialReasoner cannot be established.
AlreadyRegisteredException
- if the registering object has been already registered in the SpatialReasoner.void registerEntityHostingEnv(EntityHostEnvDescription eheDescription, boolean guarded, boolean replace) throws DirectoryFailure, AlreadyRegisteredException, GuardInstantiationException
eheDescription
- EntityHostEnvDescription describes the hosting environment for agents and guards.guarded
- boolean indicating the guarded/unguarded status for the environment.
If the hosted environemnt is to be guarded, the implementation of
this method will instantiate a guard, or check if a guard already exists
and proceed with the registration via the guard.replace
- boolean indicating whether to replace existing EntityHostEnvDescription.
DirectoryFailure
- if the connection to the DS cannot be established.
AlreadyRegisteredException
- if the registering hosting environment has been already registered in the DS
(if the replace = false and there is already registration for the specified EntityHostEnvDescription).
GuardInstantiationException
void modifyEntityProperties(java.lang.String entityGUID, java.util.List properties) throws DirectoryFailure, NotRegisteredException, ModificationException
entityGUID
- String containing the entity GUID.properties
- List of Properties to be modified. Each Property contains the name, value, value description,
modification type (add/remove/set, etc), modification result.
Refer to the Property and ModificationResult interfaces for detailed description.
DirectoryFailure
- if the connection to the DS cannot be established.
NotRegisteredException
- if the entity whose properties are to be modified
has not been registered in the DS.
ModificationException
- if one or more property update failed.void modifyEntitySpatialProperties(java.lang.String entityGUID, Location3D objectLocation, Orientation3D objectOrientation, Block3D objectOccupiedSpace) throws DirectoryFailure, NotRegisteredException, ModificationException
entityGUID
- String containing the entity GUID.objectLocation
- modified Location3D containing the X,Y,Z coordinates of the entity.objectOrientation
- modified Orientation3D containing the X,Y,Z radius of the entity.objectOccupiedSpace
- modified Block3D containing corner locations determining the occupied space of the entity.
DirectoryFailure
- if the connection to the DS cannot be established.
NotRegisteredException
- if the entity whose properties are to be modified
has not been registered in the DS.
ModificationException
- if one or more property update failed.void modifyObjectSpatialProperties(java.lang.String objectID, Location3D objectLocation, Orientation3D objectOrientation, Block3D objectOccupiedSpace) throws DirectoryFailure, NotRegisteredException
objectID
- String uniquely identifying object, whose spatial properties will be modified in the SpatialReasoner.objectLocation
- modified Location3D containing the X,Y,Z coordinates of the entity.objectOrientation
- modified Orientation3D containing the X,Y,Z radius of the entity.objectOccupiedSpace
- modified Block3D containing corner locations determining the occupied space of the entity.
DirectoryFailure
- if the connection to the SpatialReasoner cannot be established.
NotRegisteredException
- if the object, whose properties are to be modified has not been registered
in the SpatialReasoner.void deregisterEntity(AgentDescription entityDescription) throws DirectoryFailure, NotRegisteredException
entityDescription
- AgentDescription of the entity to be deregistered.
DirectoryFailure
- if the connection to the DS cannot be established.
NotRegisteredException
- if the entity to be deregistered has not been registered in the DS.void deregisterEntityHostingEnv(EntityHostEnvDescription hostEnvDescription) throws DirectoryFailure, NotRegisteredException
hostEnvDescription
- EntityHostEnvDescription of the entity hosting environment to be deregistered.
DirectoryFailure
- if the connection to the DS cannot be established.
NotRegisteredException
- if the entity to be deregistered has not been registered in the DS.KAoSAgentDescription createKAoSAgentDescription(java.lang.String guid, java.lang.String nickname, java.util.Vector domainNames, java.lang.String transportName, JasBean agentInitInfo)
guid
- String containing the globally unique identifier for the agent, or null. If null is passed, then
the Agent Naming Service will create the identifier.nickname
- String containing agent's nickname.domainNames
- Vector containing the names of the domains the agent will become a member of.transportName
- String specifying the name of the transport the agent wants to use, or null.
If null is specified, then the Locators will be empty.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |