eu.hgross.blaubot.core

Class BlaubotFactory

java.lang.Object

eu.hgross.blaubot.core.BlaubotFactory

Direct Known Subclasses:

BlaubotAndroidFactory

public class BlaubotFactory
extends java.lang.Object

A factory that creates Blaubot, adapter, beacon, BlaubotServer and BlaubotServerConnector instances.

Constructor Summary

Constructors

Constructor and Description
BlaubotFactory()

Method Summary

Modifier and Type	Method and Description
static Blaubot	createBlaubot(java.util.UUID appUuid, IBlaubotAdapter adapter, IBlaubotBeacon... beacons) Creates a Blaubot instance from a given adapter and multiple beacons using a random unique device id for the ownDevice.
static Blaubot	createBlaubot(java.util.UUID appUuid, IBlaubotDevice ownDevice, IBlaubotAdapter adapter, IBlaubotBeacon... beacons) Creates a Blaubot instance from a given adapter and multiple beacons.
static IBlaubotAdapter	createBlaubotWebsocketAdapter(IBlaubotDevice ownDevice, java.lang.String host, int port) Create a websocket adapter via reflection
static BlaubotServer	createBlaubotWebsocketServer(IBlaubotDevice ownDevice) Creates a blaubot server using websockets, the default port 8080 on all interfaces (0.0.0.0).
static BlaubotServer	createBlaubotWebsocketServer(IBlaubotDevice ownDevice, int httpPort) Creates a blaubot server using websockets on all interfaces (0.0.0.0) using the given httpPort.
static BlaubotServer	createBlaubotWebsocketServer(IBlaubotDevice ownDevice, java.lang.String host, int port) Creates a blaubot server using the websocket acceptor
static Blaubot	createEthernetBlaubot(java.util.UUID appUUID) Creates a ethernet blaubot instance with the default ports 17171, 17172, 17173 and does some dirty stuff to get around android's no network on main thread policy.
static Blaubot	createEthernetBlaubot(java.util.UUID appUUID, int acceptorPort, int beaconPort, int beaconBroadcastPort, java.net.InetAddress ownInetAddress) Creates a blaubot instance using an existing network and the tcp socket adapter with the multicast beacon.
static Blaubot	createEthernetBlaubotWithBonjourBeacon(java.util.UUID appUUID, int acceptorPort, int beaconPort, java.net.InetAddress ownInetAddress) Creates a blaubot instance using the bonjour beacon.
static Blaubot	createEthernetBlaubotWithFixedDevicesBeacon(java.util.UUID appUUID, IBlaubotDevice ownDevice, int acceptorPort, int beaconPort, java.net.InetAddress ownInetAddress, java.util.Set<java.lang.String> fixedDevicesSet) Creates a blaubot instance using the ethernet adapter.
static IBlaubotAdapter	createJsr82Adapter(BlaubotUUIDSet uuidSet, IBlaubotDevice ownDevice) Creates a JSR82 adapter that can be used on Windows, Mac and Linux, if a jsr82 implementation is available.
static Blaubot	createJsr82BluetoothBlaubot(java.util.UUID appUUID) Sets up a default Blaubot instance using a Jsr82 bluetooth stack for connections and a multicast beacon (ip network) for discovery.
static Blaubot	createWebSocketBlaubotWithBonjourBeacon(java.util.UUID appUUID, int websocketPort, int beaconPort, java.net.InetAddress ownInetAddress) Creates a blaubot instance using an existing network and the websocket adapter with the bonjour beacon.
static Blaubot	createWebSocketBlaubotWithMulticastBeacon(java.util.UUID appUUID, int websocketPort, int beaconPort, int beaconBroadcastPort, java.net.InetAddress ownInetAddress) Creates a blaubot instance using an existing network and the websocket adapter with the multicast beacon.
static GeoBeaconServer	createWebSocketGeoBeaconServer(int webSocketAcceptPort, double geoRadius) Creates a standalone GeoBeaconServer which uses WebSockets as an endpoint for a GeoLocationBeacon.
static GeoLocationBeacon	createWebSocketGeoLocationBeacon(IBlaubotDevice ownDevice, java.lang.String beaconServerHost, int beaconServerPort) Creates a GeoLocationBeacon using WebSockets.
static ConnectionMetaDataDTO	createWebSocketMetaDataDTO(java.lang.String host, java.lang.String path, int port) This shortcut method creates a websocket meta data object that can be used to provide endpoint information when using a websocket based BlaubotServer or GeoBeaconServer.
static BlaubotServerConnector	createWebSocketServerConnector(java.lang.String host, int port, java.lang.String websocketPath, IBlaubotDevice ownDevice, java.lang.String serverDeviceUniqueDeviceId) Creates a WebSocket ServerConnector.
static java.net.InetAddress	getLocalIpAddress() TODO: move to another location

