com.smaxe.uv.client.amf

Class AmfConnection

java.lang.Object

com.smaxe.uv.client.amf.AmfConnection

public final class AmfConnection
extends java.lang.Object

AmfConnection - AMF connection.

Author:

Andrei Sochirca

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AmfConnection.Configuration Configuration - AmfConnection configuration constants.
static interface	AmfConnection.IListener IListener - AmfConnection listener.
static class	AmfConnection.ListenerAdapter ListenerAdapter - AmfConnection.IListener adapter.

Field Summary

Fields

Modifier and Type	Field and Description
static ObjectEncoding	defaultObjectEncoding Default object encoding.

Constructor Summary

Constructors

Constructor and Description
AmfConnection() Constructor.
AmfConnection(java.util.Map<java.lang.String,java.lang.Object> configuration) Constructor.
AmfConnection(java.util.Map<java.lang.String,java.lang.Object> configuration, java.util.concurrent.ExecutorService dispatcher) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(AmfConnection.IListener listener) Registers an event listener.
void	addHeader(java.lang.String operation, boolean mustUnderstand, java.lang.Object param) Adds a context header to the Action Message Format (AMF) packet structure.
void	addHeader(java.lang.String operation, java.lang.Object value) Equivalent to addHeader(String, boolean, Object) where mustUnderstand=false
void	call(java.lang.String endpoint, java.lang.String destination, java.lang.String command, Responder responder, java.lang.Object... arguments) Invokes a command or method on server running Flash Remoting.
void	close() Closes the connection.
void	connect(java.lang.String url, java.lang.Object... args) Opens a connection to a server.
boolean	connected() Checks if it is connected to the server.
static java.lang.String	createUUID() Creates random UUID.
java.util.Map<java.lang.String,java.lang.String>	getHttpHeader() Returns HTTP request header.
ObjectEncoding	objectEncoding() Returns object encoding.
void	objectEncoding(ObjectEncoding encoding) The object encoding (AMF version).
void	removeEventListener(AmfConnection.IListener listener) Removes the listener.
void	removeHeader(java.lang.String operation) Removes the context header.
void	sendMessage(AbstractMessage message, Responder responder) Sends message to the server.
java.lang.String	uri() Returns the HTTP or HTTPS url for the AMF connection.

Methods inherited from class java.lang.Object

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

Field Detail

defaultObjectEncoding

public static ObjectEncoding defaultObjectEncoding

Default object encoding.

Constructor Detail

AmfConnection

public AmfConnection()

Constructor.

AmfConnection

public AmfConnection(java.util.Map<java.lang.String,java.lang.Object> configuration)

Constructor.

Parameters:

configuration - connection configuration

AmfConnection

public AmfConnection(java.util.Map<java.lang.String,java.lang.Object> configuration,
             java.util.concurrent.ExecutorService dispatcher)

Constructor.

Parameters:

configuration - connection configuration

dispatcher - dispatcher

Method Detail

createUUID

public static java.lang.String createUUID()

Creates random UUID.

Returns:

random UUID

addHeader

public void addHeader(java.lang.String operation,
             boolean mustUnderstand,
             java.lang.Object param)

Adds a context header to the Action Message Format (AMF) packet structure. This header is sent with every future AMF packet. If you call addHeader() using the same name, the new header replaces the existing header, and the new header persists for the duration of the AmfConnection object.

Parameters:

operation - identifies the header and the ActionScript object data associated with it

mustUnderstand - value of true indicates that the server must understand and process this header before it handles any of the following headers or messages

param - any object

addHeader

public void addHeader(java.lang.String operation,
             java.lang.Object value)

Equivalent to addHeader(String, boolean, Object) where mustUnderstand=false

Parameters:

operation -

value -

removeHeader

public void removeHeader(java.lang.String operation)

Removes the context header.

Parameters:

operation -

getHttpHeader

public java.util.Map<java.lang.String,java.lang.String> getHttpHeader()

Returns HTTP request header.

Returns:

HTTP request header

objectEncoding

public ObjectEncoding objectEncoding()

Returns object encoding.

Returns:

object encoding

objectEncoding

public void objectEncoding(ObjectEncoding encoding)

The object encoding (AMF version).

Parameters:

encoding - object encoding

call

public void call(java.lang.String endpoint,
        java.lang.String destination,
        java.lang.String command,
        Responder responder,
        java.lang.Object... arguments)

Invokes a command or method on server running Flash Remoting. Before calling call() you must call connect() to connect to the server. You must create a server-side function to pass to this method.

Parameters:

endpoint - endpoint name

destination - destinatio name

command - method name

responder -

arguments -

connect

public void connect(java.lang.String url,
           java.lang.Object... args)

Opens a connection to a server.

Parameters:

url - url to connect

args - connection arguments

connected

public boolean connected()

Checks if it is connected to the server. 'Connected' means that the connection is accepted by the server rather than a 'physical' connection is established.

Returns:

true if connected; false otherwise

close

public void close()

Closes the connection.

sendMessage

public void sendMessage(AbstractMessage message,
               Responder responder)

Sends message to the server.

Parameters:

message -

responder -

uri

public java.lang.String uri()

Returns the HTTP or HTTPS url for the AMF connection.

Returns:

The HTTP or HTTPs url for the AMF connection.

addEventListener

public void addEventListener(AmfConnection.IListener listener)

Registers an event listener.

Parameters:

listener - listener to add

removeEventListener

public void removeEventListener(AmfConnection.IListener listener)

Removes the listener.

Parameters:

listener - listener to remove