ch.icosys.popjava.core.combox

Class ComboxFactory

java.lang.Object

ch.icosys.popjava.core.combox.ComboxFactory

Direct Known Subclasses:

ComboxFactoryPlugin, ComboxSecureSocketFactory, ComboxSocketFactory

public abstract class ComboxFactory
extends java.lang.Object

This abstract class regroups the methods needed by a ComboxFactory

Constructor Summary

Constructors

Constructor and Description
ComboxFactory()

Method Summary

Modifier and Type	Method and Description
abstract ComboxAllocate	createAllocateCombox(boolean enableUPNP) Create and allocation combox when instantiating a new remote object
abstract Combox	createClientCombox(java.lang.String networkUUID) Create a new client combox with the given access point
abstract ComboxServer	createServerCombox(AccessPoint accessPoint, int timeout, POPBuffer buffer, Broker broker) Create a new server combox with the given access point, buffer and broker and a connection timeout
abstract ComboxServer	createServerCombox(AccessPoint accessPoint, POPBuffer buffer, Broker broker) Create a new server combox with the given access point, buffer and broker
abstract java.lang.String	getComboxName() Get the combox name
boolean	isAvailable() Check if this combox is usable.
abstract boolean	isSecure() Mark if the protocol used by this Combox is secure or not

Methods inherited from class java.lang.Object

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

Constructor Detail

ComboxFactory

public ComboxFactory()

Method Detail

createClientCombox

public abstract Combox createClientCombox(java.lang.String networkUUID)
                                   throws java.io.IOException

Create a new client combox with the given access point

Parameters:

networkUUID - The network we are using

Returns:

The combox created

Throws:

java.io.IOException - if any problem occurs

createServerCombox

public abstract ComboxServer createServerCombox(AccessPoint accessPoint,
                                                POPBuffer buffer,
                                                Broker broker)
                                         throws java.io.IOException

Create a new server combox with the given access point, buffer and broker

Parameters:

accessPoint - The access point for the server

buffer - The buffer for sending and receiving

broker - The broker associated with this combox

Returns:

The combox server created

Throws:

java.io.IOException - if any problem occurs

createServerCombox

public abstract ComboxServer createServerCombox(AccessPoint accessPoint,
                                                int timeout,
                                                POPBuffer buffer,
                                                Broker broker)
                                         throws java.io.IOException

Create a new server combox with the given access point, buffer and broker and a connection timeout

Parameters:

accessPoint - The access point for the server

timeout - The connection timeout

buffer - The buffer for sending and receiving

broker - The broker associated with this combox

Returns:

The combox server created

Throws:

java.io.IOException - if any problem occurs

createAllocateCombox

public abstract ComboxAllocate createAllocateCombox(boolean enableUPNP)
                                             throws java.io.IOException

Create and allocation combox when instantiating a new remote object

Returns:

the object which way for a broker connection

Throws:

java.io.IOException - if any problem occurs

getComboxName

public abstract java.lang.String getComboxName()

Get the combox name

Returns:

name of the combox

isSecure

public abstract boolean isSecure()

Mark if the protocol used by this Combox is secure or not

Returns:

true if the factory is secure

isAvailable

public boolean isAvailable()

Check if this combox is usable. When overriding call super.isAvailable to appy the white/black lists. NB: If an item is in both white and black lists, the blacklist will take precedence Expression applied: (a V b) Λ ¬c a = whitelist is empty b = is in whitelist c = is in blacklist Truth table: a b c (a V b) Λ ¬c T T T - T T F - T F T F : blacklist T F F T : no restrictions F T T F : blacklist take precedence F T F T : whitelist F F T F : not in whitelist + blacklist F F F F : not in whitelist

Returns:

true if it's usable