com.github.sarxos.webcam.ds.ipcam

Class IpCamDeviceRegistry

java.lang.Object

com.github.sarxos.webcam.ds.ipcam.IpCamDeviceRegistry

public class IpCamDeviceRegistry
extends java.lang.Object

Class used to register IP camera devices.

Author:

Bartosz Firyn (SarXos)

Constructor Summary

Constructors

Constructor and Description
IpCamDeviceRegistry()

Method Summary

Modifier and Type	Method and Description
static java.util.List<IpCamDevice>	getIpCameras() Get all registered IP cameras.
static boolean	isRegistered(IpCamDevice ipcam) Is device registered?
static boolean	isRegistered(java.lang.String name) Is device with given name registered?
static boolean	isRegistered(java.net.URI uri) Is device with given URL registered?
static boolean	isRegistered(java.net.URL url) Is device with given URL registered?
static IpCamDevice	register(IpCamDevice ipcam) Register IP camera.
static IpCamDevice	register(java.lang.String name, java.lang.String url, IpCamMode mode)
static IpCamDevice	register(java.lang.String name, java.lang.String url, IpCamMode mode, IpCamAuth auth)
static IpCamDevice	register(java.lang.String name, java.net.URL url, IpCamMode mode)
static IpCamDevice	register(java.lang.String name, java.net.URL url, IpCamMode mode, IpCamAuth auth) Register new IP camera device.
static boolean	unregister(IpCamDevice ipcam) Unregister IP camera.
static boolean	unregister(java.lang.String name) Unregister IP camera with given name.
static void	unregisterAll() Removes all registered devices.

Methods inherited from class java.lang.Object

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

Constructor Detail

IpCamDeviceRegistry

public IpCamDeviceRegistry()

Method Detail

register

public static IpCamDevice register(IpCamDevice ipcam)

Register IP camera.

Parameters:

ipcam - the IP camera to be register

Returns:

IP camera device

register

public static IpCamDevice register(java.lang.String name,
                                   java.lang.String url,
                                   IpCamMode mode)
                            throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

register

public static IpCamDevice register(java.lang.String name,
                                   java.net.URL url,
                                   IpCamMode mode)

register

public static IpCamDevice register(java.lang.String name,
                                   java.lang.String url,
                                   IpCamMode mode,
                                   IpCamAuth auth)
                            throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

register

public static IpCamDevice register(java.lang.String name,
                                   java.net.URL url,
                                   IpCamMode mode,
                                   IpCamAuth auth)

Register new IP camera device.

Parameters:

name - the name of the device

url - the URL to be used

mode - the camera mode to be used

auth - the optional settings if device supports authentication

Returns:

Return newly created IP camera device object

isRegistered

public static boolean isRegistered(IpCamDevice ipcam)

Is device registered?

Parameters:

ipcam - the IP camera device

Returns:

True if device is registsred, false otherwise

isRegistered

public static boolean isRegistered(java.lang.String name)

Is device with given name registered?

Parameters:

name - the name of device

Returns:

True if device is registered, false otherwise

isRegistered

public static boolean isRegistered(java.net.URL url)

Is device with given URL registered?

Parameters:

url - the URL used by device

Returns:

True if device is registered, false otherwise

isRegistered

public static boolean isRegistered(java.net.URI uri)

Is device with given URL registered?

Parameters:

uri - the URI used by device

Returns:

True if device is registered, false otherwise

unregister

public static boolean unregister(IpCamDevice ipcam)

Unregister IP camera.

Parameters:

ipcam - the IP camera to be unregister

Returns:

True if IP camera device has been unregistered, false otherwise

unregister

public static boolean unregister(java.lang.String name)

Unregister IP camera with given name.

Parameters:

name - the name of IP camera to be unregister

Returns:

True if device has been registered, false otherwise

getIpCameras

public static java.util.List<IpCamDevice> getIpCameras()

Get all registered IP cameras.

Returns:

Collection of registered IP cameras

unregisterAll

public static void unregisterAll()

Removes all registered devices.