org.universAAL.ri.gateway.protocol

Class ImportMessage

java.lang.Object

org.universAAL.ri.gateway.protocol.Message

org.universAAL.ri.gateway.protocol.ImportMessage

All Implemented Interfaces:

Serializable

public class ImportMessage
extends Message

Author:

amedrano

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImportMessage.ImportMessageType Different type of import messages.

Field Summary

Fields inherited from class org.universAAL.ri.gateway.protocol.Message

inResponseTo

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImportMessage() Constructor.
protected	ImportMessage(Message respondTo) Response constructor.

Method Summary

Modifier and Type	Method and Description
String	getBusMemberId()
ImportMessage.ImportMessageType	getMessageType()
Resource[]	getParameters()
static ImportMessage	importAddSubscription(String requestedBusMember, Resource[] newBusMemberParameters) Create a importAddSubscription ImportMessage for a particular ProxyBusMember with certain parameters.
static ImportMessage	importRemove(String requestedBusMember) Create a importRemove ImportMessage for a particular ProxyBusMember .
static ImportMessage	importRemoveSubscription(String requestedBusMember, Resource[] newBusMemberParameters) Create a importRemoveSubscription ImportMessage for a particular ProxyBusMember with certain parameters.
static ImportMessage	importRequest(String requestedBusMember, Resource[] busMemberParameters) Create a importRequest ImportMessage for a particular ProxyBusMember with certain parameters.
static ImportMessage	importResponse(ImportMessage request, String proxyIdentifyer) Create a importResponse ImportMessage.
boolean	isAccepted() Check that an ImportResponse type Message has been accepted.

Methods inherited from class org.universAAL.ri.gateway.protocol.Message

getInResponseTo, getSequence, isResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportMessage

protected ImportMessage()

Constructor.

ImportMessage

protected ImportMessage(Message respondTo)

Response constructor.

Parameters:

respondTo -

Method Detail

getMessageType

public final ImportMessage.ImportMessageType getMessageType()

Returns:

the messageType

getBusMemberId

public final String getBusMemberId()

Returns:

the busMemberId

getParameters

public final Resource[] getParameters()

Returns:

the parameters

isAccepted

public boolean isAccepted()

Check that an ImportResponse type Message has been accepted.

Returns:

importRequest

public static ImportMessage importRequest(String requestedBusMember,
                                          Resource[] busMemberParameters)

Create a importRequest ImportMessage for a particular ProxyBusMember with certain parameters.

Parameters:

requestedBusMember - the busMember identification for future reference, This should be the reference of the proxy created locally.

busMemberParameters -

Returns:

the message.

importResponse

public static ImportMessage importResponse(ImportMessage request,
                                           String proxyIdentifyer)

Create a importResponse ImportMessage.

Parameters:

request - the request to respond to.

proxyIdentifyer - The identifier of the local proxy created (so remote associates it to its local), null if the request is denied.

Returns:

the message.

importAddSubscription

public static ImportMessage importAddSubscription(String requestedBusMember,
                                                  Resource[] newBusMemberParameters)

Create a importAddSubscription ImportMessage for a particular ProxyBusMember with certain parameters.

Parameters:

requestedBusMember - the busMember identification for future reference, This should be the local reference.

busMemberParameters - The parameters to add.

Returns:

the message.

importRemoveSubscription

public static ImportMessage importRemoveSubscription(String requestedBusMember,
                                                     Resource[] newBusMemberParameters)

Create a importRemoveSubscription ImportMessage for a particular ProxyBusMember with certain parameters.

Parameters:

requestedBusMember - the busMember identification for future reference, This should be the local reference.

busMemberParameters - the parameters to be removed.

Returns:

the message.

importRemove

public static ImportMessage importRemove(String requestedBusMember)

Create a importRemove ImportMessage for a particular ProxyBusMember .

Parameters:

requestedBusMember - the busMember identification for future reference, This should be the local proxy reference.

Returns:

the message.