Methods inherited from class java.lang.Object

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

Constructor Detail

BlaubotFactory

public BlaubotFactory()

Method Detail

createEthernetBlaubot

public static Blaubot createEthernetBlaubot(java.util.UUID appUUID)

Creates a ethernet blaubot instance with the default ports 17171, 17172, 17173 and does some dirty stuff to get around android's no network on main thread policy.

Parameters:

appUUID - the app's uuid

Returns:

the blaubot instance

createEthernetBlaubotWithBonjourBeacon

public static Blaubot createEthernetBlaubotWithBonjourBeacon(java.util.UUID appUUID,
                                                             int acceptorPort,
                                                             int beaconPort,
                                                             java.net.InetAddress ownInetAddress)

Creates a blaubot instance using the bonjour beacon. Note: requires broadcast capable network

Parameters:

appUUID - the app's uuid

acceptorPort - the port of the connector's accepting socket

beaconPort - the port for the beacon to accept connections on

ownInetAddress - the own InetAddress of the network to act on

Returns:

the blaubot instance

createEthernetBlaubot

public static Blaubot createEthernetBlaubot(java.util.UUID appUUID,
                                            int acceptorPort,
                                            int beaconPort,
                                            int beaconBroadcastPort,
                                            java.net.InetAddress ownInetAddress)

Creates a blaubot instance using an existing network and the tcp socket adapter with the multicast beacon. Note: requires broadcast capable network

Parameters:

appUUID - the app's uuid

acceptorPort - the port of the connector's accepting socket

beaconPort - the port of the beacon's accepting socket

beaconBroadcastPort - the broadcast port. Has to be the same for all instances.

ownInetAddress - the own InetAddress of the network to act on

Returns:

the blaubot instance

createWebSocketBlaubotWithMulticastBeacon

public static Blaubot createWebSocketBlaubotWithMulticastBeacon(java.util.UUID appUUID,
                                                                int websocketPort,
                                                                int beaconPort,
                                                                int beaconBroadcastPort,
                                                                java.net.InetAddress ownInetAddress)
                                                         throws java.lang.ClassNotFoundException

Creates a blaubot instance using an existing network and the websocket adapter with the multicast beacon. Note: requires broadcast capable network

Parameters:

appUUID - the app's uuid

websocketPort - the port for the websocket acceptor to listen on

beaconPort - the port of the beacon's accepting socket

beaconBroadcastPort - the broadcast port. Has to be the same for all instances.

ownInetAddress - the ip of this device to bind the websocket to

Returns:

the blaubot instance

Throws:

java.lang.ClassNotFoundException - if the blaubot-websocket dependency could not be resolved

createWebSocketBlaubotWithBonjourBeacon

public static Blaubot createWebSocketBlaubotWithBonjourBeacon(java.util.UUID appUUID,
                                                              int websocketPort,
                                                              int beaconPort,
                                                              java.net.InetAddress ownInetAddress)
                                                       throws java.lang.ClassNotFoundException

Creates a blaubot instance using an existing network and the websocket adapter with the bonjour beacon. Note: requires broadcast capable network

Parameters:

appUUID - the app's uuid

websocketPort - the port for the websocket acceptor to listen on

beaconPort - the port of the beacon's accepting socket

ownInetAddress - the own InetAddress of the network to act on

Returns:

the blaubot instance

Throws:

java.lang.ClassNotFoundException - if the blaubot-websocket dependency could not be resolved

createEthernetBlaubotWithFixedDevicesBeacon

