kaos.core.csi.util.xmlSupport
Class XMLToCSILink

java.lang.Object
  kaos.core.csi.util.xmlSupport.XMLToCSILink

All Implemented Interfaces:

FeedbackReceiver

public class XMLToCSILink
extends java.lang.Object
implements FeedbackReceiver

Field Summary

static java.lang.String

DOMAIN_FOR_ALL_TCP_BASED_PROTOCOL

Method Summary

void	authorizeActions(java.util.Hashtable authorizations, ResponseSender responseSender) {Authorizations={http://ontology.ihmc.us/Action.owl#CommunicationAction={Actor=urn:KAoS#Entity1, Properties={http://ontology.ihmc.us/Action.owl#hasDestination=urn:KAoS#Allowed}}}}
static XMLToCSILink	getInstance(java.lang.String transportName) Retrieve an instance of XMLToCSILink.
static void	main(java.lang.String[] argv) Main program entry point.
void	onAborted(java.util.Calendar time, java.lang.Object reason, java.lang.String actionID, java.lang.String robotID) This method is invoked when the requested action is aborted.
void	onAccepted(java.util.Calendar time, java.lang.Object acceptInfo, java.lang.String actionID, java.lang.String robotID) This method is invoked when the request is accepted by the robot.
void	onCompleted(java.util.Calendar time, java.lang.Object result, java.lang.String actionID, java.lang.String robotID) This method is invoked upon completion of the request byt the requested robot.
void	onRefused(java.util.Calendar time, java.lang.Object reason, java.lang.String actionID, java.lang.String robotID) This method is invoked when the request is refused by the robot.
void	onStarted(java.util.Calendar time, java.lang.Object startedInfo, java.lang.String actionID, java.lang.String robotID) This method is invoked when the robot starts the requested action.
void	receiveKAoSStatus(java.lang.String statusMsg, java.lang.String actionID, java.lang.String robotID) Receive a status message describing the execution of the requested action.
void	register(java.util.Hashtable registrations)
void	registerTCPDomain()
void	requestAction(ResponseSender responseSender, java.lang.String xmlString, java.lang.String xmlTransmissionType)
void	requestCommand(ResponseSender responseSender, java.util.Hashtable commands)

Methods inherited from class java.lang.Object

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

Field Detail

DOMAIN_FOR_ALL_TCP_BASED_PROTOCOL

public static final java.lang.String DOMAIN_FOR_ALL_TCP_BASED_PROTOCOL

See Also:

Constant Field Values

Method Detail

getInstance

public static XMLToCSILink getInstance(java.lang.String transportName)
                                throws java.lang.Exception

Retrieve an instance of XMLToCSILink.

Parameters:

transportName - String specifying the name of the transport to use for communication with the KAoS Directory Service.

Returns:

a singleton, XMLToCSILink.

Throws:

java.lang.Exception

requestAction

public void requestAction(ResponseSender responseSender,
                          java.lang.String xmlString,
                          java.lang.String xmlTransmissionType)

authorizeActions

public void authorizeActions(java.util.Hashtable authorizations,
                             ResponseSender responseSender)

{Authorizations={http://ontology.ihmc.us/Action.owl#CommunicationAction={Actor=urn:KAoS#Entity1, Properties={http://ontology.ihmc.us/Action.owl#hasDestination=urn:KAoS#Allowed}}}}

Parameters:

authorizations -

responseSender -

register

public void register(java.util.Hashtable registrations)
              throws DirectoryFailure,
                     AlreadyRegisteredException,
                     GuardInstantiationException

Throws:

DirectoryFailure

AlreadyRegisteredException

GuardInstantiationException

requestCommand

public void requestCommand(ResponseSender responseSender,
                           java.util.Hashtable commands)

onAccepted

public void onAccepted(java.util.Calendar time,
                       java.lang.Object acceptInfo,
                       java.lang.String actionID,
                       java.lang.String robotID)

Description copied from interface: FeedbackReceiver

This method is invoked when the request is accepted by the robot.

Specified by:

onAccepted in interface FeedbackReceiver

Parameters:

time - Calendar time of acceptance.

acceptInfo - Object containing additional (optional) info about the acceptance.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onRefused

public void onRefused(java.util.Calendar time,
                      java.lang.Object reason,
                      java.lang.String actionID,
                      java.lang.String robotID)

Description copied from interface: FeedbackReceiver

This method is invoked when the request is refused by the robot.

Specified by:

onRefused in interface FeedbackReceiver

Parameters:

time - Calendar time of refusal.

reason - Object containing the reason for refusing the request.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onCompleted

public void onCompleted(java.util.Calendar time,
                        java.lang.Object result,
                        java.lang.String actionID,
                        java.lang.String robotID)

Description copied from interface: FeedbackReceiver

This method is invoked upon completion of the request byt the requested robot.

Specified by:

onCompleted in interface FeedbackReceiver

Parameters:

time - Calendar time of information/action completion.

result - Object containing the result of the requested action.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onStarted

public void onStarted(java.util.Calendar time,
                      java.lang.Object startedInfo,
                      java.lang.String actionID,
                      java.lang.String robotID)

Description copied from interface: FeedbackReceiver

This method is invoked when the robot starts the requested action.

Specified by:

onStarted in interface FeedbackReceiver

Parameters:

time - Calendar time of starting an action.

startedInfo - Object containing additional (optional) info about the start of the action.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

onAborted

public void onAborted(java.util.Calendar time,
                      java.lang.Object reason,
                      java.lang.String actionID,
                      java.lang.String robotID)

Description copied from interface: FeedbackReceiver

This method is invoked when the requested action is aborted.

Specified by:

onAborted in interface FeedbackReceiver

Parameters:

time - Calendar time of aborting an action.

reason - Object containing the reason for aborting an action.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

receiveKAoSStatus

public void receiveKAoSStatus(java.lang.String statusMsg,
                              java.lang.String actionID,
                              java.lang.String robotID)

Description copied from interface: FeedbackReceiver

Receive a status message describing the execution of the requested action. There maybe several status messages sent during action execution.

Specified by:

receiveKAoSStatus in interface FeedbackReceiver

Parameters:

statusMsg - Object containing the result of the requested action/information.

actionID - String containing the id of the requested action/information.

robotID - String containing the name of the robot performing the action.

registerTCPDomain

public void registerTCPDomain()
                       throws DirectoryFailure

Throws:

DirectoryFailure

main

public static void main(java.lang.String[] argv)
                 throws java.lang.Exception

Main program entry point.

Throws:

java.lang.Exception