com.vii.brillien.kernel.axiom.transport
Interface Communication


public interface Communication

Data representation of an abstract Communication.


Field Summary
static String DEFAULT_FLOW_ID
           
static int TYPE_AGET
           
static int TYPE_DELEGATED_SET
           
static int TYPE_ERROR
           
static int TYPE_GET
           
static int TYPE_RESULT
           
static int TYPE_SET
           
static int TYPE_UNDEFINED
          According to the specification of Powerobject model, these constants defines the basic types of communication.
static int TYPE_UNKOWN
           
 
Method Summary
 Map<String,Object> acquireParameters(Map<String,Class> types)
           
<T> T
acquireResponse(Class<T> type)
           
<T> T
acquireResponse(Class<T> type, Map<String,Class> typeHint)
           
<T> T
acquireResponse(Class<T> type, String typeHint, Class hintClass)
           
<T> T
acquireResponse(Map<String,Class> typeHint)
           
<T> T
acquireResponse(String typeHint, Class hintClass)
           
 void addExtension(String key, Object value)
          Application or chanel specific extension can be added to a communication
 String getApiKey()
           
 Integer getErrorCode()
           
 Object getErrorValue()
           
<T> T
getExtension(String key)
          Retrieves application or chanel specific extension
 String getFlowID()
           
 String getId()
           
 int getMessageType()
           
 String getOriginalId()
           
 int getOriginalType()
           
 Map<String,Object> getParameters()
           
 String getRecipient()
           
 String getRedirectEntityName()
           
 String getRedirectMessage()
           
 Long getRequestTime()
           
<T> T
getResponse()
           
 Long getResponseTime()
           
 String getSender()
           
 Session getSession()
           
 String getSubject()
           
 boolean hasExcension(String key)
          Tells whether the given excension exists
 boolean isAnswerTo(Communication msg)
           
 void setApiKey(String apiKey)
           
 void setErrorCode(Integer errorCode)
           
 void setErrorValue(Object errorValue)
           
 void setFlowID(String flowID)
           
 void setId(String id)
           
 void setMessageType(int messageType)
           
 void setOriginalId(String id)
           
 void setOriginalType(int originalType)
           
 void setParameters(Map<String,Object> parameters)
           
 void setRecipient(String recipient)
           
 void setRedirectEntityName(String redirectEntityName)
           
 void setRedirectMessage(String redirectMessage)
           
 void setRequestTime(Long requestTime)
           
 void setResponse(Object response)
           
 void setResponseTime(Long responseTime)
           
 void setSender(String sender)
           
 void setSession(Session session)
           
 void setSubject(String subject)
           
 

Field Detail

TYPE_UNDEFINED

static final int TYPE_UNDEFINED
According to the specification of Powerobject model, these constants defines the basic types of communication.

See Also:
Constant Field Values

TYPE_UNKOWN

static final int TYPE_UNKOWN
See Also:
Constant Field Values

TYPE_GET

static final int TYPE_GET
See Also:
Constant Field Values

TYPE_AGET

static final int TYPE_AGET
See Also:
Constant Field Values

TYPE_SET

static final int TYPE_SET
See Also:
Constant Field Values

TYPE_DELEGATED_SET

static final int TYPE_DELEGATED_SET
See Also:
Constant Field Values

TYPE_RESULT

static final int TYPE_RESULT
See Also:
Constant Field Values

TYPE_ERROR

static final int TYPE_ERROR
See Also:
Constant Field Values

DEFAULT_FLOW_ID

static final String DEFAULT_FLOW_ID
See Also:
Constant Field Values
Method Detail

getId

String getId()

setId

void setId(String id)

getMessageType

int getMessageType()

setMessageType

void setMessageType(int messageType)

getSender

String getSender()

setSender

void setSender(String sender)

getRecipient

String getRecipient()

setRecipient

void setRecipient(String recipient)

getFlowID

String getFlowID()

setFlowID

void setFlowID(String flowID)

getSession

Session getSession()

setSession

void setSession(Session session)

getApiKey

String getApiKey()

setApiKey

void setApiKey(String apiKey)

getSubject

String getSubject()

setSubject

void setSubject(String subject)

getRedirectEntityName

String getRedirectEntityName()

setRedirectEntityName

void setRedirectEntityName(String redirectEntityName)

getRedirectMessage

String getRedirectMessage()

setRedirectMessage

void setRedirectMessage(String redirectMessage)

getRequestTime

Long getRequestTime()

setRequestTime

void setRequestTime(Long requestTime)

getResponseTime

Long getResponseTime()

setResponseTime

void setResponseTime(Long responseTime)

getParameters

Map<String,Object> getParameters()

setParameters

void setParameters(Map<String,Object> parameters)

acquireParameters

Map<String,Object> acquireParameters(Map<String,Class> types)
                                     throws BrillienException
Throws:
BrillienException

getResponse

<T> T getResponse()

setResponse

void setResponse(Object response)

acquireResponse

<T> T acquireResponse(Class<T> type)
                  throws BrillienException
Throws:
BrillienException

acquireResponse

<T> T acquireResponse(Class<T> type,
                      Map<String,Class> typeHint)
                  throws BrillienException
Throws:
BrillienException

acquireResponse

<T> T acquireResponse(Map<String,Class> typeHint)
                  throws BrillienException
Throws:
BrillienException

acquireResponse

<T> T acquireResponse(String typeHint,
                      Class hintClass)
                  throws BrillienException
Throws:
BrillienException

acquireResponse

<T> T acquireResponse(Class<T> type,
                      String typeHint,
                      Class hintClass)
                  throws BrillienException
Throws:
BrillienException

getOriginalType

int getOriginalType()

setOriginalType

void setOriginalType(int originalType)

getOriginalId

String getOriginalId()

setOriginalId

void setOriginalId(String id)

getErrorCode

Integer getErrorCode()

setErrorCode

void setErrorCode(Integer errorCode)

getErrorValue

Object getErrorValue()

setErrorValue

void setErrorValue(Object errorValue)

isAnswerTo

boolean isAnswerTo(Communication msg)

addExtension

void addExtension(String key,
                  Object value)
Application or chanel specific extension can be added to a communication


hasExcension

boolean hasExcension(String key)
Tells whether the given excension exists


getExtension

<T> T getExtension(String key)
Retrieves application or chanel specific extension



Copyright © 2012. All Rights Reserved.