kaos.flexfeed.flik
Class FLIKServer

java.lang.Object
  kaos.flexfeed.flik.FLIKServer

public class FLIKServer
extends java.lang.Object

Constructor Summary

FLIKServer(int port, java.lang.String transport)

Method Summary

void	addPolicyUpdateListener(PolicyUpdateListener listener) Adds a listener which will be notified when policies have been updated
void	deregisterAgent(java.lang.String agentName)
void	deregisterEnvironment(java.lang.String envUUID)
PolicyConstraints	getPolicyConstraintsBetweenEntities(java.lang.String sourceId, java.lang.String destId, java.lang.String type) Returns the policy constraints of the given type for the given source and destination entities (that is, the source entity is the actor of the policy, and the destination entity is the target of the policy).
PolicyConstraints	getPolicyConstraintsForEntity(java.lang.String entityId, java.lang.String type) Returns the policy constraints of the given type for the given entity (that is, the given entity is the actor of the policy).
static void	main(java.lang.String[] args)
void	modifyAgentRegistration(java.lang.String agentName, java.lang.String envUUID, java.util.Vector domainList) Modifies an agent registration with an updated envUUID and/or domainList
void	modifyEnvironmentRegistration(java.lang.String envUUID, java.util.Vector domainList, java.lang.Boolean isMobile) Modifies an environment registration with an updated domainList or mobility
void	registerAgent(java.lang.String agentName, java.lang.String envUUID, java.util.Vector domainList) Register an agent in FlexFeed.
void	registerEnvironment(java.lang.String envUUID, java.util.Vector domainList, java.lang.Boolean isMobile) Register the environment with KAoS.

Methods inherited from class java.lang.Object

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

Constructor Detail

FLIKServer

public FLIKServer(int port,
                  java.lang.String transport)
           throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

registerEnvironment

public void registerEnvironment(java.lang.String envUUID,
                                java.util.Vector domainList,
                                java.lang.Boolean isMobile)
                         throws java.lang.Exception

Register the environment with KAoS. By environment, we mean a Physical node in the framework, e.g. a host. The envUUID provided is a FlexFeed-generated unique identifier. Any reference to this environment from FlexFeed will be based on its envUUID. The environment may be fixed or mobile, as indicated by the isMobile parameter.

Throws:

java.lang.Exception

registerAgent

public void registerAgent(java.lang.String agentName,
                          java.lang.String envUUID,
                          java.util.Vector domainList)
                   throws java.lang.Exception

Register an agent in FlexFeed. The name is unique within FlexFeed and will be used by the framework to register /lookup this agent with KAoS.

Throws:

java.lang.Exception

modifyAgentRegistration

public void modifyAgentRegistration(java.lang.String agentName,
                                    java.lang.String envUUID,
                                    java.util.Vector domainList)
                             throws java.lang.Exception

Modifies an agent registration with an updated envUUID and/or domainList

Throws:

java.lang.Exception

modifyEnvironmentRegistration

public void modifyEnvironmentRegistration(java.lang.String envUUID,
                                          java.util.Vector domainList,
                                          java.lang.Boolean isMobile)
                                   throws java.lang.Exception

Modifies an environment registration with an updated domainList or mobility

Throws:

java.lang.Exception

deregisterAgent

public void deregisterAgent(java.lang.String agentName)
                     throws java.lang.Exception

Throws:

java.lang.Exception

deregisterEnvironment

public void deregisterEnvironment(java.lang.String envUUID)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getPolicyConstraintsForEntity

public PolicyConstraints getPolicyConstraintsForEntity(java.lang.String entityId,
                                                       java.lang.String type)
                                                throws java.lang.Exception

Returns the policy constraints of the given type for the given entity (that is, the given entity is the actor of the policy). The type is currently limited to {MOBILITY_CONSTRAINTS}, since it doesn’t make sense to ask for VideoFeed constraints without a target. This method returns a PolicyConstraints object which corresponds to the type, in this case RobotMobilityConstraints.

Throws:

java.lang.Exception

getPolicyConstraintsBetweenEntities

public PolicyConstraints getPolicyConstraintsBetweenEntities(java.lang.String sourceId,
                                                             java.lang.String destId,
                                                             java.lang.String type)

Returns the policy constraints of the given type for the given source and destination entities (that is, the source entity is the actor of the policy, and the destination entity is the target of the policy). The type is currently limited to {VIDEO_CONSTRAINTS}, and this method returns a VideoFeedConstraints object.

addPolicyUpdateListener

public void addPolicyUpdateListener(PolicyUpdateListener listener)

Adds a listener which will be notified when policies have been updated

main

public static void main(java.lang.String[] args)