org.wso2.micro.gateway.core.globalthrottle.databridge.agent.endpoint.binary

Class BinaryDataEndpoint

java.lang.Object

org.wso2.micro.gateway.core.globalthrottle.databridge.agent.endpoint.DataEndpoint

org.wso2.micro.gateway.core.globalthrottle.databridge.agent.endpoint.binary.BinaryDataEndpoint

public class BinaryDataEndpoint
extends DataEndpoint

This class is Binary transport implementation for the Data Endpoint.

Nested Class Summary

Nested classes/interfaces inherited from class org.wso2.micro.gateway.core.globalthrottle.databridge.agent.endpoint.DataEndpoint

DataEndpoint.State

Constructor Summary

Constructors

Constructor and Description
BinaryDataEndpoint()

Method Summary

Modifier and Type	Method and Description
protected String	login(Object client, String userName, String password) Login to the endpoint and return the sessionId.
protected void	logout(Object client, String sessionId) Logout from the endpoint.
protected void	send(Object client, List<org.wso2.carbon.databridge.commons.Event> events) Send the list of events to the actual endpoint.

Methods inherited from class org.wso2.micro.gateway.core.globalthrottle.databridge.agent.endpoint.DataEndpoint

getDataEndpointConfiguration, getState, initialize, shutdown, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryDataEndpoint

public BinaryDataEndpoint()

Method Detail

login

protected String login(Object client,
                       String userName,
                       String password)
                throws DataEndpointAuthenticationException

Description copied from class: DataEndpoint

Login to the endpoint and return the sessionId.

Specified by:

login in class DataEndpoint

Parameters:

client - The client which can be used to connect to the endpoint.

userName - The username which is used to login,

password - The password which is required for the login operation.

Returns:

returns the sessionId

Throws:

DataEndpointAuthenticationException

logout

protected void logout(Object client,
                      String sessionId)
               throws DataEndpointAuthenticationException

Description copied from class: DataEndpoint

Logout from the endpoint.

Specified by:

logout in class DataEndpoint

Parameters:

client - The client that is used to logout operation.

sessionId - The current session Id.

Throws:

DataEndpointAuthenticationException

send

protected void send(Object client,
                    List<org.wso2.carbon.databridge.commons.Event> events)
             throws DataEndpointException,
                    org.wso2.carbon.databridge.commons.exception.SessionTimeoutException,
                    org.wso2.carbon.databridge.commons.exception.UndefinedEventTypeException

Description copied from class: DataEndpoint

Send the list of events to the actual endpoint.

Specified by:

send in class DataEndpoint

Parameters:

client - The client that can be used to send the events.

events - List of events that needs to be sent.

Throws:

DataEndpointException

org.wso2.carbon.databridge.commons.exception.SessionTimeoutException

org.wso2.carbon.databridge.commons.exception.UndefinedEventTypeException