public static Blaubot createEthernetBlaubotWithFixedDevicesBeacon(java.util.UUID appUUID,
                                                                  IBlaubotDevice ownDevice,
                                                                  int acceptorPort,
                                                                  int beaconPort,
                                                                  java.net.InetAddress ownInetAddress,
                                                                  java.util.Set<java.lang.String> fixedDevicesSet)
                                                           throws java.net.UnknownHostException

Creates a blaubot instance using the ethernet adapter. This instance will only operate on the given fixedDevicesSet and does not do any discovery.

Parameters:

appUUID - the app's uuid

ownDevice - the own device unique id. Note that it's uniqueId has to be present in the fixed device set

acceptorPort - the port of the connector's accepting socket

beaconPort - the port of the beacon's accepting socket

ownInetAddress - the own InetAddress of the network to act on

fixedDevicesSet - a set of fixed devices to connect to (represented as uniqueIdStrings)

Returns:

the blaubot instance

Throws:

java.net.UnknownHostException - if inetAddress was invalid

createBlaubot

public static Blaubot createBlaubot(java.util.UUID appUuid,
                                    IBlaubotDevice ownDevice,
                                    IBlaubotAdapter adapter,
                                    IBlaubotBeacon... beacons)

Creates a Blaubot instance from a given adapter and multiple beacons.

Parameters:

appUuid - the app's unique uuid

ownDevice - the own device containing this device's unique identifier

adapter - the adapter to be used (Sockets, WebSockets, Bluetooth, ...)

beacons - the becaons to be used (Bluetooth, NFC, Multicast, Bonjour, ...)

Returns:

the blaubot instance

createBlaubot

public static Blaubot createBlaubot(java.util.UUID appUuid,
                                    IBlaubotAdapter adapter,
                                    IBlaubotBeacon... beacons)

Creates a Blaubot instance from a given adapter and multiple beacons using a random unique device id for the ownDevice.

Parameters:

appUuid - the app's unique uuid

adapter - the adapter to be used (Sockets, WebSockets, Bluetooth, ...)

beacons - the becaons to be used (Bluetooth, NFC, Multicast, Bonjour, ...)

Returns:

the blaubot instance

getLocalIpAddress

public static java.net.InetAddress getLocalIpAddress()

TODO: move to another location

Returns:

the most likely SiteLocal inetAddress or null, if everything went wrong

createJsr82BluetoothBlaubot

public static Blaubot createJsr82BluetoothBlaubot(java.util.UUID appUUID)
                                           throws java.lang.RuntimeException,
                                                  java.lang.ClassNotFoundException

Sets up a default Blaubot instance using a Jsr82 bluetooth stack for connections and a multicast beacon (ip network) for discovery. Note that you have to include a Jsr82 compliant implementation into your classpath (i.e. bluecove (windows, mac); bluecove-gpl (linux); bluez)

Parameters:

appUUID - the app's unique uuid

Returns:

blaubot instance

Throws:

java.lang.RuntimeException - if no Jsr82 implementation is available at runtime or cannot access the bluetooth stack

java.lang.ClassNotFoundException - if the blaubot-jsr82 jar is not available from the classpath

createJsr82Adapter

public static final IBlaubotAdapter createJsr82Adapter(BlaubotUUIDSet uuidSet,
                                                       IBlaubotDevice ownDevice)
                                                throws java.lang.ClassNotFoundException

Creates a JSR82 adapter that can be used on Windows, Mac and Linux, if a jsr82 implementation is available.

Parameters:

uuidSet - uuid set (created from the app uid)

ownDevice - the own device

Returns:

the adapter instance

Throws:

java.lang.ClassNotFoundException - if the blaubot-jsr82 jar is not in the classpath

createBlaubotWebsocketServer

public static BlaubotServer createBlaubotWebsocketServer(IBlaubotDevice ownDevice,
                                                         java.lang.String host,
                                                         int port)
                                                  throws java.lang.ClassNotFoundException

Creates a blaubot server using the websocket acceptor

Parameters:

ownDevice - the own device

host - the interfaces to bind the websockets to.

port - the port to open the websocket server on

Returns:

the server instance

Throws:

java.lang.ClassNotFoundException - if the websocket jar is not in the classpath

createBlaubotWebsocketAdapter

public static final IBlaubotAdapter createBlaubotWebsocketAdapter(IBlaubotDevice ownDevice,
                                                                  java.lang.String host,
                                                                  int port)
                                                           throws java.lang.ClassNotFoundException

Create a websocket adapter via reflection

Parameters:

ownDevice - the own device (and uniqueDeviceId)

host - the own host address (interfaces to bind to)

port - the port for the acceptor to accept connections on

Returns:

adapter instance

Throws:

java.lang.ClassNotFoundException - if the websocket jar is not in the classpath

createWebSocketMetaDataDTO

public static final ConnectionMetaDataDTO createWebSocketMetaDataDTO(java.lang.String host,
                                                                     java.lang.String path,
                                                                     int port)
                                                              throws java.lang.ClassNotFoundException

This shortcut method creates a websocket meta data object that can be used to provide endpoint information when using a websocket based BlaubotServer or GeoBeaconServer.

Parameters:

host - the hostname to connect to

path - the path to connect the websocket with (with leading slash)

port - the port

Returns:

the connection metadata

Throws:

java.lang.ClassNotFoundException - if the websocket jar is not in the classpath

createBlaubotWebsocketServer

public static BlaubotServer createBlaubotWebsocketServer(IBlaubotDevice ownDevice)
                                                  throws java.lang.ClassNotFoundException

Creates a blaubot server using websockets, the default port 8080 on all interfaces (0.0.0.0).

Parameters:

ownDevice - the own device

Returns:

the blaubot server

Throws:

java.lang.ClassNotFoundException - if the websocket jar is not in the classpath

createBlaubotWebsocketServer

public static BlaubotServer createBlaubotWebsocketServer(IBlaubotDevice ownDevice,
                                                         int httpPort)
                                                  throws java.lang.ClassNotFoundException

Creates a blaubot server using websockets on all interfaces (0.0.0.0) using the given httpPort.

Parameters:

ownDevice - the own device

httpPort - the httpPort for the http server to server requests

Returns:

the blaubot server

Throws:

java.lang.ClassNotFoundException - if the websocket jar is not in the classpath

createWebSocketServerConnector

public static BlaubotServerConnector createWebSocketServerConnector(java.lang.String host,
                                                                    int port,
                                                                    java.lang.String websocketPath,
                                                                    IBlaubotDevice ownDevice,
                                                                    java.lang.String serverDeviceUniqueDeviceId)
                                                             throws java.lang.ClassNotFoundException

Creates a WebSocket ServerConnector.

Parameters:

host - the server's hostname or IPv4-Address

port - the server's port

websocketPath - the uri path used by the websocket acceptor

ownDevice - the OWN device of the connecting blaubot instance

serverDeviceUniqueDeviceId - the server's unique device id.

Returns:

the server connector ready to be attached to the blaubot instance

Throws:

java.lang.ClassNotFoundException - if the websocket jar is not in the classpath

createWebSocketGeoLocationBeacon

public static GeoLocationBeacon createWebSocketGeoLocationBeacon(IBlaubotDevice ownDevice,
                                                                 java.lang.String beaconServerHost,
                                                                 int beaconServerPort)
                                                          throws java.lang.ClassNotFoundException

Creates a GeoLocationBeacon using WebSockets. Note: You have to inject a GeoData object to set the the current location.

Parameters:

ownDevice - the ownDevice (Blaubot-Instance device)

beaconServerHost - the hostname or ip of the beacon server

beaconServerPort - the port on which the beacon server listens

Returns:

the geolocation beacon

Throws:

java.lang.ClassNotFoundException - if blaubot-websockets is not in the classpath

createWebSocketGeoBeaconServer

public static GeoBeaconServer createWebSocketGeoBeaconServer(int webSocketAcceptPort,
                                                             double geoRadius)
                                                      throws java.lang.ClassNotFoundException

Creates a standalone GeoBeaconServer which uses WebSockets as an endpoint for a GeoLocationBeacon.

Parameters:

webSocketAcceptPort - the websocket port to serve on

geoRadius - the geo radius in km used to inform nearby beacons

Returns:

the geo beacon server

Throws:

java.lang.ClassNotFoundException - if blaubot-websockets is not in the classpath